ดัชนี
-
FirestoreAdmin
(อินเทอร์เฟซ) -
CreateIndexRequest
(ข้อความ) -
DeleteIndexRequest
(ข้อความ) -
ExportDocumentsMetadata
(ข้อความ) -
ExportDocumentsRequest
(ข้อความ) -
ExportDocumentsResponse
(ข้อความ) -
GetIndexRequest
(ข้อความ) -
ImportDocumentsMetadata
(ข้อความ) -
ImportDocumentsRequest
(ข้อความ) -
Index
(ข้อความ) -
Index.State
(แจงนับ) -
IndexField
(ข้อความ) -
IndexField.Mode
(แจงนับ) -
IndexOperationMetadata
(ข้อความ) -
IndexOperationMetadata.OperationType
(แจงนับ) -
ListIndexesRequest
(ข้อความ) -
ListIndexesResponse
(ข้อความ) -
LocationMetadata
(ข้อความ) -
OperationState
(แจงนับ) -
Progress
(ข้อความ)
ผู้ดูแลระบบ Firestore
API ผู้ดูแลระบบ Cloud Firestore
API นี้ให้บริการด้านการดูแลระบบหลายอย่างสำหรับ Cloud Firestore
แนวคิด
มีการใช้โปรเจ็กต์ ฐานข้อมูล เนมสเปซ คอลเลกชัน และเอกสารตามที่กำหนดไว้ใน Google Cloud Firestore API
การดำเนินการ: การดำเนินการแสดงถึงงานที่ดำเนินการในเบื้องหลัง
บริการ
ดัชนี
บริการดัชนีจัดการดัชนี Cloud Firestore
การสร้างดัชนีจะดำเนินการแบบอะซิงโครนัส ทรัพยากรการดำเนินงานถูกสร้างขึ้นสำหรับการดำเนินการแบบอะซิงโครนัสแต่ละรายการ สถานะของการดำเนินการ (รวมถึงข้อผิดพลาดใดๆ ที่พบ) อาจถูกสอบถามผ่านทางทรัพยากรการดำเนินงาน
ข้อมูลเมตา
ให้ข้อมูลเมตาและข้อมูลทางสถิติเกี่ยวกับข้อมูลใน Cloud Firestore ข้อมูลที่ให้ไว้เป็นส่วนหนึ่งของ API นี้อาจเก่าแล้ว
การดำเนินการ
คอลเลกชัน Operations จัดเตรียมบันทึกการดำเนินการที่ดำเนินการสำหรับโครงการที่ระบุ (รวมถึงการดำเนินการใดๆ ที่กำลังดำเนินการอยู่) การดำเนินการไม่ได้ถูกสร้างขึ้นโดยตรง แต่ผ่านการเรียกในคอลเลกชันหรือทรัพยากรอื่นๆ
การดำเนินการที่ยังไม่เสร็จสิ้นอาจถูกยกเลิก คำร้องขอยกเลิกเป็นแบบอะซิงโครนัส และการดำเนินการอาจยังคงทำงานต่อไปอีกระยะหนึ่งหลังจากการร้องขอให้ยกเลิก
การดำเนินการที่ทำเสร็จแล้วอาจถูกลบออก เพื่อไม่ให้แสดงเป็นส่วนหนึ่งของคอลเลกชันการดำเนินการอีกต่อไป
การดำเนินการถูกสร้างขึ้นโดยบริการ FirestoreAdmin
แต่เข้าถึงได้ผ่านบริการ google.longrunning.Operations
สร้างดัชนี |
---|
สร้างดัชนีที่ระบุ สถานะเริ่มต้นของดัชนีที่สร้างขึ้นใหม่กำลัง ในระหว่างการสร้าง กระบวนการอาจส่งผลให้เกิดข้อผิดพลาด ในกรณีนี้ดัชนีจะย้ายไปยังสถานะ ไม่สามารถสร้างดัชนีที่มีฟิลด์เดียวได้
|
ลบดัชนี |
---|
ลบดัชนี
|
ส่งออกเอกสาร |
---|
ส่งออกสำเนาของเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบจัดเก็บข้อมูลอื่น เช่น Google Cloud Storage การอัปเดตเอกสารล่าสุดอาจไม่สะท้อนให้เห็นในการส่งออก การส่งออกจะเกิดขึ้นในเบื้องหลัง และสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทรัพยากรการดำเนินการที่สร้างขึ้น ผลลัพธ์ของการส่งออกสามารถใช้ได้เฉพาะเมื่อการดำเนินการที่เกี่ยวข้องเสร็จสิ้นแล้วเท่านั้น หากการดำเนินการส่งออกถูกยกเลิกก่อนที่จะเสร็จสิ้น อาจทิ้งข้อมูลบางส่วนไว้ใน Google Cloud Storage
|
รับดัชนี |
---|
รับดัชนี
|
เอกสารนำเข้า |
---|
นำเข้าเอกสารไปยัง Google Cloud Firestore เอกสารที่มีอยู่ซึ่งมีชื่อเดียวกันจะถูกเขียนทับ การนำเข้าจะเกิดขึ้นในเบื้องหลัง และสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทางทรัพยากรการดำเนินการที่สร้างขึ้น หากการดำเนินการ ImportDocuments ถูกยกเลิก อาจเป็นไปได้ว่าชุดย่อยของข้อมูลได้ถูกนำเข้าไปยัง Cloud Firestore แล้ว
|
รายการดัชนี |
---|
แสดงรายการดัชนีที่ตรงกับตัวกรองที่ระบุ
|
CreateIndexRequest
เขตข้อมูล | |
---|---|
parent | ชื่อของฐานข้อมูลที่ดัชนีนี้จะนำไปใช้ ตัวอย่างเช่น: |
index | ดัชนีที่จะสร้าง ช่องชื่อและสถานะเป็นเพียงเอาต์พุตเท่านั้น และจะถูกละเว้น ดัชนีฟิลด์เดี่ยวบางรายการไม่สามารถสร้างหรือลบได้ |
ลบคำขอดัชนี
เขตข้อมูล | |
---|---|
name | ชื่อดัชนี ตัวอย่างเช่น: |
ส่งออกเอกสารข้อมูลเมตา
ข้อมูลเมตาสำหรับการดำเนินการ ExportDocuments
เขตข้อมูล | |
---|---|
start_time | เวลาที่งานเริ่มดำเนินการ |
end_time | เวลาที่การดำเนินการสิ้นสุดลง ไม่ว่าจะสำเร็จหรือไม่ก็ตาม ยกเลิกการตั้งค่าหากการดำเนินการยังคงทำงานอยู่ |
operation_state | สถานะของการดำเนินการส่งออก |
progress_documents | การประมาณจำนวนเอกสารที่ประมวลผล |
progress_bytes | การประมาณจำนวนไบต์ที่ประมวลผล |
collection_ids[] | รหัสคอลเลกชันใดที่กำลังส่งออก |
output_uri_prefix | ที่ที่เอนทิตีจะถูกส่งออกไป |
คำขอส่งออกเอกสาร
เขตข้อมูล | |
---|---|
name | ฐานข้อมูลที่จะส่งออก ควรอยู่ในรูปแบบ: |
collection_ids[] | รหัสคอลเลกชันใดที่จะส่งออก ไม่ระบุ หมายถึง คอลเลกชันทั้งหมด |
output_uri_prefix | URI เอาต์พุต ปัจจุบันรองรับเฉพาะ URI ของ Google Cloud Storage ในรูปแบบ: |
ส่งออกการตอบสนองเอกสาร
ส่งคืนในช่องตอบกลับ google.longrunning.Operation
เขตข้อมูล | |
---|---|
output_uri_prefix | ตำแหน่งของไฟล์เอาต์พุต สามารถใช้เพื่อเริ่มนำเข้าไปยัง Cloud Firestore (โปรเจ็กต์นี้หรือโปรเจ็กต์อื่น) หลังจากการดำเนินการเสร็จสมบูรณ์แล้ว |
GetIndexRequest
เขตข้อมูล | |
---|---|
name | ชื่อของดัชนี ตัวอย่างเช่น: |
นำเข้าเอกสารเมตาดาต้า
ข้อมูลเมตาสำหรับการดำเนินการ ImportDocuments
เขตข้อมูล | |
---|---|
start_time | เวลาที่งานเริ่มดำเนินการ |
end_time | เวลาที่การดำเนินการสิ้นสุดลง ไม่ว่าจะสำเร็จหรือไม่ก็ตาม ยกเลิกการตั้งค่าหากการดำเนินการยังคงทำงานอยู่ |
operation_state | สถานะของการดำเนินการนำเข้า |
progress_documents | การประมาณจำนวนเอกสารที่ประมวลผล |
progress_bytes | การประมาณจำนวนไบต์ที่ประมวลผล |
collection_ids[] | รหัสคอลเลกชันใดที่กำลังนำเข้า |
input_uri_prefix | ตำแหน่งของเอกสารที่นำเข้า |
คำขอเอกสารนำเข้า
เขตข้อมูล | |
---|---|
name | ฐานข้อมูลที่จะนำเข้า ควรอยู่ในรูปแบบ: |
collection_ids[] | รหัสคอลเลกชันใดที่จะนำเข้า ไม่ระบุ หมายถึงคอลเลกชันทั้งหมดที่รวมอยู่ในการนำเข้า |
input_uri_prefix | ตำแหน่งของไฟล์ที่ส่งออก สิ่งนี้จะต้องตรงกับ output_uri_prefix ของ ExportDocumentsResponse จากการส่งออกที่เสร็จสมบูรณ์แล้ว ดู: |
ดัชนี
คำนิยามดัชนี
เขตข้อมูล | |
---|---|
name | ชื่อทรัพยากรของดัชนี เอาท์พุทเท่านั้น |
collection_id | รหัสคอลเลกชันที่ดัชนีนี้ใช้ ที่จำเป็น. |
fields[] | ฟิลด์ที่จะทำดัชนี |
state | สถานะของดัชนี เอาท์พุทเท่านั้น |
สถานะ
สถานะของดัชนี ในระหว่างการสร้างดัชนี ดัชนีจะอยู่ในสถานะ CREATING
หากสร้างดัชนีสำเร็จ ดัชนีจะเปลี่ยนเป็นสถานะ READY
หากไม่สามารถสร้างดัชนีได้ ดัชนีจะเปลี่ยนเป็นสถานะ ERROR
เอนัม | |
---|---|
STATE_UNSPECIFIED | รัฐไม่ระบุ |
CREATING | กำลังสร้างดัชนี มีการดำเนินการระยะยาวที่ใช้งานอยู่สำหรับดัชนี ดัชนีได้รับการอัปเดตเมื่อเขียนเอกสาร ข้อมูลดัชนีบางส่วนอาจมีอยู่ |
READY | ดัชนีพร้อมใช้งานแล้ว ดัชนีได้รับการอัปเดตเมื่อเขียนเอกสาร ดัชนีจะถูกเติมโดยสมบูรณ์จากเอกสารที่จัดเก็บทั้งหมดที่ใช้ |
ERROR | กำลังสร้างดัชนี แต่มีบางอย่างผิดพลาด ไม่มีการดำเนินการที่รันระยะยาวที่ใช้งานอยู่สำหรับดัชนี และการดำเนินการที่รันระยะยาวที่เสร็จสิ้นล่าสุดล้มเหลว ดัชนีไม่ได้รับการอัพเดตเมื่อเขียนเอกสาร ข้อมูลดัชนีบางส่วนอาจมีอยู่ |
IndexField
เขตข้อมูลของดัชนี
เขตข้อมูล | |
---|---|
field_path | เส้นทางของสนาม ต้องตรงกับข้อกำหนดเส้นทางของฟิลด์ที่อธิบายโดย [google.firestore.v1beta1.Document.fields][fields] พาธฟิลด์พิเศษ |
mode | โหมดของสนาม |
โหมด
โหมดนี้จะกำหนดวิธีการจัดทำดัชนีฟิลด์
เอนัม | |
---|---|
MODE_UNSPECIFIED | ไม่ได้ระบุโหมด |
ASCENDING | ค่าของฟิลด์ได้รับการจัดทำดัชนีเพื่อรองรับการเรียงลำดับจากน้อยไปหามากและยังสืบค้นด้วย <, >, <=, >= และ = |
DESCENDING | ค่าของฟิลด์ได้รับการจัดทำดัชนีเพื่อรองรับการเรียงลำดับจากมากไปน้อยและยังค้นหาด้วย <, >, <=, >= และ = |
ARRAY_CONTAINS | ค่าอาร์เรย์ของฟิลด์ได้รับการจัดทำดัชนีเพื่อรองรับการเป็นสมาชิกโดยใช้คำสั่ง ARRAY_CONTAINS |
IndexOperationMetadata
ข้อมูลเมตาสำหรับการดำเนินการดัชนี ข้อมูลเมตานี้เติมข้อมูลในช่องข้อมูลเมตาของ google.longrunning.Operation
เขตข้อมูล | |
---|---|
start_time | เวลาที่งานเริ่มดำเนินการ |
end_time | เวลาที่การดำเนินการสิ้นสุดลง ไม่ว่าจะสำเร็จหรือไม่ก็ตาม ยกเลิกการตั้งค่าหากการดำเนินการยังคงทำงานอยู่ |
index | ทรัพยากรดัชนีที่การดำเนินการนี้ดำเนินการอยู่ ตัวอย่างเช่น: |
operation_type | ประเภทของการดำเนินการดัชนี |
cancelled | เป็นจริงหาก |
document_progress | ความคืบหน้าของการดำเนินงานปัจจุบัน วัดจากจำนวนเอกสาร |
ประเภทการดำเนินการ
ประเภทของการดำเนินการดัชนี
เอนัม | |
---|---|
OPERATION_TYPE_UNSPECIFIED | ไม่ระบุ ไม่เคยตั้งค่าโดยเซิร์ฟเวอร์ |
CREATING_INDEX | การดำเนินการกำลังสร้างดัชนี เริ่มต้นโดยการเรียก CreateIndex |
รายการดัชนีคำขอ
เขตข้อมูล | |
---|---|
parent | ชื่อฐานข้อมูล ตัวอย่างเช่น: |
filter | |
page_size | ขนาดหน้ารายการมาตรฐาน |
page_token | โทเค็นหน้ารายการมาตรฐาน |
รายการดัชนีการตอบสนอง
การตอบสนองสำหรับ FirestoreAdmin.ListIndexes
เขตข้อมูล | |
---|---|
indexes[] | ดัชนี |
next_page_token | รายการมาตรฐานโทเค็นหน้าถัดไป |
ข้อมูลเมตาของตำแหน่ง
ประเภทนี้ไม่มีฟิลด์
ข้อความข้อมูลเมตาสำหรับ google.cloud.location.Location.metadata
สถานะการดำเนินงาน
สถานะต่างๆ ที่เป็นไปได้สำหรับการดำเนินการที่กำลังดำเนินอยู่
เอนัม | |
---|---|
STATE_UNSPECIFIED | ไม่ระบุ |
INITIALIZING | กำลังเตรียมคำขอสำหรับการประมวลผล |
PROCESSING | คำขอกำลังดำเนินการอยู่ |
CANCELLING | คำขออยู่ระหว่างการยกเลิกหลังจากที่ผู้ใช้ชื่อ google.longrunning.Operations.CancelOperation ในการดำเนินการ |
FINALIZING | คำขอได้รับการประมวลผลแล้วและอยู่ในขั้นตอนการสรุปผล |
SUCCESSFUL | คำขอเสร็จสมบูรณ์แล้ว |
FAILED | คำขอได้รับการประมวลผลเสร็จแล้ว แต่พบข้อผิดพลาด |
CANCELLED | คำขอถูกยกเลิกเสร็จสิ้นแล้วหลังจากที่ผู้ใช้เรียก google.longrunning.Operations.CancelOperation |
ความคืบหน้า
วัดความคืบหน้าของตัวชี้วัดเฉพาะ
เขตข้อมูล | |
---|---|
work_completed | การประมาณปริมาณงานที่ทำเสร็จแล้ว โปรดทราบว่าค่านี้อาจมากกว่า |
work_estimated | การประมาณปริมาณงานที่ต้องทำ เป็นศูนย์หากไม่มีการประมาณการงาน อาจมีการเปลี่ยนแปลงตามงานดำเนินไป |