Package google.firestore.admin.v1beta2

ดัชนี

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

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

สร้างดัชนีผสม การดำเนินการนี้จะแสดงผล google.longrunning.Operation ซึ่งสามารถใช้เพื่อติดตามสถานะของผลงาน ข้อมูลเมตาสำหรับการดำเนินการจะเป็นประเภท IndexOperationMetadata

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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 GetField(GetFieldRequest) returns (Field)

รับข้อมูลเมตาและการกำหนดค่าสำหรับช่อง

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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 ListFields(ListFieldsRequest) returns (ListFieldsResponse)

แสดงการกำหนดค่าช่องและข้อมูลเมตาสำหรับฐานข้อมูลนี้

ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายชื่อที่มีการลบล้างอย่างชัดแจ้ง หากต้องการดำเนินการค้นหานี้ โปรดโทร FirestoreAdmin.ListFields ซึ่งตั้งค่าตัวกรองเป็น indexConfig.usesAncestorConfig:false

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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

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

rpc UpdateField(UpdateFieldRequest) returns (Operation)

อัปเดตการกำหนดค่าช่อง ปัจจุบันการอัปเดตช่องจะมีผลกับการกำหนดค่าดัชนีช่องเดียวเท่านั้น แต่การเรียกใช้ FirestoreAdmin.UpdateField ควรมีฟิลด์มาสก์เพื่อหลีกเลี่ยงการเปลี่ยนแปลงการกำหนดค่าที่ผู้โทรไม่ทราบ ฟิลด์มาสก์ควรระบุเป็น { paths: "index_config" }

การเรียกนี้จะส่งคืน google.longrunning.Operation ซึ่งสามารถใช้เพื่อติดตามสถานะของการอัปเดตช่องได้ ข้อมูลเมตาสำหรับการดำเนินการจะเป็นประเภท FieldOperationMetadata

ในการกำหนดการตั้งค่าช่องเริ่มต้นสำหรับฐานข้อมูล ให้ใช้ Field พิเศษที่มีชื่อทรัพยากร: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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}/collectionGroups/{collection_id}
index

Index

ดัชนีผสมที่จะสร้าง

DeleteIndexRequest

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

ช่อง
name

string

ชื่อของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

ผลการค้นหาข้อมูลเมตาสำหรับ google.longrunning.Operation จาก FirestoreAdmin.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 (โปรเจ็กต์นี้หรือโปรเจ็กต์อื่น) หลังจากการดำเนินการเสร็จสมบูรณ์

ช่อง

แสดงช่องเดียวในฐานข้อมูล

ช่องต่างๆ จะจัดกลุ่มตาม "กลุ่มคอลเล็กชัน" ซึ่งแสดงคอลเล็กชันทั้งหมดในฐานข้อมูลที่มีรหัสเดียวกัน

ช่อง
name

string

ชื่อช่องของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

เส้นทางช่องอาจเป็นชื่อช่องง่ายๆ ได้ เช่น address หรือเส้นทางไปยังช่องภายใน Map_value เช่น address.city หรือเส้นทางช่องพิเศษ ช่องพิเศษที่ถูกต้องมีช่องเดียวคือ * ซึ่งจะแสดงแทนช่องใดก็ได้

