ดัชนี
FirestoreAdmin
(อินเทอร์เฟซ)Backup
(ข้อความ)Backup.State
(enum)BackupSchedule
(ข้อความ)CreateBackupScheduleRequest
(ข้อความ)CreateDatabaseMetadata
(ข้อความ)CreateDatabaseRequest
(ข้อความ)CreateIndexRequest
(ข้อความ)DailyRecurrence
(ข้อความ)Database
(ข้อความ)Database.AppEngineIntegrationMode
(enum)Database.CmekConfig
(ข้อความ)Database.ConcurrencyMode
(enum)Database.DatabaseType
(enum)Database.DeleteProtectionState
(enum)Database.PointInTimeRecoveryEnablement
(enum)DeleteBackupRequest
(ข้อความ)DeleteBackupScheduleRequest
(ข้อความ)DeleteDatabaseMetadata
(ข้อความ)DeleteDatabaseRequest
(ข้อความ)DeleteIndexRequest
(ข้อความ)ExportDocumentsMetadata
(ข้อความ)ExportDocumentsRequest
(ข้อความ)ExportDocumentsResponse
(ข้อความ)Field
(ข้อความ)Field.IndexConfig
(ข้อความ)Field.TtlConfig
(ข้อความ)Field.TtlConfig.State
(enum)FieldOperationMetadata
(ข้อความ)FieldOperationMetadata.IndexConfigDelta
(ข้อความ)FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum)FieldOperationMetadata.TtlConfigDelta
(ข้อความ)FieldOperationMetadata.TtlConfigDelta.ChangeType
(enum)GetBackupRequest
(ข้อความ)GetBackupScheduleRequest
(ข้อความ)GetDatabaseRequest
(ข้อความ)GetFieldRequest
(ข้อความ)GetIndexRequest
(ข้อความ)ImportDocumentsMetadata
(ข้อความ)ImportDocumentsRequest
(ข้อความ)Index
(ข้อความ)Index.ApiScope
(enum)Index.IndexField
(ข้อความ)Index.IndexField.ArrayConfig
(enum)Index.IndexField.Order
(enum)Index.IndexField.VectorConfig
(ข้อความ)Index.IndexField.VectorConfig.FlatIndex
(ข้อความ)Index.QueryScope
(enum)Index.State
(enum)IndexOperationMetadata
(ข้อความ)ListBackupSchedulesRequest
(ข้อความ)ListBackupSchedulesResponse
(ข้อความ)ListBackupsRequest
(ข้อความ)ListBackupsResponse
(ข้อความ)ListDatabasesRequest
(ข้อความ)ListDatabasesResponse
(ข้อความ)ListFieldsRequest
(ข้อความ)ListFieldsResponse
(ข้อความ)ListIndexesRequest
(ข้อความ)ListIndexesResponse
(ข้อความ)LocationMetadata
(ข้อความ)OperationState
(enum)Progress
(ข้อความ)RestoreDatabaseMetadata
(ข้อความ)RestoreDatabaseRequest
(ข้อความ)UpdateBackupScheduleRequest
(ข้อความ)UpdateDatabaseMetadata
(ข้อความ)UpdateDatabaseRequest
(ข้อความ)UpdateFieldRequest
(ข้อความ)WeeklyRecurrence
(ข้อความ)
ผู้ดูแลระบบ Firestore
Cloud Firestore Admin API
API นี้ให้บริการการดูแลระบบหลายอย่างสำหรับ Cloud Firestore
ระบบจะใช้โปรเจ็กต์ ฐานข้อมูล เนมสเปซ คอลเล็กชัน กลุ่มคอลเล็กชัน และเอกสารตามที่กำหนดไว้ใน API ของ Google Cloud Firestore
การดำเนินการ: การดำเนินการแสดงถึงงานที่กำลังดำเนินการอยู่เบื้องหลัง
บริการดัชนีจะจัดการดัชนี Cloud Firestore
การสร้างดัชนีดำเนินการไม่พร้อมกัน ระบบจะสร้างทรัพยากรการดำเนินการสำหรับการดำเนินการแบบไม่พร้อมกันดังกล่าวแต่ละรายการ อาจมีการค้นหาสถานะของการดำเนินการ (รวมถึงข้อผิดพลาดที่พบ) ผ่านทรัพยากรการดำเนินการ
คอลเล็กชันการดำเนินการจะแสดงบันทึกการดำเนินการที่ทำสำหรับโปรเจ็กต์ที่ระบุ (รวมถึงการดำเนินการใดๆ ที่กำลังดำเนินอยู่) ระบบจะไม่สร้างการดำเนินการโดยตรง แต่ต้องเป็นการเรียกใช้คอลเล็กชันหรือทรัพยากรอื่นๆ
การดำเนินการที่ทำไปแล้วอาจถูกลบเพื่อไม่ให้แสดงรายการเป็นส่วนหนึ่งของคอลเล็กชันการดำเนินการอีกต่อไป การดำเนินการเป็นขยะที่เก็บรวบรวมหลังจากผ่านไปแล้ว 30 วัน โดยค่าเริ่มต้น ListOperatings จะส่งคืนเฉพาะการดำเนินการที่กำลังดำเนินการและล้มเหลวเท่านั้น หากต้องการแสดงรายการการดำเนินการที่เสร็จสมบูรณ์แล้ว ให้ออกคำขอ ListOperatings โดยใช้ตัวกรอง done: true
การดำเนินการสร้างขึ้นโดยบริการ FirestoreAdmin
แต่จะเข้าถึงผ่านบริการ google.longrunning.Operations
สร้างกำหนดเวลาสำรองข้อมูล |
---|
สร้างกำหนดเวลาการสำรองข้อมูลบนฐานข้อมูล กำหนดค่ากำหนดเวลาการสำรองข้อมูลได้สูงสุด 2 รายการในฐานข้อมูล 1 กำหนดการสำหรับการสำรองข้อมูลรายวัน และ 1 สัปดาห์
|
สร้างฐานข้อมูล |
---|
สร้างฐานข้อมูล
|
สร้างดัชนี |
---|
สร้างดัชนีผสม การดำเนินการนี้จะแสดงผล
|
ลบข้อมูลสำรอง |
---|
ลบข้อมูลสำรอง
|
ลบการสำรองข้อมูลกำหนดเวลา |
---|
ลบกำหนดเวลาการสำรองข้อมูล
|
ลบฐานข้อมูล |
---|
ลบฐานข้อมูล
|
ลบดัชนี |
---|
ลบดัชนีผสม
|
ส่งออกเอกสาร |
---|
ส่งออกสำเนาเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบพื้นที่เก็บข้อมูลอื่น เช่น Google Cloud Storage การอัปเดตเอกสารล่าสุดอาจไม่แสดงในการส่งออก การส่งออกจะเกิดขึ้นในเบื้องหลัง รวมทั้งสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทรัพยากรการดำเนินการที่สร้างขึ้น เอาต์พุตของการส่งออกจะใช้ได้เฉพาะเมื่อดำเนินการที่เกี่ยวข้องเสร็จแล้วเท่านั้น หากยกเลิกการดำเนินการส่งออกก่อนดำเนินการเสร็จสิ้น การดำเนินการส่งออกอาจทิ้งข้อมูลบางส่วนไว้ใน Google Cloud Storage ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการส่งออกและรูปแบบเอาต์พุตได้ที่ https://cloud.google.com/firestore/docs/manage-data/export-import
|
รับข้อมูลสำรอง |
---|
รับข้อมูลเกี่ยวกับข้อมูลสำรอง
|
GetBackupSchedule |
---|
รับข้อมูลเกี่ยวกับกำหนดเวลาการสำรองข้อมูล
|
รับฐานข้อมูล |
---|
รับข้อมูลเกี่ยวกับฐานข้อมูล
|
รับฟิลด์ |
---|
รับข้อมูลเมตาและการกำหนดค่าสำหรับช่อง
|
GetIndex |
---|
รับดัชนีผสม
|
นำเข้าเอกสาร |
---|
นำเข้าเอกสารไปยัง Google Cloud Firestore ระบบจะเขียนทับเอกสารที่มีอยู่แล้วซึ่งมีชื่อเดียวกัน การนำเข้าจะเกิดขึ้นในเบื้องหลัง รวมทั้งสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทรัพยากรการดำเนินการที่สร้างขึ้น หากยกเลิกการดำเนินการ ImportDocuments อาจเป็นไปได้ว่ามีการนำเข้าข้อมูลชุดย่อยไปยัง Cloud Firestore แล้ว
|
แสดงรายการ BackupSchedules |
---|
แสดงรายการกำหนดเวลาการสำรองข้อมูล
|
แสดงรายการข้อมูลสำรอง |
---|
แสดงรายการข้อมูลสำรองทั้งหมด
|
แสดงรายการฐานข้อมูล |
---|
แสดงรายการฐานข้อมูลทั้งหมดในโปรเจ็กต์
|
ฟิลด์รายการ |
---|
แสดงรายการการกำหนดค่าช่องและข้อมูลเมตาสำหรับฐานข้อมูลนี้ ขณะนี้
|
รายการดัชนี |
---|
แสดงรายการดัชนีผสม
|
กู้คืนฐานข้อมูล |
---|
สร้างฐานข้อมูลใหม่โดยการคืนค่าจากข้อมูลสำรองที่มีอยู่ ฐานข้อมูลใหม่ต้องอยู่ในภูมิภาคระบบคลาวด์หรือตำแหน่งที่ตั้งหลายภูมิภาคเดียวกันกับข้อมูลสำรองที่มีอยู่ การดำเนินการนี้มีลักษณะการทำงานที่คล้ายกับ [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] ยกเว้นการสร้างฐานข้อมูลใหม่ที่ว่างเปล่า ระบบจะสร้างฐานข้อมูลใหม่ด้วยประเภทฐานข้อมูล การกําหนดค่าดัชนี และเอกสารจากข้อมูลสำรองที่มีอยู่ ใช้
|
อัปเดตกำหนดเวลาสำรองข้อมูล |
---|
อัปเดตกำหนดเวลาการสำรองข้อมูล
|
อัปเดตฐานข้อมูล |
---|
อัปเดตฐานข้อมูล
|
อัปเดตฟิลด์ |
---|
อัปเดตการกำหนดค่าช่อง ปัจจุบันการอัปเดตช่องจะใช้กับการกำหนดค่าดัชนีช่องเดียวเท่านั้น อย่างไรก็ตาม การเรียกใช้ไปยัง การเรียกนี้จะแสดง ในการกำหนดการตั้งค่าฟิลด์เริ่มต้นสำหรับฐานข้อมูล ให้ใช้
|
แหล่งข้อมูลสำรอง
ข้อมูลสำรองของฐานข้อมูล Cloud Firestore
ข้อมูลสำรองจะมีเอกสารและการกำหนดค่าดัชนีทั้งหมดสำหรับฐานข้อมูลที่ระบุในช่วงเวลาหนึ่งๆ
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ชื่อทรัพยากรที่ไม่ซ้ำกันของข้อมูลสำรอง รูปแบบคือ |
database |
เอาต์พุตเท่านั้น ชื่อฐานข้อมูล Firestore ที่เป็นต้นทางของข้อมูลสำรอง รูปแบบคือ |
database_uid |
เอาต์พุตเท่านั้น UUID4 ที่ระบบสร้างขึ้นสำหรับฐานข้อมูล Firestore ที่เป็นต้นทางของข้อมูลสำรอง |
snapshot_time |
เอาต์พุตเท่านั้น ข้อมูลสำรองมีสำเนาฐานข้อมูลที่สอดคล้องกันภายนอกในขณะนี้ |
expire_time |
เอาต์พุตเท่านั้น การประทับเวลาที่ข้อมูลสำรองนี้หมดอายุ |
state |
เอาต์พุตเท่านั้น สถานะปัจจุบันของข้อมูลสำรอง |
รัฐ
ระบุสถานะปัจจุบันของข้อมูลสำรอง
Enum | |
---|---|
STATE_UNSPECIFIED |
ไม่ได้ระบุรัฐ |
CREATING |
กำลังสร้างข้อมูลสำรองที่รอดำเนินการอยู่ ระบบจะปฏิเสธการดำเนินการในข้อมูลสำรองในสถานะนี้ |
READY |
ข้อมูลสำรองเสร็จสมบูรณ์และพร้อมใช้งานแล้ว |
NOT_AVAILABLE |
การสำรองข้อมูลไม่พร้อมใช้งานในขณะนี้ |
กำหนดเวลาสำรองข้อมูล
กำหนดการสำรองสำหรับฐานข้อมูล Cloud Firestore
ทรัพยากรนี้เป็นของฐานข้อมูลที่สำรองข้อมูลอยู่ และถูกลบไปพร้อมกับฐานข้อมูลแล้ว แต่ข้อมูลสำรองจริงกลับไม่ใช่
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ตัวระบุกำหนดเวลาการสำรองข้อมูลที่ไม่ซ้ำกันในตำแหน่งและฐานข้อมูลทั้งหมดสำหรับโปรเจ็กต์ที่ระบุ ซึ่งระบบจะกำหนดให้โดยอัตโนมัติ รูปแบบคือ |
create_time |
เอาต์พุตเท่านั้น การประทับเวลาที่สร้างกำหนดเวลาการสำรองข้อมูลและมีผลตั้งแต่นั้น ระบบจะไม่สร้างข้อมูลสำรองสำหรับกำหนดการนี้ก่อนเวลาดังกล่าว |
update_time |
เอาต์พุตเท่านั้น การประทับเวลาที่กำหนดเวลาสำรองข้อมูลนี้ได้รับการอัปเดตล่าสุด เมื่อสร้างกําหนดการสํารองข้อมูลเป็นครั้งแรก ซึ่งจะเหมือนกับ create_time |
retention |
ในช่วงเวลาที่เกี่ยวข้องในอนาคต เมื่อเทียบกับเวลาที่สร้าง ควรลบข้อมูลสำรอง เช่น เก็บข้อมูลสำรองไว้ 7 วัน |
ฟิลด์สหภาพ recurrence ช่องใดช่องหนึ่งเพื่อแสดงว่าจะมีการสำรองข้อมูลเมื่อใด recurrence ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
daily_recurrence |
สำหรับกำหนดการที่ทำงานทุกวัน |
weekly_recurrence |
สำหรับกำหนดการที่ทำงานทุกสัปดาห์ในวันที่ระบุ |
CreateBackupScheduleRequest
คำขอสำหรับ FirestoreAdmin.CreateBackupSchedule
ช่อง | |
---|---|
parent |
ต้องระบุ ฐานข้อมูลหลัก รูปแบบ |
backup_schedule |
ต้องระบุ กำหนดการสำรองข้อมูลที่จะสร้าง |
สร้างข้อมูลเมตา
ประเภทนี้ไม่มีช่อง
ข้อมูลเมตาที่เกี่ยวข้องกับการดำเนินการสร้างฐานข้อมูล
สร้างคำขอฐานข้อมูล
คำขอสำหรับ FirestoreAdmin.CreateDatabase
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อหลักของแบบฟอร์ม |
database |
ต้องระบุ ฐานข้อมูลที่จะสร้าง |
database_id |
ต้องระบุ รหัสที่จะใช้สำหรับฐานข้อมูล ซึ่งจะกลายเป็นองค์ประกอบสุดท้ายของชื่อทรัพยากรของฐานข้อมูล ค่านี้ควรมีความยาว 4-63 อักขระ อักขระที่ถูกต้องคือ /[a-z][0-9]-/ โดยมีอักขระตัวแรกและมีอักขระตัวสุดท้ายหรือตัวเลข ต้องไม่เหมือน UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ รหัสฐานข้อมูล "(ค่าเริ่มต้น)" ก็ถูกต้องเช่นกัน |
CreateIndexRequest
คำขอสำหรับ FirestoreAdmin.CreateIndex
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อหลักของแบบฟอร์ม |
index |
ต้องระบุ ดัชนีผสมที่จะสร้าง |
การเกิดซ้ำรายวัน
ประเภทนี้ไม่มีช่อง
แสดงกำหนดการที่เกิดซ้ำซึ่งทำงานทุกวัน
เขตเวลาคือ UTC
ฐานข้อมูล
ฐานข้อมูล Cloud Firestore
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของฐานข้อมูล รูปแบบ: |
uid |
เอาต์พุตเท่านั้น UUID4 ที่ระบบสร้างสำหรับฐานข้อมูลนี้ |
create_time |
เอาต์พุตเท่านั้น การประทับเวลาที่สร้างฐานข้อมูลนี้ ฐานข้อมูลที่สร้างขึ้นก่อนปี 2016 จะไม่มีข้อมูล create_time |
update_time |
เอาต์พุตเท่านั้น การประทับเวลาที่ฐานข้อมูลนี้ได้รับการอัปเดตล่าสุด โปรดทราบว่าจะรวมการอัปเดตทรัพยากรฐานข้อมูลเท่านั้น โดยไม่รวมข้อมูลที่อยู่ในฐานข้อมูล |
location_id |
ตำแหน่งของฐานข้อมูล ดูตำแหน่งที่พร้อมใช้งานได้ที่ https://cloud.google.com/firestore/docs/locations |
type |
ประเภทของฐานข้อมูล โปรดดูวิธีเลือกที่ https://cloud.google.com/datastore/docs/firestore-or-datastore |
concurrency_mode |
โหมดควบคุมการเกิดขึ้นพร้อมกันที่จะใช้กับฐานข้อมูลนี้ |
version_retention_period |
เอาต์พุตเท่านั้น ระยะเวลาในระหว่างที่มีการเก็บรักษาข้อมูลเวอร์ชันในอดีตไว้ในฐานข้อมูล
หากเปิดใช้ฟีเจอร์ PITR ระยะเวลาเก็บรักษาจะอยู่ที่ 7 วัน มิเช่นนั้น ระยะเวลาเก็บรักษาจะอยู่ที่ 1 ชั่วโมง |
earliest_version_time |
เอาต์พุตเท่านั้น การประทับเวลาเร็วที่สุดที่อ่านข้อมูลเวอร์ชันเก่าได้จากฐานข้อมูล ดู [version_retention_period] ด้านบน ช่องนี้ป้อนข้อมูลด้วย ค่านี้จะอัปเดตอย่างต่อเนื่อง และจะล้าสมัยเมื่อทำการค้นหา หากคุณใช้ค่านี้เพื่อกู้คืนข้อมูล โปรดคำนึงถึงช่วงเวลานับตั้งแต่เวลาที่ค้นหาค่าจนถึงเวลาที่เริ่มการกู้คืน |
point_in_time_recovery_enablement |
เลือกว่าจะเปิดใช้ฟีเจอร์ PITR บนฐานข้อมูลนี้หรือไม่ |
app_engine_integration_mode |
โหมดการผสานรวม App Engine ที่จะใช้สำหรับฐานข้อมูลนี้ |
key_prefix |
เอาต์พุตเท่านั้น key_prefix สำหรับฐานข้อมูลนี้ key_prefix นี้ใช้ร่วมกับรหัสโปรเจ็กต์ (" ค่านี้อาจว่างเปล่าในกรณีที่แอปที่จะใช้สำหรับคีย์ที่เข้ารหัส URL คือ project_id (เช่น: foo แทน v~foo) |
delete_protection_state |
สถานะการป้องกันการลบฐานข้อมูล |
cmek_config |
ไม่บังคับ การมีอยู่ระบุว่ามีการเปิดใช้ CMEK สำหรับฐานข้อมูลนี้ |
etag |
Checksum นี้จะคำนวณโดยเซิร์ฟเวอร์ตามค่าของช่องอื่นๆ และอาจส่งไปในคำขอการอัปเดตและลบเพื่อให้มั่นใจว่าไคลเอ็นต์มีค่าที่เป็นปัจจุบันก่อนที่จะดำเนินการต่อ |
AppEngineIntegrationMode
ประเภทของโหมดการผสานรวม App Engine
Enum | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED |
ไม่ได้ใช้ |
ENABLED |
หากมีแอปพลิเคชัน App Engine อยู่ในภูมิภาคเดียวกับฐานข้อมูลนี้ การกำหนดค่า App Engine จะส่งผลกระทบต่อฐานข้อมูลนี้ ซึ่งรวมถึงการปิดใช้แอปพลิเคชันและฐานข้อมูล รวมถึงการปิดใช้การเขียนไปยังฐานข้อมูล |
DISABLED |
App Engine ไม่มีผลต่อความสามารถของฐานข้อมูลนี้ในการให้บริการคำขอ นี่คือการตั้งค่าเริ่มต้นสำหรับฐานข้อมูลที่สร้างด้วย Firestore API |
การกำหนดค่า
การกำหนดค่า CMEK (คีย์การเข้ารหัสที่จัดการโดยลูกค้า) สำหรับฐานข้อมูล Firestore หากไม่มี แสดงว่าฐานข้อมูลได้รับการรักษาความปลอดภัยโดยคีย์การเข้ารหัสของ Google เริ่มต้น
ช่อง | |
---|---|
kms_key_name |
ต้องระบุ อนุญาตให้ใช้คีย์ในตำแหน่งเดียวกับฐานข้อมูลนี้เท่านั้นในการเข้ารหัส สำหรับ nam5 หลายภูมิภาคของ Firestore เหตุการณ์นี้สอดคล้องกับ Cloud KMS แบบหลายภูมิภาคกับเรา สำหรับ eur3 หลายภูมิภาคของ Firestore จำนวนนี้สอดคล้องกับ Cloud KMS ในยุโรปหลายภูมิภาค โปรดดูที่ https://cloud.google.com/kms/docs/locations รูปแบบที่คาดไว้คือ |
active_key_version[] |
เอาต์พุตเท่านั้น เวอร์ชันคีย์ KMS ที่ใช้งานอยู่ ในระหว่างการหมุนเวียนคีย์ จะมีเวอร์ชันคีย์ที่ใช้งานอยู่ได้หลายเวอร์ชัน รูปแบบที่คาดไว้คือ |
โหมดการเกิดขึ้นพร้อมกัน
ประเภทของโหมดควบคุมการเกิดขึ้นพร้อมกันสำหรับธุรกรรม
Enum | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED |
ไม่ได้ใช้ |
OPTIMISTIC |
ใช้การควบคุมการเกิดขึ้นพร้อมกันในเชิงบวกโดยค่าเริ่มต้น โหมดนี้ใช้ได้กับฐานข้อมูล Cloud Firestore |
PESSIMISTIC |
ใช้การควบคุมการเกิดขึ้นพร้อมกันที่ส่งผลเสียโดยค่าเริ่มต้น โหมดนี้ใช้ได้กับฐานข้อมูล Cloud Firestore นี่เป็นการตั้งค่าเริ่มต้นสำหรับ Cloud Firestore |
OPTIMISTIC_WITH_ENTITY_GROUPS |
ใช้การควบคุมการเกิดขึ้นพร้อมกันอย่างมีประสิทธิภาพกับกลุ่มเอนทิตีโดยค่าเริ่มต้น นี่คือโหมดเดียวที่ใช้ได้กับ Cloud Datastore โหมดนี้ใช้ได้กับ Cloud Firestore ที่มีโหมด Datastore ด้วย แต่เราไม่แนะนำให้ทำ |
ประเภทฐานข้อมูล
ประเภทของฐานข้อมูล โปรดดูวิธีเลือกที่ https://cloud.google.com/datastore/docs/firestore-or-datastore
อนุญาตให้เปลี่ยนแปลงโหมดเมื่อฐานข้อมูลว่างเปล่าเท่านั้น
Enum | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
ค่าเริ่มต้น ระบบจะใช้ค่านี้หากไม่ระบุประเภทฐานข้อมูล |
FIRESTORE_NATIVE |
โหมดดั้งเดิมของ Firestore |
DATASTORE_MODE |
Firestore ในโหมด Datastore |
สถานะ DeleteProtection
สถานะการป้องกันการลบฐานข้อมูล
Enum | |
---|---|
DELETE_PROTECTION_STATE_UNSPECIFIED |
ค่าเริ่มต้น ไม่ได้ระบุประเภทการป้องกันการลบ |
DELETE_PROTECTION_DISABLED |
การป้องกันการลบปิดอยู่ |
DELETE_PROTECTION_ENABLED |
การป้องกันการลบเปิดใช้อยู่ |
การเปิดใช้ PointInTimeRecovery
เปิดใช้ฟีเจอร์การกู้คืนช่วงเวลา
Enum | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED |
ไม่ได้ใช้ |
POINT_IN_TIME_RECOVERY_ENABLED |
ระบบรองรับการอ่านในข้อมูลเวอร์ชันที่เลือกจากภายใน 7 วันที่ผ่านมา ดังนี้
ใช้ |
POINT_IN_TIME_RECOVERY_DISABLED |
และรองรับการอ่านในข้อมูลเวอร์ชันใดก็ได้ภายใน 1 ชั่วโมงที่ผ่านมา |
ลบคำขอสำรองข้อมูล
คำขอสำหรับ FirestoreAdmin.DeleteBackup
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของข้อมูลสำรองที่จะลบ รูปแบบคือ |
ลบการสำรองข้อมูลกำหนดเวลาคำขอ
คำขอสำหรับ [FirestoreAdmin.DeletebackupSchedules][]
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของกำหนดการสำรองข้อมูล รูปแบบ |
ลบข้อมูลเมตา
ประเภทนี้ไม่มีช่อง
ข้อมูลเมตาที่เกี่ยวข้องกับการดำเนินการลบฐานข้อมูล
ลบคำขอฐานข้อมูล
คำขอสำหรับ FirestoreAdmin.DeleteDatabase
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของแบบฟอร์ม |
etag |
แท็กปัจจุบันของฐานข้อมูล หากมีการระบุ eTag และไม่ตรงกับ eTag ปัจจุบันของฐานข้อมูล ระบบจะบล็อกการลบและจะแสดงข้อผิดพลาด FAILED_PRETERMS |
ลบคำขอดัชนี
คำขอสำหรับ FirestoreAdmin.DeleteIndex
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของแบบฟอร์ม |
ExportDocumentsMetadata
ข้อมูลเมตาสำหรับผลลัพธ์ google.longrunning.Operation
รายการจาก FirestoreAdmin.ExportDocuments
ช่อง | |
---|---|
start_time |
เวลาที่การดำเนินการนี้เริ่มต้น |
end_time |
เวลาที่การดำเนินการนี้เสร็จสมบูรณ์ ระบบจะยกเลิกการตั้งค่าหากยังดำเนินการอยู่ |
operation_state |
สถานะของการดำเนินการส่งออก |
progress_documents |
ความคืบหน้าในเอกสารของการดำเนินการนี้ |
progress_bytes |
ความคืบหน้าในหน่วยไบต์ของการดำเนินการนี้ |
collection_ids[] |
รหัสคอลเล็กชันที่กำลังส่งออก |
output_uri_prefix |
ตำแหน่งที่จะส่งออกเอกสาร |
namespace_ids[] |
รหัสเนมสเปซที่กำลังส่งออก |
snapshot_time |
การประทับเวลาที่สอดคล้องกับเวอร์ชันของฐานข้อมูลที่กำลังส่งออก หากไม่ระบุ จะไม่มีการรับประกันความสอดคล้องของเอกสารที่ส่งออก |
ExportDocumentsRequest
คำขอสำหรับ FirestoreAdmin.ExportDocuments
ช่อง | |
---|---|
name |
ต้องระบุ ฐานข้อมูลที่จะส่งออก ควรอยู่ในรูปแบบ |
collection_ids[] |
รหัสคอลเล็กชันที่จะส่งออก ไม่ระบุ หมายถึงคอลเล็กชันทั้งหมด |
output_uri_prefix |
URI เอาต์พุต ขณะนี้รองรับเฉพาะ URI ของ Google Cloud Storage ในรูปแบบ |
namespace_ids[] |
รายการที่ว่างเปล่าจะแสดงเนมสเปซทั้งหมด วิธีนี้เหมาะสำหรับใช้ฐานข้อมูลที่ไม่ใช้เนมสเปซ องค์ประกอบสตริงว่างจะแสดงเนมสเปซเริ่มต้น ควรใช้แอตทริบิวต์นี้หากฐานข้อมูลมีข้อมูลในเนมสเปซที่ไม่ใช่ค่าเริ่มต้น แต่ไม่ต้องการรวมข้อมูลดังกล่าว เนมสเปซแต่ละรายการในรายการนี้ต้องไม่ซ้ำกัน |
snapshot_time |
การประทับเวลาที่สอดคล้องกับเวอร์ชันของฐานข้อมูลที่จะส่งออก การประทับเวลาต้องอยู่ในอดีต โดยปัดเศษเป็นนาทีและไม่เกิน |
ExportDocumentsResponse
แสดงผลในช่องคำตอบ google.longrunning.Operation
ช่อง | |
---|---|
output_uri_prefix |
ตำแหน่งของไฟล์เอาต์พุต ซึ่งอาจใช้เพื่อเริ่มการนำเข้าไปยัง Cloud Firestore (โปรเจ็กต์นี้หรือโปรเจ็กต์อื่น) หลังจากที่การดำเนินการเสร็จสมบูรณ์ได้ |
ฟิลด์
แสดงฟิลด์เดียวในฐานข้อมูล
ระบบจะจัดกลุ่มช่องตาม "กลุ่มคอลเล็กชัน" ซึ่งแสดงคอลเล็กชันทั้งหมดในฐานข้อมูลที่มีรหัสเดียวกัน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อช่องของแบบฟอร์ม เส้นทางของฟิลด์อาจเป็นชื่อฟิลด์ง่ายๆ เช่น คุณยกเส้นทางช่องได้โดยใช้ ตัวอย่าง: (หมายเหตุ: ความคิดเห็นจะเขียนด้วยไวยากรณ์มาร์กดาวน์ จึงมีเครื่องหมายแบ็กทิกอีกชั้นหนึ่งขึ้นมาแทนโค้ดบล็อก)
|
index_config |
การกำหนดค่าดัชนีสำหรับช่องนี้ หากไม่ได้ตั้งค่า การจัดทำดัชนีของช่องจะเปลี่ยนกลับไปเป็นการกำหนดค่าที่กำหนดโดย |
ttl_config |
การกำหนดค่า TTL สำหรับ |
IndexConfig
การกำหนดค่าดัชนีสำหรับช่องนี้
ช่อง | |
---|---|
indexes[] |
ดัชนีที่รองรับในช่องนี้ |
uses_ancestor_config |
เอาต์พุตเท่านั้น เมื่อเป็นจริง ระบบจะกำหนดค่าดัชนีของ |
ancestor_field |
เอาต์พุตเท่านั้น ระบุชื่อทรัพยากรของ |
reverting |
เอาต์พุตเท่านั้น เมื่อเป็นจริง การกำหนดค่าดัชนีของ |
TtlConfig
การกำหนดค่า TTL (Time-to-live) สำหรับเอกสารที่มีการตั้งค่า Field
นี้
การจัดเก็บค่าการประทับเวลาลงในช่องที่เปิดใช้ TTL จะถือว่าเป็นเวลาหมดอายุสัมบูรณ์ของเอกสาร ค่าการประทับเวลาในอดีตบ่งบอกว่าเอกสารมีสิทธิ์หมดอายุทันที การใช้ข้อมูลประเภทอื่นๆ หรือการไม่ระบุฟิลด์จะปิดใช้การหมดอายุของเอกสารแต่ละรายการ
ช่อง | |
---|---|
state |
เอาต์พุตเท่านั้น สถานะของการกำหนดค่า TTL |
รัฐ
สถานะการใช้การกำหนดค่า TTL กับเอกสารทั้งหมด
Enum | |
---|---|
STATE_UNSPECIFIED |
ไม่ระบุรัฐหรือไม่ทราบ |
CREATING |
กำลังใช้ TTL มีการดำเนินการที่ทำงานเป็นเวลานานเพื่อติดตามการเปลี่ยนแปลง เอกสารที่เขียนใหม่จะใช้ TTL ตามคำขอ TTL ที่ขอในเอกสารที่มีอยู่ยังอยู่ระหว่างการประมวลผล เมื่อประมวลผล TTL ในเอกสารที่มีอยู่ทั้งหมด สถานะจะเปลี่ยนเป็น "ใช้งานอยู่" |
ACTIVE |
TTL จะใช้กับเอกสารทั้งหมด |
NEEDS_REPAIR |
ไม่สามารถเปิดใช้การกำหนดค่า TTL สำหรับเอกสารที่มีอยู่ทั้งหมด เอกสารที่เขียนใหม่จะใช้ TTL ต่อไป LRO ที่ส่งคืนเมื่อพยายามเปิดใช้ TTL สำหรับ Field นี้ครั้งล่าสุดไม่สำเร็จ และอาจมีรายละเอียดเพิ่มเติม |
ข้อมูลเมตาการดำเนินการภาคสนาม
ข้อมูลเมตาสำหรับผลลัพธ์ google.longrunning.Operation
รายการจาก FirestoreAdmin.UpdateField
ช่อง | |
---|---|
start_time |
เวลาที่การดำเนินการนี้เริ่มต้น |
end_time |
เวลาที่การดำเนินการนี้เสร็จสมบูรณ์ ระบบจะยกเลิกการตั้งค่าหากยังดำเนินการอยู่ |
field |
ทรัพยากรฟิลด์ที่การดำเนินการนี้ดำเนินการ ตัวอย่าง: |
index_config_deltas[] |
รายการของ |
state |
สถานะของการดำเนินการ |
progress_documents |
ความคืบหน้าในเอกสารของการดำเนินการนี้ |
progress_bytes |
ความคืบหน้าในหน่วยไบต์ของการดำเนินการนี้ |
ttl_config_delta |
อธิบายเดลต้าของการกำหนดค่า TTL |
IndexConfigDelta
ข้อมูลเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่าดัชนี
ช่อง | |
---|---|
change_type |
ระบุการเปลี่ยนแปลงของดัชนี |
index |
ดัชนีที่เปลี่ยนแปลง |
ประเภทการเปลี่ยนแปลง
ระบุการเปลี่ยนแปลงของดัชนี
Enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
ไม่ได้ระบุหรือไม่ทราบประเภทของการเปลี่ยนแปลง |
ADD |
กำลังเพิ่มดัชนีช่องเดี่ยว |
REMOVE |
เรากำลังนำดัชนีช่องเดียวออก |
TtlConfigDelta
ข้อมูลเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่า TTL
ช่อง | |
---|---|
change_type |
ระบุการเปลี่ยนแปลงการกำหนดค่า TTL |
ประเภทการเปลี่ยนแปลง
ระบุการเปลี่ยนแปลงการกำหนดค่า TTL
Enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
ไม่ได้ระบุหรือไม่ทราบประเภทของการเปลี่ยนแปลง |
ADD |
กำลังเพิ่มการกำหนดค่า TTL |
REMOVE |
กำลังนำการกำหนดค่า TTL ออก |
GetBackupRequest
คำขอสำหรับ FirestoreAdmin.GetBackup
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของข้อมูลสำรองที่จะดึงข้อมูล รูปแบบคือ |
GetBackupScheduleRequest
คำขอสำหรับ FirestoreAdmin.GetBackupSchedule
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของกำหนดการสำรองข้อมูล รูปแบบ |
GetDatabaseRequest
คำขอสำหรับ FirestoreAdmin.GetDatabase
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของแบบฟอร์ม |
ส่งคำขอฟิลด์
คำขอสำหรับ FirestoreAdmin.GetField
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของแบบฟอร์ม |
GetIndexRequest
คำขอสำหรับ FirestoreAdmin.GetIndex
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของแบบฟอร์ม |
นำเข้าเอกสารข้อมูลเมตา
ข้อมูลเมตาสำหรับผลลัพธ์ google.longrunning.Operation
รายการจาก FirestoreAdmin.ImportDocuments
ช่อง | |
---|---|
start_time |
เวลาที่การดำเนินการนี้เริ่มต้น |
end_time |
เวลาที่การดำเนินการนี้เสร็จสมบูรณ์ ระบบจะยกเลิกการตั้งค่าหากยังดำเนินการอยู่ |
operation_state |
สถานะของการดำเนินการนำเข้า |
progress_documents |
ความคืบหน้าในเอกสารของการดำเนินการนี้ |
progress_bytes |
ความคืบหน้าในหน่วยไบต์ของการดำเนินการนี้ |
collection_ids[] |
รหัสคอลเล็กชันที่กำลังนำเข้า |
input_uri_prefix |
ตำแหน่งของเอกสารที่จะนำเข้า |
namespace_ids[] |
รหัสเนมสเปซที่กำลังนำเข้า |
คำขอนำเข้าเอกสาร
คำขอสำหรับ FirestoreAdmin.ImportDocuments
ช่อง | |
---|---|
name |
ต้องระบุ ฐานข้อมูลที่จะนำเข้า ควรอยู่ในรูปแบบ |
collection_ids[] |
รหัสคอลเล็กชันที่จะนำเข้า ไม่ระบุ หมายถึงคอลเล็กชันทั้งหมดที่รวมอยู่ในการนำเข้า |
input_uri_prefix |
ตำแหน่งของไฟล์ที่ส่งออก ค่านี้ต้องตรงกับ export_uri_prefix ของ ExportDocumentsResponse จากการส่งออกที่เสร็จสมบูรณ์ โปรดดู |
namespace_ids[] |
รายการที่ว่างเปล่าจะแสดงเนมสเปซทั้งหมด วิธีนี้เหมาะสำหรับใช้ฐานข้อมูลที่ไม่ใช้เนมสเปซ องค์ประกอบสตริงว่างจะแสดงเนมสเปซเริ่มต้น ควรใช้แอตทริบิวต์นี้หากฐานข้อมูลมีข้อมูลในเนมสเปซที่ไม่ใช่ค่าเริ่มต้น แต่ไม่ต้องการรวมข้อมูลดังกล่าว เนมสเปซแต่ละรายการในรายการนี้ต้องไม่ซ้ำกัน |
ดัชนี
ดัชนี Cloud Firestore เปิดใช้การค้นหาที่เรียบง่ายและซับซ้อนในเอกสารในฐานข้อมูล
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ชื่อที่เซิร์ฟเวอร์กำหนดสำหรับดัชนีนี้ รูปแบบของชื่อนี้สำหรับดัชนีผสมจะเป็น: |
query_scope |
ดัชนีที่มีขอบเขตการค้นหาคอลเล็กชันจะอนุญาตการค้นหากับคอลเล็กชันซึ่งเป็นรายการย่อยของเอกสารที่ระบุ ณ เวลาค้นหา และมีรหัสคอลเล็กชันเดียวกัน ดัชนีที่มีขอบเขตการค้นหากลุ่มคอลเล็กชันระบุไว้จะอนุญาตการค้นหากับคอลเล็กชันทั้งหมดที่สืบทอดมาจากเอกสารเฉพาะ ซึ่งระบุ ณ เวลาค้นหา และมีรหัสคอลเล็กชันเดียวกับดัชนีนี้ |
api_scope |
ขอบเขต API ที่ดัชนีนี้รองรับ |
fields[] |
ช่องที่ดัชนีนี้รองรับ สำหรับดัชนีผสม จะต้องมีช่องอย่างน้อย 2 ช่องและสูงสุด 100 ช่อง รายการช่องสุดท้ายจะเป็นรายการสำหรับเส้นทางช่อง สำหรับดัชนีช่องเดียว รายการนี้จะเป็น 1 รายการที่มีเส้นทางฟิลด์เท่ากับเส้นทางช่องของช่องที่เกี่ยวข้องเสมอ |
state |
เอาต์พุตเท่านั้น สถานะการแสดงผลของดัชนี |
ขอบเขต API
ขอบเขต API กำหนด API (Firestore แบบเนทีฟหรือ Firestore ในโหมด Datastore) ที่รองรับสำหรับการค้นหา
Enum | |
---|---|
ANY_API |
ดัชนีจะใช้ได้เฉพาะใน Firestore Native Query API เท่านั้น โดยตัวเลือกนี้คือค่าเริ่มต้น |
DATASTORE_MODE_API |
ใช้ดัชนีได้โดย Firestore ใน API คำค้นหาโหมด Datastore เท่านั้น |
ฟิลด์ดัชนี
ฟิลด์ในดัชนี
ช่อง | |
---|---|
field_path |
อาจเป็น name สำหรับดัชนีช่องเดี่ยว ค่านี้ต้องตรงกับชื่อช่อง มิฉะนั้นระบบอาจละเว้น |
ฟิลด์สหภาพ value_mode วิธีจัดทำดัชนีค่าในช่อง value_mode ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
order |
ระบุว่าช่องนี้รองรับการเรียงลำดับตามที่ระบุ หรือเปรียบเทียบโดยใช้ =, !=, <, <=, >, >= |
array_config |
ระบุว่าช่องนี้รองรับการดำเนินการใน |
vector_config |
ระบุว่าฟิลด์นี้รองรับการดำเนินการใกล้เคียงและระยะทางที่ใกล้ที่สุดในเวกเตอร์ |
ArrayConfig
การกำหนดค่าอาร์เรย์ที่รองรับ
Enum | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
ดัชนีไม่รองรับการค้นหาอาร์เรย์เพิ่มเติม |
CONTAINS |
ดัชนีรองรับการค้นหาที่มีอาร์เรย์ |
ออเดอร์
ลำดับที่รองรับ
Enum | |
---|---|
ORDER_UNSPECIFIED |
ไม่ได้ระบุลำดับ ไม่ใช่ตัวเลือกที่ถูกต้อง |
ASCENDING |
ระบบจะเรียงลำดับช่องนี้ตามค่าจากน้อยไปมาก |
DESCENDING |
ระบบจะเรียงลำดับช่องนี้ตามค่าของช่องจากมากไปน้อย |
VectorConfig
การกำหนดค่าดัชนีเพื่อสนับสนุนการดำเนินการค้นหาเวกเตอร์
ช่อง | |
---|---|
dimension |
ต้องระบุ มิติข้อมูลเวกเตอร์ที่ใช้การกำหนดค่านี้ ดัชนีที่ได้จะรวมเฉพาะเวกเตอร์ของมิติข้อมูลนี้เท่านั้น และสามารถใช้สำหรับการค้นหาเวกเตอร์ที่มีมิติข้อมูลเดียวกันได้ |
ฟิลด์สหภาพ type ประเภทดัชนีที่ใช้ type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
flat |
บ่งบอกว่าดัชนีเวกเตอร์เป็นดัชนีค่าคงที่ |
ดัชนีค่าเดี่ยว
ประเภทนี้ไม่มีช่อง
ดัชนีที่จัดเก็บเวกเตอร์ในโครงสร้างข้อมูลแบบแฟลต และรองรับการค้นหาอย่างละเอียด
ขอบเขตการค้นหา
ขอบเขตการค้นหาจะกำหนดขอบเขตที่เรียกใช้การค้นหา ซึ่งระบุในช่อง from
ของ StructuredQuery
Enum | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
ไม่ได้ระบุขอบเขตการค้นหา ไม่ใช่ตัวเลือกที่ถูกต้อง |
COLLECTION |
ดัชนีที่มีขอบเขตการค้นหาคอลเล็กชันที่ระบุจะอนุญาตการค้นหากับคอลเล็กชันซึ่งเป็นรายการย่อยของเอกสารที่ระบุ ณ เวลาค้นหา และมีรหัสคอลเล็กชันที่ระบุโดยดัชนี |
COLLECTION_GROUP |
ดัชนีที่มีขอบเขตการค้นหากลุ่มคอลเล็กชันระบุไว้จะอนุญาตการค้นหากับคอลเล็กชันทั้งหมดที่มีรหัสคอลเล็กชันที่ระบุโดยดัชนี |
COLLECTION_RECURSIVE |
รวมระดับบนของคอลเล็กชันทั้งหมดในดัชนี ใช้ได้กับฐานข้อมูลโหมด Datastore เท่านั้น |
รัฐ
สถานะของดัชนี ในระหว่างการสร้างดัชนี ดัชนีจะอยู่ในสถานะ CREATING
หากสร้างดัชนีเรียบร้อยแล้ว ดัชนีจะเปลี่ยนเป็นสถานะ READY
หากการสร้างดัชนีพบปัญหา ดัชนีจะเปลี่ยนเป็นสถานะ NEEDS_REPAIR
Enum | |
---|---|
STATE_UNSPECIFIED |
ไม่ได้ระบุรัฐ |
CREATING |
กำลังสร้างดัชนี มีการดำเนินการที่ใช้เวลานานสำหรับดัชนีที่ใช้งานอยู่ ดัชนีจะมีการอัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่ |
READY |
ดัชนีพร้อมใช้งานแล้ว ดัชนีจะมีการอัปเดตเมื่อเขียนเอกสาร ระบบจะป้อนข้อมูลดัชนีทั้งหมดจากเอกสารที่จัดเก็บทั้งหมดที่ใช้ |
NEEDS_REPAIR |
กำลังสร้างดัชนี แต่เกิดข้อผิดพลาดขึ้น ไม่มีการดำเนินการแบบระยะยาวที่ดำเนินอยู่สำหรับดัชนี และการดำเนินการที่ใช้เวลานานล่าสุดที่เสร็จสิ้นล้มเหลว ดัชนีไม่อัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่ ใช้ google.longrunning.Executs API เพื่อหาสาเหตุที่การดำเนินการที่พยายามสร้างดัชนีนี้ล้มเหลวครั้งล่าสุด จากนั้นจึงสร้างดัชนีอีกครั้ง |
IndexOperatingMetadata
ข้อมูลเมตาสำหรับผลลัพธ์ google.longrunning.Operation
รายการจาก FirestoreAdmin.CreateIndex
ช่อง | |
---|---|
start_time |
เวลาที่การดำเนินการนี้เริ่มต้น |
end_time |
เวลาที่การดำเนินการนี้เสร็จสมบูรณ์ ระบบจะยกเลิกการตั้งค่าหากยังดำเนินการอยู่ |
index |
ทรัพยากรดัชนีที่การดำเนินการนี้ดำเนินการอยู่ ตัวอย่าง: |
state |
สถานะของการดำเนินการ |
progress_documents |
ความคืบหน้าในเอกสารของการดำเนินการนี้ |
progress_bytes |
ความคืบหน้าในหน่วยไบต์ของการดำเนินการนี้ |
แสดงรายการ BackupSchedulesRequest
คำขอสำหรับ FirestoreAdmin.ListBackupSchedules
ช่อง | |
---|---|
parent |
ต้องระบุ ฐานข้อมูลหลัก รูปแบบคือ |
แสดงรายการ BackupSchedulesResponse
การตอบกลับสำหรับ FirestoreAdmin.ListBackupSchedules
ช่อง | |
---|---|
backup_schedules[] |
รายการกำหนดเวลาการสำรองข้อมูลทั้งหมด |
แสดงรายการคำขอข้อมูลสำรอง
คำขอสำหรับ FirestoreAdmin.ListBackups
ช่อง | |
---|---|
parent |
ต้องระบุ ตำแหน่งที่จะแสดงข้อมูลสำรอง รูปแบบคือ |
แสดงรายการข้อมูลสำรอง
การตอบกลับสำหรับ FirestoreAdmin.ListBackups
ช่อง | |
---|---|
backups[] |
รายการข้อมูลสำรองทั้งหมดสำหรับโปรเจ็กต์ |
unreachable[] |
รายชื่อตำแหน่งที่ดึงข้อมูลจากข้อมูลสำรองที่มีอยู่ไม่ได้ แทนที่จะดำเนินการกับคำขอทั้งหมดเมื่อไม่สามารถเข้าถึงตำแหน่งเดียว การตอบกลับนี้จะแสดงชุดผลลัพธ์บางส่วนและรายชื่อสถานที่ที่ไม่สามารถเข้าถึงที่นี่ได้ คุณอาจลองส่งคำขออีกครั้งกับสถานที่แห่งเดียวเพื่อให้พบข้อผิดพลาดที่เป็นรูปธรรม |
แสดงรายการคำขอฐานข้อมูล
คำขอแสดงรายการฐานข้อมูล Firestore ในทุกตำแหน่งสำหรับโปรเจ็กต์
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อหลักของแบบฟอร์ม |
แสดงรายการฐานข้อมูล
รายการฐานข้อมูลสำหรับโปรเจ็กต์
ช่อง | |
---|---|
databases[] |
ฐานข้อมูลในโปรเจ็กต์ |
unreachable[] |
ในกรณีที่ไม่สามารถแสดงรายการข้อมูลเกี่ยวกับฐานข้อมูลแต่ละรายการ ระบบจะบันทึกข้อมูลดังกล่าวที่นี่ ตัวอย่างรายการอาจได้แก่ project/some_project/locations/some_location ซึ่งอาจเกิดขึ้นได้หาก Cloud Region ที่มีฐานข้อมูลอยู่ไม่พร้อมใช้งานในขณะนี้ ในกรณีนี้ เราไม่สามารถดึงรายละเอียดทั้งหมดเกี่ยวกับฐานข้อมูลได้ คุณอาจจะได้รับข้อความแสดงข้อผิดพลาดที่ละเอียดยิ่งขึ้น (หรืออาจดึงทรัพยากร) ด้วยการส่งคำขอ "รับ" สำหรับทรัพยากรหรือคำขอ "รายการ" สําหรับตําแหน่งที่เจาะจง |
คำขอฟิลด์รายการ
คำขอสำหรับ FirestoreAdmin.ListFields
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อหลักของแบบฟอร์ม |
filter |
ตัวกรองที่จะนำไปใช้กับผลการค้นหา ขณะนี้ |
page_size |
จำนวนผลลัพธ์ที่จะแสดงผล |
page_token |
โทเค็นของหน้าที่ส่งคืนจากการเรียกไปยัง |
แสดงรายการฟิลด์คำตอบ
การตอบกลับสำหรับ FirestoreAdmin.ListFields
ช่อง | |
---|---|
fields[] |
ฟิลด์ที่ขอ |
next_page_token |
โทเค็นของหน้าที่อาจใช้เพื่อขอหน้าผลลัพธ์อื่น หากเว้นว่างไว้ นี่คือหน้าสุดท้าย |
คำขอดัชนีรายการ
คำขอสำหรับ FirestoreAdmin.ListIndexes
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อหลักของแบบฟอร์ม |
filter |
ตัวกรองที่จะนำไปใช้กับผลการค้นหา |
page_size |
จำนวนผลลัพธ์ที่จะแสดงผล |
page_token |
โทเค็นของหน้าที่ส่งคืนจากการเรียกไปยัง |
แสดงรายการดัชนีคำตอบ
การตอบกลับสำหรับ FirestoreAdmin.ListIndexes
ช่อง | |
---|---|
indexes[] |
ดัชนีที่ขอ |
next_page_token |
โทเค็นของหน้าที่อาจใช้เพื่อขอหน้าผลลัพธ์อื่น หากเว้นว่างไว้ นี่คือหน้าสุดท้าย |
ข้อมูลเมตาตำแหน่ง
ประเภทนี้ไม่มีช่อง
ข้อความข้อมูลเมตาสำหรับ google.cloud.location.Location.metadata
สถานะการดำเนินการ
อธิบายสถานะของการดำเนินการ
Enum | |
---|---|
OPERATION_STATE_UNSPECIFIED |
ไม่ระบุ |
INITIALIZING |
ระบบกำลังเตรียมการดำเนินการตามคำขอ |
PROCESSING |
กำลังดำเนินการกับคำขอ |
CANCELLING |
คำขออยู่ระหว่างกระบวนการจะถูกยกเลิกหลังจากที่ผู้ใช้ชื่อ google.longrunning.Implements.CancelOperating ในการดำเนินการนี้ |
FINALIZING |
คำขอได้รับการดำเนินการแล้ว และอยู่ในระยะขั้นสุดท้าย |
SUCCESSFUL |
คำขอเสร็จสมบูรณ์ |
FAILED |
ประมวลผลคำขอเสร็จสิ้นแล้ว แต่พบข้อผิดพลาด |
CANCELLED |
ยกเลิกคำขอเสร็จสมบูรณ์หลังจากที่ผู้ใช้ชื่อ google.longrunning.ActionssCancelExecut ดำเนินการ |
ความคืบหน้า
อธิบายความคืบหน้าของการดำเนินการ หน่วยงานเป็นหน่วยทั่วไปและต้องตีความตามสถานที่ที่ใช้ Progress
ช่อง | |
---|---|
estimated_work |
จำนวนงานที่ประมาณไว้ |
completed_work |
จำนวนงานที่ทำเสร็จแล้ว |
กู้คืนฐานข้อมูลข้อมูลเมตา
ข้อมูลเมตาสำหรับ long-running operation
จากคำขอ [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase]
ช่อง | |
---|---|
start_time |
เวลาที่เริ่มการกู้คืน |
end_time |
เวลาที่คืนค่าเสร็จสิ้นแล้ว ให้ไม่ได้ตั้งค่าสำหรับการคืนค่าที่ดำเนินอยู่ |
operation_state |
สถานะการดำเนินการของการคืนค่า |
database |
ชื่อของฐานข้อมูลที่กำลังกู้คืน |
backup |
ชื่อของข้อมูลสำรองที่คืนค่า |
progress_percentage |
ระยะเวลาที่ใช้ในการกู้คืนเป็นเปอร์เซ็นต์ของเวลาที่เหลือโดยประมาณ |
กู้คืนคำขอฐานข้อมูล
ข้อความคำขอสำหรับ [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase]
ช่อง | |
---|---|
parent |
ต้องระบุ โปรเจ็กต์ที่จะกู้คืนฐานข้อมูล รูปแบบคือ |
database_id |
ต้องระบุ รหัสที่จะใช้สำหรับฐานข้อมูล ซึ่งจะกลายเป็นองค์ประกอบสุดท้ายของชื่อทรัพยากรของฐานข้อมูล รหัสฐานข้อมูลนี้ต้องไม่เชื่อมโยงกับฐานข้อมูลที่มีอยู่ ค่านี้ควรมีความยาว 4-63 อักขระ อักขระที่ถูกต้องคือ /[a-z][0-9]-/ โดยมีอักขระตัวแรกและมีอักขระตัวสุดท้ายหรือตัวเลข ต้องไม่เหมือน UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ รหัสฐานข้อมูล "(ค่าเริ่มต้น)" ก็ถูกต้องเช่นกัน |
ฟิลด์สหภาพ
|
|
backup |
ข้อมูลสำรองที่จะคืนค่า ต้องมาจากโปรเจ็กต์เดียวกับโปรเจ็กต์ระดับบนสุด รูปแบบคือ |
อัปเดต BackupScheduleRequest
คำขอสำหรับ FirestoreAdmin.UpdateBackupSchedule
ช่อง | |
---|---|
backup_schedule |
ต้องระบุ กำหนดการสำรองข้อมูลที่จะอัปเดต |
update_mask |
รายการช่องที่จะอัปเดต |
อัปเดตฐานข้อมูลข้อมูลเมตา
ประเภทนี้ไม่มีช่อง
ข้อมูลเมตาที่เกี่ยวข้องกับการดำเนินการอัปเดตฐานข้อมูล
อัปเดตคำขอฐานข้อมูล
คำขอสำหรับ FirestoreAdmin.UpdateDatabase
ช่อง | |
---|---|
database |
ต้องระบุ ฐานข้อมูลที่จะอัปเดต |
update_mask |
รายการช่องที่จะอัปเดต |
อัปเดตคำขอฟิลด์
คำขอสำหรับ FirestoreAdmin.UpdateField
ช่อง | |
---|---|
field |
ต้องระบุ ฟิลด์ที่จะอัปเดต |
update_mask |
มาสก์ที่สัมพันธ์กับฟิลด์ หากระบุไว้ ระบบจะอัปเดตเฉพาะการกำหนดค่าที่ระบุโดย field_mask นี้ในช่อง |
การเกิดซ้ำรายสัปดาห์
แสดงกำหนดการที่เกิดซ้ำซึ่งทำงานในวันที่ระบุของสัปดาห์
เขตเวลาคือ UTC
ช่อง | |
---|---|
day |
วันของสัปดาห์ที่จะทำงาน ไม่อนุญาต DAY_OF_WEEK_UNSPECIFIED |