REST Resource: projects.databases

Referensi: Database

Database Cloud Firestore.

Representasi 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
}
Kolom
name

string

Nama resource Database. Format: projects/{project}/databases/{database}
uid

string

Hanya output. UUID4 yang dihasilkan sistem untuk Database ini.
createTime

string (Timestamp format)

Hanya output. Stempel waktu pembuatan database ini. Database yang dibuat sebelum tahun 2016 tidak mengisi createTime.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat database ini terakhir diperbarui. Perhatikan bahwa ini hanya mencakup pembaruan pada resource database dan bukan data yang terdapat dalam database.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
locationId

string

Lokasi database. Lokasi yang tersedia tercantum di https://cloud.google.com/firestore/docs/locations.
type

enum (DatabaseType)

Jenis database. Lihat https://cloud.google.com/datastore/docs/firestore-or-datastore untuk informasi tentang cara memilih.
concurrencyMode

enum (ConcurrencyMode)

Mode kontrol konkurensi yang akan digunakan untuk database ini.
versionRetentionPeriod

string (Duration format)

Hanya output. Periode saat versi data sebelumnya disimpan dalam database.

Semua read atau query dapat menentukan readTime dalam jendela ini, dan akan membaca status database pada saat itu.

Jika fitur PITR diaktifkan, periode retensi data adalah 7 hari. Jika tidak, periode retensi data adalah 1 jam.

Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan 's'. Contoh: "3.5s".
earliestVersionTime

string (Timestamp format)

Hanya output. Stempel waktu paling awal saat versi data lama dapat dibaca dari database. Lihat [versionRetentionPeriod] di atas; kolom ini diisi dengan now - versionRetentionPeriod.

Nilai ini terus-menerus diperbarui, dan menjadi tidak berlaku saat dikueri. Jika Anda menggunakan nilai ini untuk memulihkan data, pastikan untuk memperhitungkan waktu dari saat nilai dikueri hingga saat Anda memulai pemulihan.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

Apakah akan mengaktifkan fitur PITR pada database ini.
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

Mode integrasi App Engine yang akan digunakan untuk database ini.
keyPrefix

string

Hanya output. keyPrefix untuk database ini. keyPrefix ini digunakan, dikombinasikan dengan ID project ("~") untuk membuat ID aplikasi yang ditampilkan dari Cloud Datastore API di runtime generasi pertama Google App Engine.

Nilai ini mungkin kosong, sehingga appid yang akan digunakan untuk kunci yang dienkode URL adalah projectId (misalnya: foo, bukan v~foo).
deleteProtectionState

enum (DeleteProtectionState)

Status perlindungan penghapusan untuk database.
cmekConfig

object (CmekConfig)

Opsional. Kehadiran menunjukkan CMEK diaktifkan untuk database ini.
etag

string

Checksum ini dihitung oleh server berdasarkan nilai kolom lain, dan dapat dikirim pada saat permintaan update dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan.

DatabaseType

Jenis database. Lihat https://cloud.google.com/datastore/docs/firestore-or-datastore untuk informasi tentang cara memilih.

Perubahan mode hanya diizinkan jika database kosong.

Enum
DATABASE_TYPE_UNSPECIFIED Nilai default. Nilai ini digunakan jika jenis database dihilangkan.
FIRESTORE_NATIVE Mode Native Firestore
DATASTORE_MODE Firestore dalam Mode Datastore.

ConcurrencyMode

Jenis mode kontrol serentak untuk transaksi.

Enum
CONCURRENCY_MODE_UNSPECIFIED Tidak digunakan.
OPTIMISTIC Gunakan kontrol konkurensi optimis secara default. Mode ini tersedia untuk database Cloud Firestore.
PESSIMISTIC

Gunakan kontrol konkurensi pesimis secara default. Mode ini tersedia untuk database Cloud Firestore.

Ini adalah setelan default untuk Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

Gunakan kontrol konkurensi optimis dengan grup entitas secara default.

Mode ini adalah satu-satunya mode yang tersedia untuk Cloud Datastore.

Mode ini juga tersedia untuk Cloud Firestore dengan Mode Datastore, tetapi tidak direkomendasikan.

PointInTimeRecoveryEnablement

Pengaktifan fitur Pemulihan Point In Time.

Enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Tidak digunakan.
POINT_IN_TIME_RECOVERY_ENABLED

Operasi baca didukung di versi data yang dipilih dalam 7 hari terakhir:

  • Membaca berdasarkan stempel waktu dalam satu jam terakhir
  • Membaca pada snapshot 1 menit lebih dari 1 jam dan dalam 7 hari

versionRetentionPeriod dan earliestVersionTime dapat digunakan untuk menentukan versi yang didukung.
POINT_IN_TIME_RECOVERY_DISABLED Operasi baca didukung pada semua versi data dari dalam 1 jam terakhir.

AppEngineIntegrationMode

Jenis mode integrasi App Engine.

Enum
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Tidak digunakan.
ENABLED Jika aplikasi App Engine ada di region yang sama dengan database ini, konfigurasi App Engine akan memengaruhi database ini. Hal ini termasuk menonaktifkan aplikasi & database, serta menonaktifkan penulisan ke database.
DISABLED

App Engine tidak berpengaruh pada kemampuan database ini untuk melayani permintaan.

Ini adalah setelan default untuk database yang dibuat dengan Firestore API.

DeleteProtectionState

Status perlindungan penghapusan database.

Enum
DELETE_PROTECTION_STATE_UNSPECIFIED Nilai default. Jenis perlindungan penghapusan tidak ditentukan
DELETE_PROTECTION_DISABLED Perlindungan penghapusan dinonaktifkan
DELETE_PROTECTION_ENABLED Perlindungan penghapusan diaktifkan

CmekConfig

Konfigurasi CMEK (Kunci Enkripsi yang Dikelola Pelanggan) untuk database Firestore. Jika tidak ada, database akan dilindungi oleh kunci enkripsi Google default.

Representasi JSON 
{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}
Kolom
kmsKeyName

string

Wajib diisi. Hanya kunci di lokasi yang sama dengan database ini yang boleh digunakan untuk enkripsi.

Untuk multi-region nam5 Firestore, ini sesuai dengan multi-region Cloud KMS kita. Untuk multi-region eur3 Firestore, ini sesuai dengan Eropa multi-region Cloud KMS. Lihat https://cloud.google.com/kms/docs/locations.

Format yang diharapkan adalah projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
activeKeyVersion[]

string

Hanya output. Versi kunci KMS yang saat ini digunakan. Selama rotasi kunci, mungkin terdapat beberapa versi kunci yang sedang digunakan.

Format yang diharapkan adalah projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

Metode

create

 Membuat database.

delete

 Menghapus database.

exportDocuments

 Mengekspor salinan semua atau sebagian dokumen dari Google Cloud Firestore ke sistem penyimpanan lain, seperti Google Cloud Storage.

get

 Mendapatkan informasi tentang database.

importDocuments

 Mengimpor dokumen ke Google Cloud Firestore.

list

 Membuat daftar semua database dalam project.

patch

 Memperbarui database.

restore

 Membuat database baru dengan memulihkan dari cadangan yang ada.