เส้นทางช่องอาจระบุโดยใช้ (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` และอักขระ ASCII ใดๆ ก็ตาม

ตัวอย่าง: (หมายเหตุ: ความคิดเห็นในที่นี้จะเขียนด้วยไวยากรณ์มาร์กดาวน์ จึงมีเครื่องหมายแบ็กทิกอีกชั้นเพื่อใช้แทนโค้ดบล็อก) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*` ไม่ใช่ช่องใดๆ

Field พิเศษมีการตั้งค่าการจัดทำดัชนีเริ่มต้นสำหรับทุกช่อง ชื่อทรัพยากรของช่องนี้คือ: ดัชนี projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* รายการที่กำหนดไว้ใน Field นี้จะมีผลกับทุกฟิลด์ที่ไม่มีการกำหนดค่าดัชนี Field ของตัวเอง
index_config

IndexConfig

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

IndexConfig

การกำหนดค่าดัชนีสำหรับช่องนี้

ช่อง
indexes[]

Index

ดัชนีที่รองรับสำหรับช่องนี้
uses_ancestor_config

bool

เอาต์พุตเท่านั้น เมื่อเป็นจริง ระบบจะตั้งค่าการกำหนดค่าดัชนีของ Field จากการกำหนดค่าที่ ancestor_field ระบุ เมื่อเป็นเท็จ ระบบจะกำหนดค่าดัชนีของ Field อย่างชัดแจ้ง
ancestor_field

string

เอาต์พุตเท่านั้น ระบุชื่อทรัพยากรของ Field ที่ใช้กำหนดค่าดัชนีของช่องนี้ (เมื่อ uses_ancestor_config เป็นจริง) หรือกำหนดจากที่จะตั้งค่าหากช่องนี้ไม่มีการกำหนดค่าดัชนี (เมื่อ uses_ancestor_config เป็น false)
reverting

bool

แสดงผลเฉพาะเมื่อเป็น "จริง" การกำหนดค่าดัชนีของ Field กำลังอยู่ในระหว่างการเปลี่ยนกลับ เมื่อดำเนินการเสร็จแล้ว การกำหนดค่าดัชนีจะเปลี่ยนเป็นสถานะเดียวกับฟิลด์ที่ระบุโดย ancestor_field ซึ่ง ณ จุดนี้ uses_ancestor_config จะเป็น true และ reverting จะเป็น false

ข้อมูลเมตา FieldOperation

ผลการค้นหาข้อมูลเมตาสำหรับ google.longrunning.Operation จาก FirestoreAdmin.UpdateField

ช่อง
start_time

Timestamp

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

Timestamp

เวลาที่การดำเนินการนี้เสร็จสมบูรณ์ ยกเลิกการตั้งค่าหากยังดำเนินการอยู่
field

string

ทรัพยากรในช่องที่การดำเนินการนี้กำลังดำเนินการ เช่น projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

รายการของ IndexConfigDelta ซึ่งอธิบายเจตนาของการดำเนินการนี้
state

OperationState

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

Progress

ความคืบหน้าในเอกสารของการดำเนินการนี้
bytes_progress

Progress

ความคืบหน้า หน่วยเป็นไบต์ของการดำเนินการนี้

IndexConfigDelta

ข้อมูลเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่าดัชนี

ช่อง
change_type

ChangeType

ระบุว่าดัชนีเปลี่ยนแปลงอย่างไร
index

Index

ดัชนีที่กำลังเปลี่ยนแปลง

ประเภทการเปลี่ยนแปลง

ระบุว่าดัชนีเปลี่ยนแปลงอย่างไร

Enum
CHANGE_TYPE_UNSPECIFIED ไม่ได้ระบุหรือไม่ทราบประเภทของการเปลี่ยนแปลง
ADD กำลังเพิ่มดัชนีช่องเดียว
REMOVE กำลังนำดัชนีช่องเดี่ยวออก

GetFieldRequest

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

ช่อง
name

string

ชื่อของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

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

ช่อง
name

string

ชื่อของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

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

ผลการค้นหาข้อมูลเมตาสำหรับ google.longrunning.Operation จาก FirestoreAdmin.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.v1beta2.ExportDocumentsResponse.output_uri_prefix

ดัชนี

ดัชนี Cloud Firestore เปิดใช้การค้นหาที่เรียบง่ายและซับซ้อนในเอกสารในฐานข้อมูล

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อที่เซิร์ฟเวอร์กำหนดสำหรับดัชนีนี้ รูปแบบของชื่อนี้สำหรับดัชนีผสมจะเป็น projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} สำหรับดัชนีช่องเดียว ช่องนี้จะว่างเปล่า
query_scope

