REST Resource: projects.databases

Kaynak: Veritabanı

Cloud Firestore Veritabanı.

JSON gösterimi 
{
  "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
}
Alanlar
name

string

Veritabanının kaynak adı. Biçim: projects/{project}/databases/{database}
uid

string

Yalnızca çıkış. Bu Veritabanı için sistem tarafından oluşturulan UUID4.
createTime

string (Timestamp format)

Yalnızca çıkış. Bu veritabanının oluşturulduğu zaman damgası. 2016'dan önce oluşturulan veritabanlarında createTime doldurulmaz.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Yalnızca çıkış. Bu veritabanının en son güncellendiği zaman damgası. Bunun yalnızca veritabanı kaynağında yapılan güncellemeleri içerdiğini, veritabanında bulunan verileri kapsamadığını unutmayın.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
locationId

string

Veritabanının konumu. Özelliğin kullanılabildiği konumları https://cloud.google.com/firestore/docs/locations adresinde bulabilirsiniz.
type

enum (DatabaseType)

Veritabanının türü. Seçim yapma hakkında bilgi için https://cloud.google.com/datastore/docs/firestore-or-datastore adresini ziyaret edin.
concurrencyMode

enum (ConcurrencyMode)

Bu veritabanı için kullanılacak eşzamanlılık kontrol modu.
versionRetentionPeriod

string (Duration format)

Yalnızca çıkış. Verilerin eski sürümlerinin veritabanında saklandığı dönem.

Herhangi bir read veya query, bu pencerede bir readTime belirtebilir ve veritabanının o zaman durumunu okur.

PITR özelliği etkinse saklama süresi 7 gündür. Aksi takdirde saklama süresi 1 saattir.

"s" ile biten ve en fazla dokuz kesir basamağı olan, saniye cinsinden bir süre. Örnek: "3.5s".
earliestVersionTime

string (Timestamp format)

Yalnızca çıkış. Verilerin eski sürümlerinin veritabanından okunabileceği en erken zaman damgası. Yukarıdaki [versionRetentionPeriod] politikasına bakın. Bu alan now - versionRetentionPeriod ile doldurulur.

Bu değer sürekli olarak güncellenir ve sorgulandığı anda geçersiz hale gelir. Bu değeri verileri kurtarmak için kullanıyorsanız değerin sorgulandığı andan kurtarma işlemini başlattığınız ana kadar geçen süreyi hesaba kattığınızdan emin olun.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

Bu veritabanında PITR özelliğinin etkinleştirilip etkinleştirilmeyeceği.
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

Bu veritabanı için kullanılacak App Engine entegrasyon modu.
keyPrefix

string

Yalnızca çıkış. Bu veritabanı için keyPrefix. Bu keyPrefix, birinci nesil çalışma zamanlarında Google App Engine Cloud Datastore API'lerinden döndürülen uygulama kimliğini oluşturmak için proje kimliğiyle ("~") birlikte kullanılır.

Bu değer boş olabilir. Böyle bir durumda, URL kodlamalı anahtarlar için kullanılacak appid, projectId olur (ör. v~foo yerine foo).
deleteProtectionState

enum (DeleteProtectionState)

Veritabanı için silme korumasının durumu.
cmekConfig

object (CmekConfig)

İsteğe bağlı. Mevcut olması, CMEK'nin bu veritabanı için etkin olduğunu gösterir.
etag

string

Bu sağlama toplamı, sunucu tarafından diğer alanların değerine göre hesaplanır ve devam etmeden önce istemcinin güncel bir değere sahip olduğundan emin olmak için güncelleme ve silme isteklerinde gönderilebilir.

VeritabanıTürü

Veritabanının türü. Seçim yapma hakkında bilgi için https://cloud.google.com/datastore/docs/firestore-or-datastore adresini ziyaret edin.

Yalnızca veritabanı boşsa mod değişikliklerine izin verilir.

Sıralamalar
DATABASE_TYPE_UNSPECIFIED Varsayılan değer. Veritabanı türü atlanırsa bu değer kullanılır.
FIRESTORE_NATIVE Firestore Yerel Modu
DATASTORE_MODE Datastore Modu'nda Firestore.

EşzamanlılıkModu

İşlemler için eşzamanlılık kontrol modunun türü.

