REST Resource: projects.databases

ทรัพยากร: ฐานข้อมูล

ฐานข้อมูล Cloud Firestore

การแสดง JSON 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "cmekConfig": {
    object (CmekConfig)
  },
  "previousId": string,
  "etag": string
}
ช่อง
name

string

ชื่อทรัพยากรของฐานข้อมูล รูปแบบ: projects/{project}/databases/{database}
uid

string

เอาต์พุตเท่านั้น UUID4 ที่ระบบสร้างขึ้นสำหรับฐานข้อมูลนี้
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่ใช้สร้างฐานข้อมูลนี้ ฐานข้อมูลที่สร้างก่อนปี 2016 จะไม่ป้อนข้อมูล createTime

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่ฐานข้อมูลนี้ได้รับการอัปเดตล่าสุด โปรดทราบว่าการอัปเดตนี้รวมเฉพาะการอัปเดตทรัพยากรฐานข้อมูลเท่านั้น ไม่รวมข้อมูลที่อยู่ในฐานข้อมูล

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
deleteTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่มีการลบฐานข้อมูลนี้ ตั้งค่าเฉพาะเมื่อฐานข้อมูลถูกลบไปแล้ว

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
locationId

string

ตำแหน่งของฐานข้อมูล ตำแหน่งที่พร้อมใช้งานจะแสดงอยู่ใน https://cloud.google.com/firestore/docs/locations
type

enum (DatabaseType)

ประเภทของฐานข้อมูล ดูข้อมูลเกี่ยวกับวิธีเลือกได้ใน https://cloud.google.com/datastore/docs/firestore-or-datastore
concurrencyMode

enum (ConcurrencyMode)

โหมดควบคุมการเกิดขึ้นพร้อมกันที่ใช้สำหรับฐานข้อมูลนี้
versionRetentionPeriod

string (Duration format)

เอาต์พุตเท่านั้น ระยะเวลาในระหว่างที่มีการเก็บรักษาข้อมูลเวอร์ชันที่ผ่านมาไว้ในฐานข้อมูล

read หรือ query สามารถระบุ readTime ภายในหน้าต่างนี้ได้ และจะอ่านสถานะของฐานข้อมูลในขณะนั้น

หากเปิดใช้งานฟีเจอร์ PITR แล้ว ระยะเวลาเก็บรักษาคือ 7 วัน มิฉะนั้น ระยะเวลาเก็บรักษาคือ 1 ชั่วโมง

ระยะเวลาเป็นวินาทีโดยมีเลขเศษส่วนไม่เกิน 9 หลัก ลงท้ายด้วย "s" ตัวอย่างเช่น "3.5s"
earliestVersionTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาแรกสุดที่สามารถอ่านข้อมูลเวอร์ชันเก่าจากฐานข้อมูลได้ ดู [versionRestrictPeriod] ด้านบน ฟิลด์นี้จะเติมด้วย now - versionRetentionPeriod

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

จะเปิดใช้ฟีเจอร์ PITR บนฐานข้อมูลนี้หรือไม่
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

โหมดการผสานรวมของ App Engine ที่จะใช้สำหรับฐานข้อมูลนี้
keyPrefix

string

เอาต์พุตเท่านั้น keyPrefix สำหรับฐานข้อมูลนี้ keyPrefix นี้ใช้ร่วมกับรหัสโปรเจ็กต์ ("~") เพื่อสร้างรหัสแอปพลิเคชันที่ส่งคืนจาก API ของ Cloud Datastore ในรันไทม์รุ่นแรกของ Google App Engine

ค่านี้อาจว่างเปล่า ในกรณีที่ appid ที่จะใช้สำหรับคีย์ที่เข้ารหัส URL คือ projectId (เช่น foo แทน v~foo)
deleteProtectionState

enum (DeleteProtectionState)

สถานะของการป้องกันการลบสำหรับฐานข้อมูล
cmekConfig

object (CmekConfig)

ไม่บังคับ การตรวจหาบุคคลในบ้านหมายความว่ามีการเปิดใช้ CMEK สำหรับฐานข้อมูลนี้
previousId

string

เอาต์พุตเท่านั้น รหัสฐานข้อมูลก่อนหน้าของทรัพยากรฐานข้อมูล ช่องนี้จะป้อนข้อมูลสำหรับฐานข้อมูลที่ถูกลบเท่านั้น
etag

string

เซิร์ฟเวอร์จะคำนวณการตรวจสอบข้อผิดพลาดดังกล่าวโดยอิงตามค่าฟิลด์อื่นๆ และอาจส่งคำขออัปเดตและลบคำขอเพื่อให้แน่ใจว่าไคลเอ็นต์มีค่าเป็นปัจจุบันก่อนดำเนินการต่อ

ประเภทฐานข้อมูล

ประเภทของฐานข้อมูล ดูข้อมูลเกี่ยวกับวิธีเลือกได้ใน https://cloud.google.com/datastore/docs/firestore-or-datastore

เปลี่ยนโหมดได้ต่อเมื่อฐานข้อมูลว่างเปล่าเท่านั้น

Enum
DATABASE_TYPE_UNSPECIFIED ค่าเริ่มต้น ระบบจะใช้ค่านี้หากไม่มีการระบุประเภทฐานข้อมูล
FIRESTORE_NATIVE โหมดดั้งเดิมของ Firestore
DATASTORE_MODE Firestore ในโหมด Datastore

โหมดการเกิดขึ้นพร้อมกัน

