คุณกำลังดูเอกสารประกอบ 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 โดยใช้นโยบาย ชิ้นงานข้อความไฮไลต์
เพิ่มข้อมูล
นโยบาย Extensionข้อความไฮไลต์ ต่อไปนี้เพิ่มเอกสารชื่อ 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ข้อความไฮไลต์ จะดึงค่าของเอกสาร 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>
ลบข้อมูล
ในตัวอย่างนี้ นโยบาย ส่วนขยายข้อความไฮไลต์ จะลบเอกสาร 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>
ข้อมูลการค้นหา
ในตัวอย่างนี้ นโยบาย ชิ้นงานข้อความไฮไลต์ ค้นหาคอลเล็กชัน 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>
พารามิเตอร์ | คำอธิบาย | ประเภท | ค่าเริ่มต้น | ต้องระบุ |
---|---|---|---|---|
colName | ชื่อของคอลเล็กชันที่มีเอกสารที่จะลบ | สตริง | ไม่มี | ได้ |
docName | ชื่อเอกสารที่จะลบ | สตริง | ไม่มี | ได้ |
คำตอบ
ไม่มี
getDocument
เรียกเนื้อหาของเอกสารเดียว
พารามิเตอร์คำขอ
<Input><![CDATA[{
"colName" : "firestore-collection-name",
"docName" : "firestore-document-name"
}]]></Input>
พารามิเตอร์ | คำอธิบาย | ประเภท | ค่าเริ่มต้น | ต้องระบุ |
---|---|---|---|---|
colName | ชื่อของคอลเล็กชันที่จะเรียกดูเอกสาร | สตริง | ไม่มี | ได้ |
docName | ชื่อเอกสารที่จะดึงข้อมูล | สตริง | ไม่มี | ได้ |
คำตอบ
ออบเจ็กต์ที่มีเนื้อหาของเอกสารในรูปแบบ JSON
query
ค้นหาคอลเล็กชันตามเงื่อนไขที่ระบุซึ่งมาจากตัวกรอง
พารามิเตอร์ queryArray
ของการดำเนินการนี้จะระบุอาร์เรย์ของอาร์เรย์ (หรืออาร์เรย์ว่างเปล่าหากไม่มีเงื่อนไขการกรอง) อาร์เรย์ภายในแต่ละรายการจะระบุเงื่อนไขของตัวกรอง อาร์เรย์ภายในหลายรายการแสดงเงื่อนไขหลายรายการที่ผนวกด้วยโอเปอเรเตอร์ AND
แต่ละองค์ประกอบในอาร์เรย์เงื่อนไขภายในจะแสดงส่วนหนึ่งของเงื่อนไข อาร์เรย์เงื่อนไขมีองค์ประกอบ 3 อย่างต่อไปนี้เสมอ
- องค์ประกอบด้านซ้ายที่ระบุช่องคอลเล็กชัน
- องค์ประกอบกลางที่ระบุโอเปอเรเตอร์
- องค์ประกอบด้านขวาที่ระบุค่าช่องคอลเล็กชัน
ตัวอย่างต่อไปนี้ระบุอาร์เรย์เงื่อนไข 2 รายการที่จะกรองตามฟิลด์ state
และ population
ของคอลเล็กชัน
<Input><![CDATA[{
"colName":"cities",
"queryArray":[
["state", "==", "CA"],
["population","<",1000000]
]
}]]></Input>
ขณะรันไทม์ ระบบจะตีความการดำเนินการนี้เป็นคำค้นหาดังตัวอย่างต่อไปนี้
เลือกเมืองทั้งหมดที่รัฐ = 'CA' และ ประชากร < 1000,000
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' และ ประชากร < 1000,000
พารามิเตอร์ | คำอธิบาย | ประเภท | ค่าเริ่มต้น | ต้องระบุ |
---|---|---|---|---|
colName | ชื่อคอลเล็กชันที่จะค้นหา | สตริง | ไม่มี | ได้ |
queryArray | อาร์เรย์ของอาร์เรย์เงื่อนไขที่ระบุส่วนต่างๆ ของตัวกรองเมื่อใช้ร่วมกัน ระบุอาร์เรย์ที่ว่างเปล่าเพื่อละเว้นเงื่อนไข (ไม่ใช่กรองผลการค้นหา) | อาร์เรย์ | ไม่มี | ได้ |
คำตอบ
ออบเจ็กต์ที่มีเนื้อหาของเอกสารในรูปแบบ JSON
setDocument
คัดลอกเอกสารลงในคอลเล็กชัน Cloud Firestore หากมีเอกสารอยู่แล้วในคอลเล็กชัน การดำเนินการนี้จะเขียนทับเอกสาร
พารามิเตอร์คำขอ
<Input><![CDATA[{
"colName" : "firestore-collection-name",
"docName" : "firestore-document-name",
"data" : "data-to-copy"
}]]></Input>
พารามิเตอร์ | คำอธิบาย | ประเภท | ค่าเริ่มต้น | ต้องระบุ |
---|---|---|---|---|
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 การจัดการ ค่าดังกล่าวจะเป็นค่าที่เข้ารหัสฐาน 64 ซึ่งสร้างขึ้นจากไฟล์คีย์ | ไม่มี | ได้ |