Package google.firestore.admin.v1beta1

ดัชนี

ผู้ดูแลระบบ Firestore

API ผู้ดูแลระบบ Cloud Firestore

API นี้ให้บริการด้านการดูแลระบบหลายอย่างสำหรับ Cloud Firestore

แนวคิด

มีการใช้โปรเจ็กต์ ฐานข้อมูล เนมสเปซ คอลเลกชัน และเอกสารตามที่กำหนดไว้ใน Google Cloud Firestore API

การดำเนินการ: การดำเนินการแสดงถึงงานที่ดำเนินการในเบื้องหลัง

บริการ

ดัชนี

บริการดัชนีจัดการดัชนี Cloud Firestore

การสร้างดัชนีจะดำเนินการแบบอะซิงโครนัส ทรัพยากรการดำเนินงานถูกสร้างขึ้นสำหรับการดำเนินการแบบอะซิงโครนัสแต่ละรายการ สถานะของการดำเนินการ (รวมถึงข้อผิดพลาดใดๆ ที่พบ) อาจถูกสอบถามผ่านทางทรัพยากรการดำเนินงาน

ข้อมูลเมตา

ให้ข้อมูลเมตาและข้อมูลทางสถิติเกี่ยวกับข้อมูลใน Cloud Firestore ข้อมูลที่ให้ไว้เป็นส่วนหนึ่งของ API นี้อาจเก่าแล้ว

การดำเนินการ

คอลเลกชัน Operations จัดเตรียมบันทึกการดำเนินการที่ดำเนินการสำหรับโครงการที่ระบุ (รวมถึงการดำเนินการใดๆ ที่กำลังดำเนินการอยู่) การดำเนินการไม่ได้ถูกสร้างขึ้นโดยตรง แต่ผ่านการเรียกในคอลเลกชันหรือทรัพยากรอื่นๆ

การดำเนินการที่ยังไม่เสร็จสิ้นอาจถูกยกเลิก คำร้องขอยกเลิกเป็นแบบอะซิงโครนัส และการดำเนินการอาจยังคงทำงานต่อไปอีกระยะหนึ่งหลังจากการร้องขอให้ยกเลิก

การดำเนินการที่ทำเสร็จแล้วอาจถูกลบออก เพื่อไม่ให้แสดงเป็นส่วนหนึ่งของคอลเลกชันการดำเนินการอีกต่อไป

การดำเนินการถูกสร้างขึ้นโดยบริการ FirestoreAdmin แต่เข้าถึงได้ผ่านบริการ google.longrunning.Operations

สร้างดัชนี

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

สร้างดัชนีที่ระบุ สถานะเริ่มต้นของดัชนีที่สร้างขึ้นใหม่กำลัง CREATING เมื่อ google.longrunning.Operation ที่ส่งคืนเสร็จสิ้น สถานะจะ READY หากมีดัชนีอยู่แล้ว การโทรจะส่งกลับสถานะ ALREADY_EXISTS

ในระหว่างการสร้าง กระบวนการอาจส่งผลให้เกิดข้อผิดพลาด ในกรณีนี้ดัชนีจะย้ายไปยังสถานะ ERROR กระบวนการสามารถกู้คืนได้โดยการแก้ไขข้อมูลที่ทำให้เกิดข้อผิดพลาด ลบดัชนีด้วย delete จากนั้นสร้างดัชนีใหม่ด้วย create

ไม่สามารถสร้างดัชนีที่มีฟิลด์เดียวได้

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

ลบดัชนี

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

ลบดัชนี

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

ส่งออกเอกสาร

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

ส่งออกสำเนาของเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบจัดเก็บข้อมูลอื่น เช่น Google Cloud Storage การอัปเดตเอกสารล่าสุดอาจไม่สะท้อนให้เห็นในการส่งออก การส่งออกจะเกิดขึ้นในเบื้องหลัง และสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทรัพยากรการดำเนินการที่สร้างขึ้น ผลลัพธ์ของการส่งออกสามารถใช้ได้เฉพาะเมื่อการดำเนินการที่เกี่ยวข้องเสร็จสิ้นแล้วเท่านั้น หากการดำเนินการส่งออกถูกยกเลิกก่อนที่จะเสร็จสิ้น อาจทิ้งข้อมูลบางส่วนไว้ใน Google Cloud Storage

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

รับดัชนี

rpc GetIndex( GetIndexRequest ) returns ( Index )

รับดัชนี

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

เอกสารนำเข้า

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

