Package google.firestore.admin.v1beta1

ดัชนี

FirestoreAdmin

Cloud Firestore Admin API

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

แนวคิด

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

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

บริการ

ดัชนี

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

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

Metadata

ให้ข้อมูลเมตาและข้อมูลทางสถิติเกี่ยวกับข้อมูลใน 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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

ลบดัชนี

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
ExportDocuments

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

รับดัชนี

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
ImportDocuments

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
ListIndexes

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}

ImportDocumentsMetadata

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

ช่อง
start_time

Timestamp

เวลาที่งานได้เริ่มขึ้นในการดำเนินงาน
end_time

Timestamp

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

OperationState

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

Progress

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

Progress

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

string

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

string

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

ImportDocumentsRequest

คำขอสำหรับ 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 กำลังสร้างดัชนี แต่เกิดข้อผิดพลาดขึ้น ไม่มีการดำเนินการแบบระยะยาวที่ดำเนินอยู่สำหรับดัชนี และการดำเนินการที่ใช้เวลานานล่าสุดที่เสร็จสิ้นล้มเหลว ดัชนีไม่อัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่

IndexField

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

ช่อง
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

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

OperationType

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

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

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

LocationMetadata

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

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

OperationState

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

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

ความคืบหน้า

วัดความคืบหน้าของเมตริกหนึ่งๆ

ช่อง
work_completed

int64

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

int64

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