REST Resource: projects.databases

Resource: Database

Database Cloud Firestore.

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

string

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

string

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

string (Timestamp format)

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

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. 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 update pada resource database dan bukan data yang terdapat dalam database.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

Hanya output. Stempel waktu saat database ini dihapus. Hanya tetapkan jika database telah dihapus.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. 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 mengetahui informasi tentang cara memilihnya.
concurrencyMode

enum (ConcurrencyMode)

Mode kontrol serentak yang akan digunakan untuk database ini.
versionRetentionPeriod

string (Duration format)

Hanya output. Periode saat versi data sebelumnya dipertahankan 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, yang diakhiri dengan 's'. Contoh: "3.5s".
earliestVersionTime

string (Timestamp format)

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

Nilai ini terus diperbarui, dan menjadi usang 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 RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

Menentukan apakah akan mengaktifkan fitur PITR di 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 project ID ("~") untuk membuat ID aplikasi yang ditampilkan dari Cloud Datastore API pada 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 bahwa CMEK diaktifkan untuk database ini.
previousId

string

Hanya output. ID database sebelumnya dari resource database. Kolom ini hanya diisi untuk database yang telah dihapus.
etag

string

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

DatabaseType

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

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 optimistis secara default. Mode ini tersedia untuk database Cloud Firestore.
PESSIMISTIC

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

Setelan ini adalah setelan default untuk Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

Gunakan kontrol konkurensi optimistis dengan grup entity 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.

Pengaktifan PointInTimeRecovery

Pengaktifan fitur Pemulihan Titik Dalam Waktu.

Enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Tidak digunakan.
POINT_IN_TIME_RECOVERY_ENABLED

Pembacaan didukung pada versi data yang dipilih dari dalam 7 hari terakhir:

  • Membaca berdasarkan stempel waktu mana pun dalam satu jam terakhir
  • Membaca snapshot 1 menit di atas 1 jam dan dalam 7 hari

versionRetentionPeriod dan earliestVersionTime dapat digunakan untuk menentukan versi yang didukung.
POINT_IN_TIME_RECOVERY_DISABLED Pembacaan didukung pada versi data apa pun 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. Termasuk menonaktifkan aplikasi & di dalam database, serta menonaktifkan operasi tulis di 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 (Customer Managed Encryption Key) 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 yang berada di lokasi yang sama dengan database ini yang diizinkan untuk digunakan untuk enkripsi.

Untuk multi-region nam5 Firestore, ini sama dengan multi-region kami di Cloud KMS. Untuk multi-region eur3 Firestore, hal ini sama dengan multi-region Cloud KMS di eropa. 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. Saat ini versi kunci KMS yang 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

 Mencantumkan semua database dalam project.

patch

 Memperbarui database.

restore

 Membuat {i>database<i} baru dengan memulihkan dari cadangan yang ada.