QueryScope

ดัชนีที่มีขอบเขตการค้นหาของคอลเล็กชันที่ระบุอนุญาตการค้นหากับคอลเล็กชันที่เป็นรายการย่อยของเอกสารที่เจาะจง ซึ่งระบุในเวลาสืบค้น และที่มีรหัสคอลเล็กชันเดียวกัน

ดัชนีที่มีขอบเขตการค้นหาของกลุ่มคอลเล็กชันที่ระบุอนุญาตให้มีการค้นหาในคอลเล็กชันทั้งหมดที่มาจากเอกสารที่เจาะจง ซึ่งระบุในเวลาค้นหา และที่มีรหัสคอลเล็กชันเดียวกันกับดัชนีนี้
fields[]

IndexField

ช่องที่ดัชนีนี้รองรับ

สำหรับดัชนีผสม ช่องนี้จะเป็น 2 ช่องขึ้นไปเสมอ รายการช่องสุดท้ายเป็นของเส้นทางช่อง __name__ เสมอ หากไม่ได้กำหนด __name__ เป็นช่องสุดท้ายขณะสร้าง ระบบจะเพิ่ม __name__ เป็นช่องสุดท้ายโดยอัตโนมัติในทิศทางเดียวกันกับช่องสุดท้ายที่กำหนด หากช่องสุดท้ายในดัชนีผสมไม่มีทิศทาง ระบบจะเรียงลำดับ __name__ จาก ASCENDING (เว้นแต่จะระบุอย่างชัดเจน)

สำหรับดัชนีช่องเดียว ค่านี้จะเป็น 1 รายการที่มีเส้นทางช่องเท่ากับเส้นทางช่องของช่องที่เกี่ยวข้องเสมอ
state

State

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

ฟิลด์ดัชนี

ช่องในดัชนี Field_path จะอธิบายช่องที่มีการจัดทำดัชนี ส่วน value_mode อธิบายวิธีจัดทําดัชนีค่าของช่อง

ช่อง
field_path

string

อาจเป็น name สำหรับดัชนีช่องเดี่ยว ค่านี้ต้องตรงกับชื่อช่องหรือละเว้นได้
ช่องการรวม value_mode วิธีจัดทำดัชนีค่าของช่อง value_mode ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
order

Order

ระบุว่าช่องนี้รองรับการจัดลำดับตามลำดับที่ระบุ หรือการเปรียบเทียบโดยใช้ =, <, <=, >, >=
array_config

ArrayConfig

ระบุว่าช่องนี้รองรับการดำเนินการใน array_value

การกำหนดค่าอาร์เรย์

การกำหนดค่าค่าอาร์เรย์ที่รองรับ

Enum
ARRAY_CONFIG_UNSPECIFIED ดัชนีไม่รองรับการค้นหาอาร์เรย์เพิ่มเติม
CONTAINS ดัชนีรองรับการค้นหาการควบคุมอาร์เรย์

สั่งซื้อ

การเรียงลำดับที่รองรับ

Enum
ORDER_UNSPECIFIED ไม่ได้ระบุการเรียงลำดับ ไม่ใช่ตัวเลือกที่ถูกต้อง
ASCENDING ช่องจะเรียงลำดับตามค่าในช่องจากน้อยไปมาก
DESCENDING ช่องจะเรียงลำดับตามค่าช่องจากมากไปน้อย

ขอบเขตการค้นหา

ขอบเขตการค้นหาจะกำหนดขอบเขตที่มีการเรียกใช้การค้นหา ซึ่งระบุในช่อง from ของ StructuredQuery

