REST Resource: projects.databases

Kaynak: Veritabanı

Cloud Firestore Veritabanı.

JSON gösterimi 
{
  "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
}
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ı createTime'ı doldurmaz.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Ö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ı. Bu işlemin veritabanında bulunan verileri değil, yalnızca veritabanı kaynağında yapılan güncellemeleri içerdiğini unutmayın.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

Yalnızca çıkış. Bu veritabanının silindiği zaman damgası. Yalnızca veritabanı silindiyse ayarlanır.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
locationId

string

Veritabanının konumu. Kullanılabildiği konumlar https://cloud.google.com/firestore/docs/locations adresinde listelenmiştir.
type

enum (DatabaseType)

Veritabanının türü. Nasıl seçim yapabileceğiniz 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 geçmiş sürümlerinin veritabanında tutulduğu dönem.

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

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

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

string (Timestamp format)

Yalnızca çıkış. Verilerin eski sürümlerinin veritabanından okunabildiği en erken zaman damgası. Yukarıdaki [versionSaklama Dönemi] bölümüne bakın; bu alan now - versionRetentionPeriod ile doldurulur.

Bu değer sürekli olarak güncellenir ve sorgulandığı anda eskir. Verileri kurtarmak için bu değeri 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.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Ö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ğini belirler.
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, Google App Engine birinci nesil çalışma zamanlarında 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. Bu durumda, URL kodlamalı anahtarlar için kullanılacak appid öğesi projectId olacaktır (ör. v~foo yerine foo).
deleteProtectionState

enum (DeleteProtectionState)

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

object (CmekConfig)

İsteğe bağlı. Bulunma, CMEK'nin bu veritabanı için etkinleştirildiğini gösterir.
previousId

string

Yalnızca çıkış. Veritabanı kaynağının önceki veritabanı kimliği. Bu alan yalnızca silinen veritabanları için doldurulur.
etag

string

Bu sağlama toplamı, diğer alanların değerine bağlı olarak sunucu tarafından 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ü. Nasıl seçim yapabileceğiniz hakkında bilgi için https://cloud.google.com/datastore/docs/firestore-or-datastore adresini ziyaret edin.

Mod değişikliklerine yalnızca veritabanı boşsa izin verilir.

Sıralamalar
DATABASE_TYPE_UNSPECIFIED Varsayılan değerdir. 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ın. Bu mod Cloud Firestore veritabanlarında kullanılabilir.
PESSIMISTIC

Kötümser eşzamanlılık kontrolünü varsayılan olarak kullanın. 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 için de kullanılabilir ancak önerilmez.

PointInTimeRecoveryEnable

Belirli Bir Noktası Kurtarma Özelliğinin Etkinleştirilmesi.

Sıralamalar
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Kullanılmıyor.
POINT_IN_TIME_RECOVERY_ENABLED

Okuma işlemleri, son 7 gün içindeki verilerin seçili sürümlerinde desteklenir:

  • Son bir saat içindeki herhangi bir zaman damgasına göre okuma yapar
  • 1 saatten sonraki 7 gün içindeki 1 dakikalık anlık görüntülerde okuma yapar

versionRetentionPeriod ve earliestVersionTime, desteklenen sürümleri belirlemek için kullanılabilir.
POINT_IN_TIME_RECOVERY_DISABLED Okuma işlemleri, son 1 saat içindeki tüm veri sürümlerinde 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 bulunan bir App Engine uygulaması varsa App Engine yapılandırması bu veritabanını etkiler. Buna, uygulamanın devre dışı bırakılması ve ve veritabanına yazma işlemlerini devre dışı bırakmanızı sağlar.
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 koruma durumu.

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

CmekConfig

Firestore veritabanı için CMEK (Müşteri Tarafından Yönetilen Şifreleme Anahtarı) yapılandırması. Bu kod mevcut değilse veritabanının güvenliği varsayılan Google şifreleme anahtarıyla sağlanır.

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

string

Zorunlu. Şifreleme için yalnızca bu veritabanıyla aynı konumda bulunan anahtarların kullanılmasına izin verilir.

Firestore'un nam5 çoklu bölgesi için bu, Cloud KMS çoklu bölge (ABD) değerine 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 adresini ziyaret edin.

Kullanılması beklenen biçim projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} olmalıdır.
activeKeyVersion[]

string

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

Kullanılması beklenen biçim projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} olmalıdır.

Yöntemler

create

 Veritabanı oluşturun.

delete

 Veritabanını siler.

exportDocuments

 Google Cloud Firestore'daki dokümanların tamamı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

 Veritabanını günceller.

restore

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