Google Cloud Firestore 확장 프로그램

데이터 추가

다음 확장 콜아웃 정책은 freewill@example.com라는 문서를 users 컬렉션에 추가합니다. data 속성은 새 문서의 필드와 값을 지정합니다.

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

데이터 가져오기

이 예에서 확장 콜아웃 정책은 users 컬렉션에서 freewill@example.com 문서의 값을 가져옵니다. 여기서 <Output> 요소의 parsed 속성은 false로 설정되므로 반환되는 결과는 객체로 파싱된 JSON이 아닌 JSON 문자열이 됩니다. 자세한 내용은 <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>

다음 Assign Message 정책은 확장 프로그램의 응답을 저장하는 변수 값을 사용하여 응답 페이로드를 할당합니다.

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

데이터 삭제

이 예에서 Extension콜아웃 정책은 users 컬렉션에서 lizzie@example.com 문서를 삭제합니다.

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

데이터 쿼리

이 예에서 확장 콜아웃 정책은 cities 컬렉션을 쿼리합니다. 쿼리 결과는 state 및 population 필드로 필터링됩니다. 여기서 <Output> 요소의 parsed 속성은 false로 설정되므로 반환되는 결과는 객체로 파싱된 JSON이 아닌 JSON 문자열이 됩니다. 자세한 내용은 <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>

다음 Assign Message 정책은 확장 프로그램의 응답을 저장하는 변수 값을 사용하여 응답 페이로드를 할당합니다.

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

문법

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

예

이 예시에서 queryArray 매개변수는 colName 매개변수로 지정된 cities 컬렉션을 필터링할 두 가지 조건을 지정합니다.

여러 조건이 포함된 쿼리는 Cloud Firestore에서 복합 색인으로 지원해야 합니다. 자세한 내용은 Cloud Firestore의 색인 유형을 참조하세요.

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

런타임 시 이 작업은 다음과 같은 쿼리로 해석됩니다.

주가 'CA'이고 인구가 1000000 미만인 도시를 모두 선택하세요.