REST Resource: projects.databases

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

ฐานข้อมูล Cloud Firestore

การแสดง JSON 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": 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)
  },
  "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"
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)

เอาต์พุตเท่านั้น การประทับเวลาเร็วที่สุดที่อ่านข้อมูลเวอร์ชันเก่าได้จากฐานข้อมูล โปรดดู [versionreservationPeriod] ด้านบน ช่องนี้จะมีการเติมข้อมูล 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 นี้ใช้ร่วมกับรหัสโปรเจ็กต์ ("~") เพื่อสร้างรหัสแอปพลิเคชันที่ส่งกลับมาจาก Cloud Datastore API ในรันไทม์รุ่นแรกของ Google App Engine

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

enum (DeleteProtectionState)

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

object (CmekConfig)

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

string

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

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

ประเภทของฐานข้อมูล โปรดดูวิธีเลือกที่ 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 ด้วย แต่เราไม่แนะนำให้ทำ

การเปิดใช้ PointInTimeRecovery

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

Enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED ไม่ได้ใช้
POINT_IN_TIME_RECOVERY_ENABLED

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

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

ใช้ versionRetentionPeriod และ earliestVersionTime เพื่อระบุเวอร์ชันที่รองรับได้
POINT_IN_TIME_RECOVERY_DISABLED และรองรับการอ่านในข้อมูลเวอร์ชันใดก็ได้ภายใน 1 ชั่วโมงที่ผ่านมา

AppEngineIntegrationMode

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

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

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

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

สถานะ DeleteProtection

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

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

การกำหนดค่า

การกำหนดค่า 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

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