คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
เวอร์ชัน: 1.4.1
สร้าง อ่าน หรือลบข้อมูลในฐานข้อมูล Cloud Firestore
เนื้อหานี้ให้ข้อมูลอ้างอิงสำหรับการกำหนดค่าและใช้ส่วนขยายนี้ ก่อนใช้ส่วนขยายนี้จากพร็อกซี API คุณต้องดำเนินการดังนี้
สร้างโปรเจ็กต์ Firebase ที่คอนโซล Firebase ซึ่งเก็บข้อมูลของคุณไว้
ใช้เนื้อหาของไฟล์ JSON คีย์ที่ได้มาเมื่อเพิ่มและกำหนดค่าส่วนขยายโดยใช้การอ้างอิงการกำหนดค่า
เกี่ยวกับ Cloud Firestore
Cloud Firestore จัดเก็บข้อมูลไว้ในเอกสารซึ่งจัดเก็บไว้ในคอลเล็กชัน Cloud Firestore สร้างคอลเล็กชันและเอกสารโดยปริยายในครั้งแรกที่คุณเพิ่มข้อมูลลงในเอกสาร คุณไม่จำเป็นต้องสร้างคอลเล็กชันหรือเอกสารอย่างชัดแจ้ง
ดูข้อมูลเพิ่มเติมเกี่ยวกับ Cloud Firestore โดยทั่วไปได้ที่หัวข้อเริ่มต้นใช้งาน Firestore ในเอกสาร Cloud Firestore
ลองฟัง
ตัวอย่างต่อไปนี้จะแสดงวิธีกำหนดค่าการสนับสนุนสำหรับการดำเนินการของส่วนขยาย 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>
รับข้อมูล
ในตัวอย่างนี้ นโยบาย Extension callout จะดึงค่าของเอกสาร freewill@example.com
จากคอลเล็กชัน users
ในที่นี้ แอตทริบิวต์ parsed
ขององค์ประกอบ <Output>
ได้รับการตั้งค่าเป็น 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>
นโยบายกำหนดข้อความต่อไปนี้ใช้ค่าของตัวแปรที่จัดเก็บการตอบกลับของส่วนขยายเพื่อกำหนดเพย์โหลดการตอบกลับ
<?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 callout จะลบเอกสาร lizzie@example.com
ออกจากคอลเล็กชัน 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>
ข้อมูลข้อความค้นหา
ในตัวอย่างนี้ นโยบาย Extensionวิส จะค้นหาคอลเล็กชัน cities
ผลการค้นหาจะถูกกรองตามช่อง state
และ population
ในที่นี้ แอตทริบิวต์ parsed
ขององค์ประกอบ <Output>
ได้รับการตั้งค่าเป็น 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>
นโยบายกำหนดข้อความต่อไปนี้ใช้ค่าของตัวแปรที่จัดเก็บการตอบกลับของส่วนขยายเพื่อกำหนดเพย์โหลดการตอบกลับ
<?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>
การดำเนินการ
deleteDocument
ลบเอกสารฉบับเดียวออกจากคอลเล็กชัน
พารามิเตอร์คำขอ
<Input><![CDATA[{
"colName" : "firestore-collection-name",
"docName" : "firestore-document-name"
}]]></Input>
พารามิเตอร์ | คำอธิบาย | Type | ค่าเริ่มต้น | จำเป็น |
---|---|---|---|---|
colName | ชื่อของคอลเล็กชันที่มีเอกสารที่จะลบ | สตริง | ไม่มี | ใช่ |
docName | ชื่อเอกสารที่จะลบ | สตริง | ไม่มี | ใช่ |
คำตอบ
ไม่มี
getDocument
เรียกเนื้อหาของเอกสารหนึ่งฉบับ
พารามิเตอร์คำขอ
<Input><![CDATA[{
"colName" : "firestore-collection-name",
"docName" : "firestore-document-name"
}]]></Input>
พารามิเตอร์ | คำอธิบาย | Type | ค่าเริ่มต้น | จำเป็น |
---|---|---|---|---|
colName | ชื่อของคอลเล็กชันที่จะเรียกข้อมูลเอกสาร | สตริง | ไม่มี | ใช่ |
docName | ชื่อเอกสารที่จะเรียกดู | สตริง | ไม่มี | ใช่ |
คำตอบ
ออบเจ็กต์ที่มีเนื้อหาของเอกสารในรูปแบบ JSON
query
ค้นหาคอลเล็กชันด้วยเงื่อนไขการระบุที่ประกอบเป็นตัวกรอง
พารามิเตอร์ queryArray
ของการดำเนินการนี้จะระบุอาร์เรย์ของอาร์เรย์ (หรืออาร์เรย์ว่างที่ไม่มีเงื่อนไขการกรอง) อาร์เรย์ภายในแต่ละรายการจะระบุเงื่อนไขของตัวกรอง อาร์เรย์ภายในหลายรายการแสดงเงื่อนไขหลายรายการที่ผนวกกันด้วยโอเปอเรเตอร์ AND
องค์ประกอบแต่ละรายการในอาร์เรย์เงื่อนไขภายในแสดงถึงส่วนหนึ่งของเงื่อนไข อาร์เรย์เงื่อนไขมีองค์ประกอบ 3 อย่างต่อไปนี้เสมอ
- องค์ประกอบด้านซ้ายที่ระบุช่องคอลเล็กชัน
- องค์ประกอบตรงกลางที่ระบุโอเปอเรเตอร์
- องค์ประกอบด้านขวาที่ระบุค่าในช่องคอลเล็กชัน
ตัวอย่างต่อไปนี้ระบุอาร์เรย์เงื่อนไข 2 รายการที่จะกรองตามช่อง state
และ population
ของคอลเล็กชัน
<Input><![CDATA[{
"colName":"cities",
"queryArray":[
["state", "==", "CA"],
["population","<",1000000]
]
}]]></Input>
ขณะรันไทม์ ระบบจะตีความการกระทำนี้เป็นการค้นหา
เลือกเมืองทั้งหมดที่รัฐ = 'CA' และมีประชากร < 1000000
Cloud Firestore ต้องรองรับการค้นหาที่มีหลายเงื่อนไขโดยดัชนีผสม โปรดดูข้อมูลเพิ่มเติมที่หัวข้อประเภทดัชนีใน Cloud Firestore
พารามิเตอร์คำขอ
ไวยากรณ์
<Input><![CDATA[{
"colName" : "firestore-collection-name",
"queryArray" : "queryArray": query-condition-array
}]]></Input>
ตัวอย่าง
ในตัวอย่างนี้ พารามิเตอร์ queryArray
ระบุเงื่อนไข 2 ข้อที่จะกรองคอลเล็กชัน cities
ที่ระบุโดยพารามิเตอร์ colName
การค้นหาที่มีหลายเงื่อนไขต้องได้รับการรองรับใน Cloud Firestore โดยใช้ดัชนีผสม โปรดดูข้อมูลเพิ่มเติมที่หัวข้อประเภทดัชนีใน Cloud Firestore
<Input><![CDATA[{
"colName":"cities",
"queryArray":[["state", "==", "CA"],["population","<",1000000]]
}]]></Input>
ขณะรันไทม์ ระบบจะตีความการกระทำนี้เป็นการค้นหา
เลือกเมืองทั้งหมดที่รัฐ = 'CA' และมีประชากร < 1000000
พารามิเตอร์ | คำอธิบาย | Type | ค่าเริ่มต้น | จำเป็น |
---|---|---|---|---|
colName | ชื่อคอลเล็กชันที่จะค้นหา | สตริง | ไม่มี | ใช่ |
queryArray | อาร์เรย์ของอาร์เรย์เงื่อนไขที่ระบุส่วนต่างๆ ของตัวกรองเมื่อใช้ร่วมกัน ระบุอาร์เรย์ว่างเพื่อยกเว้นเงื่อนไข (ไม่ใช่กรองผลลัพธ์) | อาร์เรย์ | ไม่มี | ใช่ |
คำตอบ
ออบเจ็กต์ที่มีเนื้อหาของเอกสารในรูปแบบ JSON
setDocument
คัดลอกเอกสารลงในคอลเล็กชัน Cloud Firestore หากมีเอกสารอยู่ในคอลเล็กชันอยู่แล้ว ระบบจะเขียนทับเอกสารนั้น
พารามิเตอร์คำขอ
<Input><![CDATA[{
"colName" : "firestore-collection-name",
"docName" : "firestore-document-name",
"data" : "data-to-copy"
}]]></Input>
พารามิเตอร์ | คำอธิบาย | Type | ค่าเริ่มต้น | จำเป็น |
---|---|---|---|---|
colName | ชื่อของคอลเล็กชันที่ใช้สร้างเอกสาร | สตริง | ไม่มี | ใช่ |
docName | ชื่อเอกสารที่ควรคัดลอก data |
สตริง | ไม่มี | ใช่ |
ข้อมูล | ข้อมูลที่จะคัดลอกไปยัง docName ต้องเป็นออบเจ็กต์ JSON ที่ถูกต้อง ไม่รองรับอาร์เรย์ |
ออบเจ็กต์ | ไม่มี | ไม่มี |
คำตอบ
ไม่มี
ข้อมูลอ้างอิงการกำหนดค่า
ใช้ข้อมูลต่อไปนี้เมื่อคุณกำหนดค่าและทำให้ส่วนขยายนี้ใช้งานได้ เพื่อใช้ในพร็อกซี API โปรดดูขั้นตอนการกำหนดค่าส่วนขยายโดยใช้คอนโซล Apigee ในการเพิ่มและการกำหนดค่าส่วนขยาย
คุณสมบัติส่วนขยายที่พบบ่อย
พร็อพเพอร์ตี้ต่อไปนี้มีอยู่ในส่วนขยายทุกรายการ
พร็อพเพอร์ตี้ | คำอธิบาย | ค่าเริ่มต้น | ต้องระบุ |
---|---|---|---|
name |
ชื่อที่คุณกําหนดให้การกําหนดค่านี้ของส่วนขยาย | ไม่มี | ได้ |
packageName |
ชื่อแพ็กเกจส่วนขยายที่ระบุโดย Apigee Edge | ไม่มี | ได้ |
version |
หมายเลขเวอร์ชันของแพ็กเกจส่วนขยายที่คุณกําหนดค่าส่วนขยาย | ไม่มี | ได้ |
configuration |
ค่าการกําหนดค่าเฉพาะสําหรับส่วนขยายที่คุณกําลังเพิ่ม ดูพร็อพเพอร์ตี้สําหรับแพ็กเกจส่วนขยายนี้ | ไม่มี | ได้ |
พร็อพเพอร์ตี้สำหรับแพ็กเกจส่วนขยายนี้
พร็อพเพอร์ตี้ | คำอธิบาย | ค่าเริ่มต้น | จำเป็น |
---|---|---|---|
firestoreDB | URL ไปยังฐานข้อมูล Cloud Firestore ที่ส่วนขยายนี้ควรใช้เมื่อส่งคำขอ โดยปกติ URL นี้จะอยู่ในรูปแบบ https://DATABASE_NAME.firebaseio.com |
ไม่มี | ใช่ |
ข้อมูลเข้าสู่ระบบ | เมื่อป้อนในคอนโซล Apigee Edge คือเนื้อหาของไฟล์คีย์ที่คุณสร้างขึ้นด้วยวิธีการของ Firebase เมื่อส่งผ่าน API การจัดการ ค่าดังกล่าวจะเป็นค่าที่เข้ารหัส base64 ซึ่งสร้างขึ้นจากไฟล์คีย์ | ไม่มี | ใช่ |