นำเข้าเอกสารไปยัง Google Cloud Firestore เอกสารที่มีอยู่ซึ่งมีชื่อเดียวกันจะถูกเขียนทับ การนำเข้าจะเกิดขึ้นในเบื้องหลัง และสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทางทรัพยากรการดำเนินการที่สร้างขึ้น หากการดำเนินการ ImportDocuments ถูกยกเลิก อาจเป็นไปได้ว่าชุดย่อยของข้อมูลได้ถูกนำเข้าไปยัง Cloud Firestore แล้ว

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

รายการดัชนี

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

แสดงรายการดัชนีที่ตรงกับตัวกรองที่ระบุ

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

CreateIndexRequest

คำขอ FirestoreAdmin.CreateIndex

เขตข้อมูล
parent

string

ชื่อของฐานข้อมูลที่ดัชนีนี้จะนำไปใช้ ตัวอย่างเช่น: projects/{project_id}/databases/{database_id}

index

Index

ดัชนีที่จะสร้าง ช่องชื่อและสถานะเป็นเพียงเอาต์พุตเท่านั้น และจะถูกละเว้น ดัชนีฟิลด์เดี่ยวบางรายการไม่สามารถสร้างหรือลบได้

ลบคำขอดัชนี

คำขอ FirestoreAdmin.DeleteIndex

เขตข้อมูล
name

string

ชื่อดัชนี ตัวอย่างเช่น: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ส่งออกเอกสารข้อมูลเมตา

ข้อมูลเมตาสำหรับการดำเนินการ ExportDocuments

เขตข้อมูล
start_time

Timestamp

เวลาที่งานเริ่มดำเนินการ

end_time

Timestamp

เวลาที่การดำเนินการสิ้นสุดลง ไม่ว่าจะสำเร็จหรือไม่ก็ตาม ยกเลิกการตั้งค่าหากการดำเนินการยังคงทำงานอยู่

operation_state

OperationState

สถานะของการดำเนินการส่งออก

progress_documents

Progress

การประมาณจำนวนเอกสารที่ประมวลผล

progress_bytes

Progress

การประมาณจำนวนไบต์ที่ประมวลผล

collection_ids[]

string

รหัสคอลเลกชันใดที่กำลังส่งออก

output_uri_prefix

string

ที่ที่เอนทิตีจะถูกส่งออกไป

คำขอส่งออกเอกสาร

คำขอ FirestoreAdmin.ExportDocuments

เขตข้อมูล
name

string

ฐานข้อมูลที่จะส่งออก ควรอยู่ในรูปแบบ: projects/{project_id}/databases/{database_id}

collection_ids[]

string

รหัสคอลเลกชันใดที่จะส่งออก ไม่ระบุ หมายถึง คอลเลกชันทั้งหมด

output_uri_prefix

string

URI เอาต์พุต ปัจจุบันรองรับเฉพาะ URI ของ Google Cloud Storage ในรูปแบบ: gs://BUCKET_NAME[/NAMESPACE_PATH] โดยที่ BUCKET_NAME เป็นชื่อของที่เก็บข้อมูล Google Cloud Storage และ NAMESPACE_PATH เป็นเส้นทางเนมสเปซเสริมของ Google Cloud Storage เมื่อเลือกชื่อ โปรดพิจารณาหลักเกณฑ์การตั้งชื่อของ Google Cloud Storage: https://cloud.google.com/storage/docs/naming หาก URI เป็นที่เก็บข้อมูล (ไม่มีเส้นทางเนมสเปซ) คำนำหน้าจะถูกสร้างขึ้นตามเวลาเริ่มต้น

ส่งออกการตอบสนองเอกสาร

ส่งคืนในช่องตอบกลับ google.longrunning.Operation

เขตข้อมูล
output_uri_prefix

string

ตำแหน่งของไฟล์เอาต์พุต สามารถใช้เพื่อเริ่มนำเข้าไปยัง Cloud Firestore (โปรเจ็กต์นี้หรือโปรเจ็กต์อื่น) หลังจากการดำเนินการเสร็จสมบูรณ์แล้ว

GetIndexRequest

คำขอ FirestoreAdmin.GetIndex

เขตข้อมูล
name

string

ชื่อของดัชนี ตัวอย่างเช่น: projects/{project_id}/databases/{database_id}/indexes/{index_id}

นำเข้าเอกสารเมตาดาต้า

ข้อมูลเมตาสำหรับการดำเนินการ ImportDocuments

