Extensión de Google Cloud Firestore

Agregar datos

La siguiente política ExtensionCallback agrega un documento llamado freewill@example.com a una colección de users. La propiedad data especifica los campos y valores del documento nuevo.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Add-User-Data">
    <DisplayName>Add User Data</DisplayName>
    <Connector>my-cloud-firestore-extension</Connector>
    <Action>setDocument</Action>
    <Input><![CDATA[{
        "colName" : "users",
        "docName" : "freewill@example.com",
        "data" : {
            "firstName": "Will",
            "lastName": "Witman",
            "address": "270-8243 Tempor St.",
            "city": "Fort Worth",
            "region": "TX",
            "postalCode": "86519",
            "email": "freewill@example.com",
            "username": "freewill444"
        }
    }]]></Input>
</ConnectorCallout>

Cómo obtener datos

En este ejemplo, la política ExtensionReference recupera el valor del documento freewill@example.com de la colección users. Aquí, el atributo parsed del elemento <Output> se establece en false para que el resultado que se muestre sea JSON como cadena, en lugar de JSON analizado en un objeto. Para obtener más información, consulta la referencia del elemento <Output>.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Get-User-Data">
    <DisplayName>Get User Data</DisplayName>
    <Connector>straut-cloud-firestore-extension</Connector>
    <Action>getDocument</Action>
    <Input><![CDATA[{
        "colName" : "users",
        "docName" : "freewill@example.com"
    }]]></Input>
    <Output parsed="false">firestore.userdata.retrieved</Output>
</ConnectorCallout>

La siguiente política Assign Message usa el valor de la variable que almacena la respuesta de la extensión para asignar la carga útil de la respuesta.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage name="CopyUserDataToResponse">
    <DisplayName>Copy User Data To Response</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{firestore.userdata.retrieved}</Payload>
    </Set>
</AssignMessage>

Borra datos

En este ejemplo, la política ExtensionReference borra el documento lizzie@example.com de la colección users.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Delete-User-Data">
    <DisplayName>Delete User Data</DisplayName>
    <Connector>my-cloud-firestore-extension</Connector>
    <Action>deleteDocument</Action>
    <Input><![CDATA[{
        "colName" : "users",
        "docName" : "lizzie@example.com"
    }]]></Input>
</ConnectorCallout>

Consulta datos

En este ejemplo, la política ExtensionReference consulta una colección cities. Los resultados de la consulta se filtran según los campos state y population. Aquí, el atributo parsed del elemento <Output> se establece en false para que el resultado que se muestre sea JSON como cadena, en lugar de JSON analizado en un objeto. Para obtener más información, consulta la referencia del elemento <Output>.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Query-City-Data">
    <DisplayName>Query City Data</DisplayName>
    <Connector>cloud-firestore-extension</Connector>
    <Action>query</Action>
    <Input><![CDATA[{
        "colName":"cities",
        "queryArray":[
          ["state", "==", "CA"],
          ["population","<",1000000]
        ]
    }]]></Input>
    <Output parsed="false">compound-query-output</Output>
</ConnectorCallout>

La siguiente política Assign Message usa el valor de la variable que almacena la respuesta de la extensión para asignar la carga útil de la respuesta.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage name="CopyQueryResultsToResponse">
    <DisplayName>Copy Query Results To Response</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{firestore.querydata.retrieved}</Payload>
    </Set>
</AssignMessage>

Sintaxis

<Input><![CDATA[{
  "colName" : "firestore-collection-name",
  "queryArray" : "queryArray": query-condition-array
}]]></Input>

Ejemplo

En este ejemplo, el parámetro queryArray especifica dos condiciones para filtrar la colección cities especificada por el parámetro colName.

Un índice compuesto debe admitir una consulta que incluya varias condiciones en Cloud Firestore. Para obtener más información, consulta Tipos de índices en Cloud Firestore.

<Input><![CDATA[{
  "colName":"cities",
  "queryArray":[["state", "==", "CA"],["population","<",1000000]]
}]]></Input>

En el tiempo de ejecución, esta acción se interpreta como una consulta como la siguiente:

Seleccione todas las ciudades en las que el estado sea 'CA' y población < 1,000,000