Enum
QUERY_SCOPE_UNSPECIFIED ไม่ได้ระบุขอบเขตการค้นหา ไม่ใช่ตัวเลือกที่ถูกต้อง
COLLECTION ดัชนีที่มีขอบเขตการค้นหาของคอลเล็กชันที่ระบุอนุญาตการค้นหากับคอลเล็กชันที่เป็นรายการย่อยของเอกสารที่เจาะจง ซึ่งระบุไว้ที่เวลาสืบค้น และมีรหัสคอลเล็กชันที่ดัชนีระบุไว้
COLLECTION_GROUP ดัชนีที่มีขอบเขตการค้นหากลุ่มคอลเล็กชันที่ระบุอนุญาตการค้นหากับคอลเล็กชันทั้งหมดที่มีรหัสคอลเล็กชันที่ดัชนีระบุไว้

รัฐ

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

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

IndexOperationMetadata

ผลการค้นหาข้อมูลเมตาสำหรับ google.longrunning.Operation จาก FirestoreAdmin.CreateIndex

ช่อง
start_time

Timestamp

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

Timestamp

เวลาที่การดำเนินการนี้เสร็จสมบูรณ์ ยกเลิกการตั้งค่าหากยังดำเนินการอยู่
index

string

ทรัพยากรดัชนีที่การดำเนินการนี้กำลังดำเนินการ เช่น projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

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

Progress

ความคืบหน้าในเอกสารของการดำเนินการนี้
progress_bytes

Progress

ความคืบหน้า หน่วยเป็นไบต์ของการดำเนินการนี้

คำขอ ListFields

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

ช่อง
parent

string

ชื่อระดับบนสุดของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

ตัวกรองที่จะใช้กับรายการผลลัพธ์ ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายชื่อที่มีการลบล้างอย่างชัดแจ้ง หากต้องการดำเนินการค้นหานี้ โปรดโทร FirestoreAdmin.ListFields ซึ่งตั้งค่าตัวกรองเป็น indexConfig.usesAncestorConfig:false
page_size

int32

จำนวนผลลัพธ์ที่จะแสดงผล
page_token

string

โทเค็นหน้าเว็บที่ส่งคืนจากการเรียกไปยัง FirestoreAdmin.ListFields ครั้งก่อน ซึ่งอาจใช้เพื่อรับผลลัพธ์หน้าถัดไป

การตอบสนองของ ListField

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

ช่อง
fields[]

Field

ฟิลด์ที่ขอ
next_page_token

string

โทเค็นหน้าเว็บที่อาจใช้เพื่อขอหน้าผลลัพธ์อื่น หากเว้นว่างไว้ นี่คือหน้าสุดท้าย

ListIndexesRequest

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

ช่อง
parent

string

ชื่อระดับบนสุดของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

ตัวกรองที่จะใช้กับรายการผลลัพธ์
page_size

int32

จำนวนผลลัพธ์ที่จะแสดงผล
page_token

string

โทเค็นหน้าเว็บที่ส่งคืนจากการเรียกไปยัง FirestoreAdmin.ListIndexes ครั้งก่อน ซึ่งอาจใช้เพื่อรับผลลัพธ์หน้าถัดไป

ListIndexesResponse

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

ช่อง
indexes[]

Index

ดัชนีที่ขอ
next_page_token

string

โทเค็นหน้าเว็บที่อาจใช้เพื่อขอหน้าผลลัพธ์อื่น หากเว้นว่างไว้ นี่คือหน้าสุดท้าย

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

อธิบายสถานะของการดำเนินการ

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

ความคืบหน้า

อธิบายความคืบหน้าของการดำเนินการ หน่วยงานเป็นแบบทั่วไปและต้องตีความโดยอิงตามสถานที่ที่ใช้ Progress

ช่อง
estimated_work

int64

จำนวนงานโดยประมาณ
completed_work

int64

จำนวนงานที่ทำเสร็จแล้ว

อัปเดตฟิลด์คำขอ

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

ช่อง
field

Field

ช่องที่จะอัปเดต
update_mask

FieldMask

มาสก์ที่สัมพันธ์กับช่อง หากระบุ ระบบจะอัปเดตเฉพาะการกำหนดค่าที่ Field_mask นี้ระบุในช่องเท่านั้น