Google Cloud Firestore-Erweiterung

Daten hinzufügen

Die folgende ExtensionCallout-Richtlinie fügt ein Dokument mit dem Namen freewill@example.com zu einer users-Sammlung hinzu. 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 freewill@example.com-Dokuments aus der users-Sammlung ab. Hier ist das parsed-Attribut des <Output>-Elements auf false gesetzt, sodass das zurückgegebene Ergebnis JSON als String und nicht in einem Objekt geparst wird. Weitere Informationen findest du in der Referenz zu <Output>-Elementen.

<?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, mit denen die Antwort der Erweiterung gespeichert wird, um die 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 das Dokument lizzie@example.com durch die ExtensionCallout-Richtlinie 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. Die Abfrageergebnisse werden nach den Feldern state und population gefiltert. Hier ist das parsed-Attribut des <Output>-Elements auf false gesetzt, sodass das zurückgegebene Ergebnis JSON als String und nicht in einem Objekt geparst wird. Weitere Informationen findest du in der Referenz zu <Output>-Elementen.

<?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, mit denen die Antwort der Erweiterung gespeichert wird, um die 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 für die Filterung der cities-Sammlung an, die durch den Parameter colName angegeben wird.

Eine Abfrage mit mehreren Bedingungen 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, bei denen der Bundesstaat „CA“ und die Bevölkerungszahl < 1000000 sind