เขตข้อมูล
start_time

Timestamp

เวลาที่งานเริ่มดำเนินการ

end_time

Timestamp

เวลาที่การดำเนินการสิ้นสุดลง ไม่ว่าจะสำเร็จหรือไม่ก็ตาม ยกเลิกการตั้งค่าหากการดำเนินการยังคงทำงานอยู่

operation_state

OperationState

สถานะของการดำเนินการนำเข้า

progress_documents

Progress

การประมาณจำนวนเอกสารที่ประมวลผล

progress_bytes

Progress

การประมาณจำนวนไบต์ที่ประมวลผล

collection_ids[]

string

รหัสคอลเลกชันใดที่กำลังนำเข้า

input_uri_prefix

string

ตำแหน่งของเอกสารที่นำเข้า

คำขอเอกสารนำเข้า

คำขอ FirestoreAdmin.ImportDocuments

เขตข้อมูล
name

string

ฐานข้อมูลที่จะนำเข้า ควรอยู่ในรูปแบบ: projects/{project_id}/databases/{database_id}

collection_ids[]

string

รหัสคอลเลกชันใดที่จะนำเข้า ไม่ระบุ หมายถึงคอลเลกชันทั้งหมดที่รวมอยู่ในการนำเข้า

input_uri_prefix

string

ตำแหน่งของไฟล์ที่ส่งออก สิ่งนี้จะต้องตรงกับ output_uri_prefix ของ ExportDocumentsResponse จากการส่งออกที่เสร็จสมบูรณ์แล้ว ดู: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix

ดัชนี

คำนิยามดัชนี

เขตข้อมูล
name

string

ชื่อทรัพยากรของดัชนี เอาท์พุทเท่านั้น

collection_id

string

รหัสคอลเลกชันที่ดัชนีนี้ใช้ ที่จำเป็น.

fields[]

IndexField

ฟิลด์ที่จะทำดัชนี

state

State

สถานะของดัชนี เอาท์พุทเท่านั้น

สถานะ

สถานะของดัชนี ในระหว่างการสร้างดัชนี ดัชนีจะอยู่ในสถานะ CREATING หากสร้างดัชนีสำเร็จ ดัชนีจะเปลี่ยนเป็นสถานะ READY หากไม่สามารถสร้างดัชนีได้ ดัชนีจะเปลี่ยนเป็นสถานะ ERROR

เอนัม
STATE_UNSPECIFIED รัฐไม่ระบุ
CREATING กำลังสร้างดัชนี มีการดำเนินการระยะยาวที่ใช้งานอยู่สำหรับดัชนี ดัชนีได้รับการอัปเดตเมื่อเขียนเอกสาร ข้อมูลดัชนีบางส่วนอาจมีอยู่
READY ดัชนีพร้อมใช้งานแล้ว ดัชนีได้รับการอัปเดตเมื่อเขียนเอกสาร ดัชนีจะถูกเติมโดยสมบูรณ์จากเอกสารที่จัดเก็บทั้งหมดที่ใช้
ERROR กำลังสร้างดัชนี แต่มีบางอย่างผิดพลาด ไม่มีการดำเนินการที่รันระยะยาวที่ใช้งานอยู่สำหรับดัชนี และการดำเนินการที่รันระยะยาวที่เสร็จสิ้นล่าสุดล้มเหลว ดัชนีไม่ได้รับการอัพเดตเมื่อเขียนเอกสาร ข้อมูลดัชนีบางส่วนอาจมีอยู่

IndexField

เขตข้อมูลของดัชนี

เขตข้อมูล
field_path

string

เส้นทางของสนาม ต้องตรงกับข้อกำหนดเส้นทางของฟิลด์ที่อธิบายโดย [google.firestore.v1beta1.Document.fields][fields] พาธฟิลด์พิเศษ __name__ อาจใช้เพียงตัวมันเองหรือที่ส่วนท้ายของพาธ __type__ สามารถใช้ได้เฉพาะที่ส่วนท้ายของเส้นทางเท่านั้น

mode

Mode

โหมดของสนาม

โหมด

โหมดนี้จะกำหนดวิธีการจัดทำดัชนีฟิลด์

