Cloud Firestore API

เข้าถึงฐานข้อมูลเอกสาร NoSQL ที่สร้างขึ้นมาสำหรับการปรับขนาดอัตโนมัติ ซึ่งมีประสิทธิภาพสูง และพัฒนาแอปพลิเคชันได้อย่างง่ายดาย

บริการ: firestore.googleapis.com

จำเป็นต้องมีชื่อบริการ firestore.googleapis.com เพื่อสร้างสตับไคลเอ็นต์ RPC

google.cloud.location.Locations

เมธอด
GetLocation รับข้อมูลเกี่ยวกับตำแหน่ง
ListLocations แสดงรายการข้อมูลเกี่ยวกับตำแหน่งที่สนับสนุนสำหรับบริการนี้

google.firestore.admin.v1.FirestoreAdmin

เมธอด
CreateBackupSchedule สร้างกำหนดการสำรองข้อมูลบนฐานข้อมูล
CreateDatabase สร้างฐานข้อมูล
CreateIndex สร้างดัชนีผสม
DeleteBackup ลบข้อมูลสำรอง
DeleteBackupSchedule ลบกำหนดการสำรองข้อมูล
DeleteDatabase ลบฐานข้อมูล
DeleteIndex ลบดัชนีผสม
ExportDocuments ส่งออกสำเนาเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบพื้นที่เก็บข้อมูลอื่น เช่น Google Cloud Storage
GetBackup รับข้อมูลเกี่ยวกับข้อมูลสำรอง
GetBackupSchedule รับข้อมูลเกี่ยวกับกําหนดการสํารองข้อมูล
GetDatabase รับข้อมูลเกี่ยวกับฐานข้อมูล
GetField รับข้อมูลเมตาและการกำหนดค่าสำหรับช่อง
GetIndex รับดัชนีผสม
ImportDocuments นำเข้าเอกสารไปยัง Google Cloud Firestore
ListBackupSchedules แสดงรายการกำหนดเวลาการสำรองข้อมูล
ListBackups แสดงรายการข้อมูลสำรองทั้งหมด
ListDatabases แสดงรายการฐานข้อมูลทั้งหมดในโปรเจ็กต์
ListFields แสดงการกำหนดค่าช่องและข้อมูลเมตาสำหรับฐานข้อมูลนี้
ListIndexes แสดงรายการดัชนีผสม
RestoreDatabase สร้างฐานข้อมูลใหม่โดยกู้คืนจากข้อมูลสำรองที่มีอยู่
UpdateBackupSchedule อัปเดตกำหนดการสำรองข้อมูล
UpdateDatabase อัปเดตฐานข้อมูล
UpdateField อัปเดตการกำหนดค่าช่อง

google.firestore.admin.v1beta1.FirestoreAdmin

เมธอด
CreateIndex สร้างดัชนีที่ระบุ
DeleteIndex ลบดัชนี
ExportDocuments ส่งออกสำเนาเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบพื้นที่เก็บข้อมูลอื่น เช่น Google Cloud Storage
GetIndex รับดัชนี
ImportDocuments นำเข้าเอกสารไปยัง Google Cloud Firestore
ListIndexes แสดงรายการดัชนีที่ตรงกับตัวกรองที่ระบุ

google.firestore.admin.v1beta2.FirestoreAdmin

เมธอด
CreateIndex สร้างดัชนีผสม
DeleteIndex ลบดัชนีผสม
ExportDocuments ส่งออกสำเนาเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบพื้นที่เก็บข้อมูลอื่น เช่น Google Cloud Storage
GetField รับข้อมูลเมตาและการกำหนดค่าสำหรับช่อง
GetIndex รับดัชนีผสม
ImportDocuments นำเข้าเอกสารไปยัง Google Cloud Firestore
ListFields แสดงการกำหนดค่าช่องและข้อมูลเมตาสำหรับฐานข้อมูลนี้
ListIndexes แสดงรายการดัชนีผสม
UpdateField อัปเดตการกำหนดค่าช่อง

google.firestore.v1.Firestore

เมธอด
BatchGetDocuments รับเอกสารหลายรายการ
BatchWrite ใช้ชุดการดำเนินการเขียน
BeginTransaction เริ่มธุรกรรมใหม่
Commit ทำธุรกรรม แต่เลือกที่จะอัปเดตเอกสารได้
CreateDocument สร้างเอกสารใหม่
DeleteDocument ลบเอกสาร
GetDocument รับเอกสารรายการเดียว
ListCollectionIds แสดงรหัสคอลเล็กชันทั้งหมดภายใต้เอกสาร
ListDocuments แสดงรายการเอกสาร
Listen ฟังการเปลี่ยนแปลง
PartitionQuery แบ่งพาร์ติชันการค้นหาโดยแสดงผลเคอร์เซอร์พาร์ติชันที่จะใช้เพื่อเรียกใช้การค้นหาพร้อมกันได้
Rollback ย้อนกลับธุรกรรม
RunAggregationQuery เรียกใช้การค้นหาการรวม
RunQuery ทำการค้นหา
UpdateDocument อัปเดตหรือแทรกเอกสาร
Write สตรีมกลุ่มการอัปเดตและลบเอกสารตามลำดับ

google.firestore.v1beta1.Firestore

เมธอด
BatchGetDocuments รับเอกสารหลายรายการ
BatchWrite ใช้ชุดการดำเนินการเขียน
BeginTransaction เริ่มธุรกรรมใหม่
Commit ทำธุรกรรม แต่เลือกที่จะอัปเดตเอกสารได้
CreateDocument สร้างเอกสารใหม่
DeleteDocument ลบเอกสาร
GetDocument รับเอกสารรายการเดียว
ListCollectionIds แสดงรหัสคอลเล็กชันทั้งหมดภายใต้เอกสาร
ListDocuments แสดงรายการเอกสาร
Listen ฟังการเปลี่ยนแปลง
PartitionQuery แบ่งพาร์ติชันการค้นหาโดยแสดงผลเคอร์เซอร์พาร์ติชันที่จะใช้เพื่อเรียกใช้การค้นหาพร้อมกันได้
Rollback ย้อนกลับธุรกรรม
RunAggregationQuery เรียกใช้การค้นหาการรวม
RunQuery ทำการค้นหา
UpdateDocument อัปเดตหรือแทรกเอกสาร
Write สตรีมกลุ่มการอัปเดตและลบเอกสารตามลำดับ

google.longrunning.Operations

เมธอด
CancelOperation เริ่มการยกเลิกแบบไม่พร้อมกันในการดำเนินการที่ใช้เวลานาน
DeleteOperation ลบการดำเนินการที่ใช้เวลานาน
GetOperation รับสถานะล่าสุดของการดำเนินการที่ใช้เวลานาน
ListOperations แสดงรายการการดำเนินการที่ตรงกับตัวกรองที่ระบุไว้ในคำขอ
WaitOperation รอจนกว่าการดำเนินการที่ใช้เวลานานที่ระบุจะเสร็จสิ้นหรือถึงระยะหมดเวลาที่ระบุไว้มากที่สุด จากนั้นจะกลับสู่สถานะล่าสุด