Sıralamalar
CONCURRENCY_MODE_UNSPECIFIED Kullanılmıyor.
OPTIMISTIC Varsayılan olarak iyimser eşzamanlılık kontrolünü kullan. Bu mod Cloud Firestore veritabanlarında kullanılabilir.
PESSIMISTIC

Varsayılan olarak kötümser eşzamanlılık kontrolü kullanılır. Bu mod Cloud Firestore veritabanlarında kullanılabilir.

Bu, Cloud Firestore için varsayılan ayardır.
OPTIMISTIC_WITH_ENTITY_GROUPS

Varsayılan olarak varlık gruplarıyla iyimser eşzamanlılık kontrolü kullanın.

Cloud Datastore için kullanılabilen tek mod budur.

Bu mod, Datastore Modu ile Cloud Firestore'da da kullanılabilir ancak önerilmez.

PointInTimeRecoveryEtkinleştirme

Belirli Bir noktadan önceyi kurtarma özelliğinin etkinleştirilmesi.

Sıralamalar
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Kullanılmıyor.
POINT_IN_TIME_RECOVERY_ENABLED

Okumalar, son 7 gün içindeki belirli veri sürümlerinde desteklenir:

  • Son bir saat içindeki herhangi bir zaman damgasına göre okur
  • 1 saatten sonra ve 7 gün içinde 1 dakikalık anlık görüntülere karşı okur

Desteklenen sürümleri belirlemek için versionRetentionPeriod ve earliestVersionTime kullanılabilir.
POINT_IN_TIME_RECOVERY_DISABLED Okumalar, son 1 saat içindeki verilerin herhangi bir sürümünde desteklenir.

AppEngineIntegrationMode

App Engine entegrasyon modunun türü.

Sıralamalar
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Kullanılmıyor.
ENABLED Bu veritabanıyla aynı bölgede olan bir App Engine uygulaması varsa App Engine yapılandırması bu veritabanını etkiler. Bu işlemler arasında uygulama ve veritabanının devre dışı bırakılması ve veritabanına yazma işlemlerinin devre dışı bırakılması yer alır.
DISABLED

App Engine'in, bu veritabanının istekleri yerine getirme özelliği üzerinde herhangi bir etkisi yoktur.

Bu, Firestore API ile oluşturulan veritabanları için varsayılan ayardır.

DeleteProtectionState

Veritabanının silme koruması durumu.

Sıralamalar
DELETE_PROTECTION_STATE_UNSPECIFIED Varsayılan değer. Silme koruması türü belirtilmedi
DELETE_PROTECTION_DISABLED Silme koruması devre dışı
DELETE_PROTECTION_ENABLED Silme koruması etkin

CmekConfig

Bir Firestore veritabanı için CMEK (Müşteri Tarafından Yönetilen Şifreleme Anahtarı) yapılandırması. Mevcut değilse veritabanı, varsayılan Google şifreleme anahtarıyla güvence altına alınır.

JSON gösterimi 
{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}
Alanlar
kmsKeyName

string

Zorunlu. Yalnızca bu veritabanıyla aynı konumdaki anahtarların şifreleme için kullanılmasına izin verilir.

Firestore'un nam5 çoklu bölgesi için bu, bize Cloud KMS çoklu bölge kullanımına karşılık gelir. Firestore'un eur3 çoklu bölgesi için bu, Cloud KMS çok bölgeli Avrupa'ya karşılık gelir. https://cloud.google.com/kms/docs/locations adresine göz atın.

Beklenen biçim: projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
activeKeyVersion[]

string

Yalnızca çıkış. Şu anda kullanımda olan KMS anahtarı sürümleri. Anahtar rotasyonu sırasında, kullanımda olan birden fazla anahtar sürümü olabilir.

Beklenen biçim: projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

Yöntemler

create

 Veritabanı oluşturun.

delete

 Veritabanını siler.

exportDocuments

 Google Cloud Firestore'daki dokümanların tümünün veya bir alt kümesinin kopyasını Google Cloud Storage gibi başka bir depolama sistemine aktarır.

get

 Bir veritabanı hakkında bilgi alır.

importDocuments

 Belgeleri Google Cloud Firestore'a aktarır.

list

 Projedeki tüm veritabanlarını listeleyin.

patch

 Bir veritabanını günceller.

restore

 Mevcut bir yedekten geri yükleyerek yeni bir veritabanı oluşturur.