ประเภทโหมดควบคุมการเกิดขึ้นพร้อมกันสำหรับธุรกรรม

Enum
CONCURRENCY_MODE_UNSPECIFIED ไม่ใช้
OPTIMISTIC ใช้การควบคุมการเกิดขึ้นพร้อมกันอย่างมีประสิทธิภาพโดยค่าเริ่มต้น โหมดนี้ใช้ได้กับฐานข้อมูล Cloud Firestore
PESSIMISTIC

ใช้การควบคุมการเกิดขึ้นพร้อมกันแบบถาวรโดยค่าเริ่มต้น โหมดนี้ใช้ได้กับฐานข้อมูล Cloud Firestore

นี่คือการตั้งค่าเริ่มต้นสำหรับ Cloud Firestore
OPTIMISTIC_WITH_ENTITY_GROUPS

ใช้การควบคุมการเกิดขึ้นพร้อมกันอย่างมีประสิทธิภาพกับกลุ่มเอนทิตีโดยค่าเริ่มต้น

Cloud Datastore เป็นโหมดเดียวที่ใช้ได้

โหมดนี้ยังใช้กับ Cloud Firestore ที่มีโหมด Datastore ได้ด้วย แต่ไม่แนะนำให้ใช้

การเปิดใช้งานการกู้คืน PointInTime

การเปิดใช้ฟีเจอร์การกู้คืนช่วงเวลา

Enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED ไม่ใช้
POINT_IN_TIME_RECOVERY_ENABLED

ระบบรองรับการอ่านเวอร์ชันที่เลือกจากในช่วง 7 วันที่ผ่านมา ได้แก่

  • การอ่านเทียบกับการประทับเวลาในชั่วโมงที่ผ่านมา
  • อ่านเทียบกับสแนปชอต 1 นาทีที่เกินจาก 1 ชั่วโมงและภายใน 7 วัน

versionRetentionPeriod และ earliestVersionTime สามารถใช้เพื่อกำหนดเวอร์ชันที่รองรับ
POINT_IN_TIME_RECOVERY_DISABLED ระบบรองรับการอ่านข้อมูลเวอร์ชันต่างๆ ภายใน 1 ชั่วโมงที่ผ่านมา

โหมดการผสานรวม App Engine

ประเภทของโหมดการผสานรวมของ App Engine

Enum
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED ไม่ใช้
ENABLED หากมีแอปพลิเคชัน App Engine อยู่ในภูมิภาคเดียวกับฐานข้อมูลนี้ การกำหนดค่า App Engine จะมีผลต่อฐานข้อมูลนี้ ซึ่งรวมถึงการปิดใช้แอปพลิเคชันและ ฐานข้อมูล รวมทั้งปิดการเขียนฐานข้อมูล
DISABLED

App Engine ไม่มีผลต่อความสามารถของฐานข้อมูลนี้ในการดำเนินการตามคำขอ

การตั้งค่านี้เป็นการตั้งค่าเริ่มต้นสำหรับฐานข้อมูลที่สร้างด้วย Firestore API

DeleteProtectionState

สถานะการป้องกันการลบของฐานข้อมูล

Enum
DELETE_PROTECTION_STATE_UNSPECIFIED ค่าเริ่มต้น ไม่ได้ระบุประเภทการป้องกันการลบ
DELETE_PROTECTION_DISABLED ปิดใช้การป้องกันการลบอยู่
DELETE_PROTECTION_ENABLED เปิดใช้การป้องกันการลบอยู่

CmekConfig

การกำหนดค่า CMEK (คีย์การเข้ารหัสที่จัดการโดยลูกค้า) สำหรับฐานข้อมูล Firestore หากไม่มี ฐานข้อมูลจะได้รับการปกป้องโดยคีย์การเข้ารหัสเริ่มต้นของ Google

การแสดง JSON 
{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}
ช่อง
kmsKeyName

string

ต้องระบุ เฉพาะคีย์ในตำแหน่งเดียวกับฐานข้อมูลนี้เท่านั้นที่ได้รับอนุญาตให้ใช้ในการเข้ารหัส

สําหรับหลายภูมิภาค nam5 ของ Firestore จะตรงกับหลายภูมิภาคใน Cloud KMS สำหรับ eur3 ในหลายภูมิภาคของ Firestore จะเป็นไปตามหลายภูมิภาคในยุโรปของ Cloud KMS ดู https://cloud.google.com/kms/docs/locations

รูปแบบที่คาดไว้คือ projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
activeKeyVersion[]

string

เอาต์พุตเท่านั้น เวอร์ชันคีย์ KMS ที่ใช้งานอยู่ในปัจจุบัน ในระหว่างการหมุนเวียนคีย์ อาจมีเวอร์ชันคีย์ที่ใช้งานอยู่ได้หลายเวอร์ชัน

รูปแบบที่คาดไว้คือ projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}

เมธอด

create

 สร้างฐานข้อมูล

delete

 ลบฐานข้อมูล

exportDocuments

 ส่งออกสำเนาเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบพื้นที่เก็บข้อมูลอื่น เช่น Google Cloud Storage

get

 รับข้อมูลเกี่ยวกับฐานข้อมูล

importDocuments

 นำเข้าเอกสารไปยัง Google Cloud Firestore

list

 แสดงรายการฐานข้อมูลทั้งหมดในโปรเจ็กต์

patch

 อัปเดตฐานข้อมูล

restore

 สร้างฐานข้อมูลใหม่โดยกู้คืนจากข้อมูลสำรองที่มีอยู่