Google Cloud Firestore-Erweiterung

Daten hinzufügen

Mit der folgenden ExtensionCallout-Richtlinie wird das Dokument freewill@example.com zu einer users-Sammlung hinzugefügt. Das Attribut data gibt die Felder und Werte des neuen Dokuments an.

<?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>

Daten abrufen

In diesem Beispiel ruft die ExtensionCallout-Richtlinie den Wert des Dokuments freewill@example.com aus der Sammlung users ab. Hier ist das Attribut parsed des <Output>-Elements auf false gesetzt, sodass das zurückgegebene Ergebnis JSON als String und kein JSON-Format zurückgegeben wird, das in ein Objekt geparst wird. Weitere Informationen findest du in der Referenz zum <Output>-Element.

<?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>

Die folgende Richtlinie Nachricht zuweisen verwendet den Wert der Variablen, die die Antwort der Erweiterung speichert, um der Antwortnutzlast zuzuweisen.

<?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>

Daten löschen

In diesem Beispiel wird durch die ExtensionCallout-Richtlinie das Dokument lizzie@example.com aus der Sammlung users gelöscht.

<?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>

Daten abfragen

In diesem Beispiel fragt die ExtensionCallout-Richtlinie eine cities-Sammlung ab. Abfrageergebnisse werden nach den Feldern state und population gefiltert. Hier ist das Attribut parsed des <Output>-Elements auf false gesetzt, sodass das zurückgegebene Ergebnis JSON als String und kein JSON-Format zurückgegeben wird, das in ein Objekt geparst wird. Weitere Informationen findest du in der Referenz zum <Output>-Element.

<?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>

Die folgende Richtlinie Nachricht zuweisen verwendet den Wert der Variablen, die die Antwort der Erweiterung speichert, um der Antwortnutzlast zuzuweisen.

<?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>

Syntax

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

Beispiel

In diesem Beispiel gibt der Parameter queryArray zwei Bedingungen an, unter denen die durch den Parameter colName angegebene Sammlung cities gefiltert werden soll.

Eine Abfrage, die mehrere Bedingungen enthält, muss in Cloud Firestore von einem zusammengesetzten Index unterstützt werden. Weitere Informationen finden Sie unter Indextypen in Cloud Firestore.

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

Zur Laufzeit wird diese Aktion als Abfrage wie die folgende interpretiert:

Wählen Sie alle Städte aus, in denen Bundesland „CA“ ist. und Bevölkerung < 1.000.000