Package google.firestore.admin.v1beta1

ดัชนี

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

Cloud Firestore Admin API

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

แนวคิด

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

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

บริการ

ดัชนี

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

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

ข้อมูลเมตา

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

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

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

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

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

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

CreateIndex

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

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

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

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

DeleteIndexRequest

คำขอสำหรับ FirestoreAdmin.DeleteIndex

ช่อง
name

string

ชื่อดัชนี เช่น projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

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

ช่อง
start_time

Timestamp

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

Timestamp

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

OperationState

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

Progress

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

Progress

จำนวนไบต์ที่ประมวลผลโดยประมาณ
collection_ids[]

string

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

string

ที่ที่ส่งออกเอนทิตี

ExportDocumentsRequest

คำขอสำหรับ 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 เป็นที่เก็บข้อมูล (ไม่มีเส้นทางเนมสเปซ) ระบบจะสร้างคำนำหน้าตามเวลาเริ่มต้น

ExportDocumentsResponse

แสดงผลในช่องคำตอบ 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

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

ดัชนี

คำจำกัดความของดัชนี

ช่อง
name

string

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

string

รหัสคอลเล็กชันที่ดัชนีนี้ใช้ ต้องระบุ
fields[]

IndexField

ช่องที่จะทำดัชนี
state

State

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

รัฐ

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

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

ฟิลด์ดัชนี

ช่องของดัชนี

ช่อง
field_path

string

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

Mode

โหมดของช่อง

โหมด

โหมดจะกำหนดวิธีจัดทำดัชนีให้กับช่อง

Enum
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

ความคืบหน้าของการดำเนินการที่มีอยู่ วัดตามจำนวนเอกสาร

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

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

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

ListIndexesRequest

คำขอสำหรับ FirestoreAdmin.ListIndexes

ช่อง
parent

string

ชื่อฐานข้อมูล เช่น projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

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

string

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

ListIndexesResponse

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

ช่อง
indexes[]

Index

ดัชนี
next_page_token

string

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

ข้อมูลเมตาของสถานที่

ประเภทนี้ไม่มีช่อง

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

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

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

Enum
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

จำนวนงานที่ต้องทำโดยประมาณ 0 หากไม่มีค่าประมาณงาน อาจมีการเปลี่ยนแปลงเมื่องานมีความคืบหน้า