เอนัม
MODE_UNSPECIFIED ไม่ได้ระบุโหมด
ASCENDING ค่าของฟิลด์ได้รับการจัดทำดัชนีเพื่อรองรับการเรียงลำดับจากน้อยไปหามากและยังสืบค้นด้วย <, >, <=, >= และ =
DESCENDING ค่าของฟิลด์ได้รับการจัดทำดัชนีเพื่อรองรับการเรียงลำดับจากมากไปน้อยและยังค้นหาด้วย <, >, <=, >= และ =
ARRAY_CONTAINS ค่าอาร์เรย์ของฟิลด์ได้รับการจัดทำดัชนีเพื่อรองรับการเป็นสมาชิกโดยใช้คำสั่ง ARRAY_CONTAINS

IndexOperationMetadata

ข้อมูลเมตาสำหรับการดำเนินการดัชนี ข้อมูลเมตานี้เติมข้อมูลในช่องข้อมูลเมตาของ google.longrunning.Operation

เขตข้อมูล
start_time

Timestamp

เวลาที่งานเริ่มดำเนินการ

end_time

Timestamp

เวลาที่การดำเนินการสิ้นสุดลง ไม่ว่าจะสำเร็จหรือไม่ก็ตาม ยกเลิกการตั้งค่าหากการดำเนินการยังคงทำงานอยู่

index

string

ทรัพยากรดัชนีที่การดำเนินการนี้ดำเนินการอยู่ ตัวอย่างเช่น: projects/{project_id}/databases/{database_id}/indexes/{index_id}

operation_type

OperationType

ประเภทของการดำเนินการดัชนี

cancelled

bool

เป็นจริงหาก google.longrunning.Operation ถูกยกเลิก หากอยู่ระหว่างการยกเลิก การยกเลิกจะเป็นจริง แต่ google.longrunning.Operation.done จะเป็นเท็จ

document_progress

Progress

ความคืบหน้าของการดำเนินงานปัจจุบัน วัดจากจำนวนเอกสาร

ประเภทการดำเนินการ

ประเภทของการดำเนินการดัชนี

เอนัม
OPERATION_TYPE_UNSPECIFIED ไม่ระบุ ไม่เคยตั้งค่าโดยเซิร์ฟเวอร์
CREATING_INDEX การดำเนินการกำลังสร้างดัชนี เริ่มต้นโดยการเรียก CreateIndex

รายการดัชนีคำขอ

คำขอ FirestoreAdmin.ListIndexes

เขตข้อมูล
parent

string

ชื่อฐานข้อมูล ตัวอย่างเช่น: projects/{project_id}/databases/{database_id}

filter

string

page_size

int32

ขนาดหน้ารายการมาตรฐาน

page_token

string

โทเค็นหน้ารายการมาตรฐาน

รายการดัชนีการตอบสนอง

การตอบสนองสำหรับ FirestoreAdmin.ListIndexes

เขตข้อมูล
indexes[]

Index

ดัชนี

next_page_token

string

รายการมาตรฐานโทเค็นหน้าถัดไป

ข้อมูลเมตาของตำแหน่ง

ประเภทนี้ไม่มีฟิลด์

ข้อความข้อมูลเมตาสำหรับ google.cloud.location.Location.metadata

สถานะการดำเนินงาน

สถานะต่างๆ ที่เป็นไปได้สำหรับการดำเนินการที่กำลังดำเนินอยู่

เอนัม
STATE_UNSPECIFIED ไม่ระบุ
INITIALIZING กำลังเตรียมคำขอสำหรับการประมวลผล
PROCESSING คำขอกำลังดำเนินการอยู่
CANCELLING คำขออยู่ระหว่างการยกเลิกหลังจากที่ผู้ใช้ชื่อ google.longrunning.Operations.CancelOperation ในการดำเนินการ
FINALIZING คำขอได้รับการประมวลผลแล้วและอยู่ในขั้นตอนการสรุปผล
SUCCESSFUL คำขอเสร็จสมบูรณ์แล้ว
FAILED คำขอได้รับการประมวลผลเสร็จแล้ว แต่พบข้อผิดพลาด
CANCELLED คำขอถูกยกเลิกเสร็จสิ้นแล้วหลังจากที่ผู้ใช้เรียก google.longrunning.Operations.CancelOperation

ความคืบหน้า

วัดความคืบหน้าของตัวชี้วัดเฉพาะ

เขตข้อมูล
work_completed

int64

การประมาณปริมาณงานที่ทำเสร็จแล้ว โปรดทราบว่าค่านี้อาจมากกว่า work_estimated

work_estimated

int64

การประมาณปริมาณงานที่ต้องทำ เป็นศูนย์หากไม่มีการประมาณการงาน อาจมีการเปลี่ยนแปลงตามงานดำเนินไป