Dizin
FirestoreAdmin
(arayüz)Backup
(mesaj)Backup.State
(enum)BackupSchedule
(mesaj)CreateBackupScheduleRequest
(mesaj)CreateDatabaseMetadata
(mesaj)CreateDatabaseRequest
(mesaj)CreateIndexRequest
(mesaj)DailyRecurrence
(mesaj)Database
(mesaj)Database.AppEngineIntegrationMode
(enum)Database.CmekConfig
(mesaj)Database.ConcurrencyMode
(enum)Database.DatabaseType
(enum)Database.DeleteProtectionState
(enum)Database.PointInTimeRecoveryEnablement
(enum)DeleteBackupRequest
(mesaj)DeleteBackupScheduleRequest
(mesaj)DeleteDatabaseMetadata
(mesaj)DeleteDatabaseRequest
(mesaj)DeleteIndexRequest
(mesaj)ExportDocumentsMetadata
(mesaj)ExportDocumentsRequest
(mesaj)ExportDocumentsResponse
(mesaj)Field
(mesaj)Field.IndexConfig
(mesaj)Field.TtlConfig
(mesaj)Field.TtlConfig.State
(enum)FieldOperationMetadata
(mesaj)FieldOperationMetadata.IndexConfigDelta
(mesaj)FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum)FieldOperationMetadata.TtlConfigDelta
(mesaj)FieldOperationMetadata.TtlConfigDelta.ChangeType
(enum)GetBackupRequest
(mesaj)GetBackupScheduleRequest
(mesaj)GetDatabaseRequest
(mesaj)GetFieldRequest
(mesaj)GetIndexRequest
(mesaj)ImportDocumentsMetadata
(mesaj)ImportDocumentsRequest
(mesaj)Index
(mesaj)Index.ApiScope
(enum)Index.IndexField
(mesaj)Index.IndexField.ArrayConfig
(enum)Index.IndexField.Order
(enum)Index.IndexField.VectorConfig
(mesaj)Index.IndexField.VectorConfig.FlatIndex
(mesaj)Index.QueryScope
(enum)Index.State
(enum)IndexOperationMetadata
(mesaj)ListBackupSchedulesRequest
(mesaj)ListBackupSchedulesResponse
(mesaj)ListBackupsRequest
(mesaj)ListBackupsResponse
(mesaj)ListDatabasesRequest
(mesaj)ListDatabasesResponse
(mesaj)ListFieldsRequest
(mesaj)ListFieldsResponse
(mesaj)ListIndexesRequest
(mesaj)ListIndexesResponse
(mesaj)LocationMetadata
(mesaj)OperationState
(enum)Progress
(mesaj)RestoreDatabaseMetadata
(mesaj)RestoreDatabaseRequest
(mesaj)UpdateBackupScheduleRequest
(mesaj)UpdateDatabaseMetadata
(mesaj)UpdateDatabaseRequest
(mesaj)UpdateFieldRequest
(mesaj)WeeklyRecurrence
(mesaj)
FirestoreYöneticisi
Cloud Firestore Admin API.
Bu API, Cloud Firestore için çeşitli yönetim hizmetleri sunar.
Proje, Veritabanı, Ad Alanı, Koleksiyon, Koleksiyon Grubu ve Doküman, Google Cloud Firestore API'sinde tanımlandığı şekilde kullanılır.
İşlem: İşlem, arka planda gerçekleştirilen çalışmayı temsil eder.
Dizin hizmeti, Cloud Firestore dizinlerini yönetir.
Dizin oluşturma işlemi eşzamansız olarak gerçekleştirilir. Bu tür eşzamansız işlemlerin her biri için bir İşlem kaynağı oluşturulur. İşlemin durumu (karşılaşılan tüm hatalar dahil) Operasyon kaynağı aracılığıyla sorgulanabilir.
Operasyonlar koleksiyonu, belirtilen Proje için gerçekleştirilen işlemlerin (devam eden İşlemler dahil) bir kaydını sağlar. İşlemler doğrudan değil, diğer koleksiyon veya kaynaklara yapılan çağrılar aracılığıyla oluşturulur.
Tamamlanan bir işlem silinebilir ve artık İşlem koleksiyonunda listelenmez. İşlemler, 30 gün sonra toplanan çöplerdir. Varsayılan olarak, ListOperations yalnızca devam eden ve başarısız işlemleri döndürür. Tamamlanan işlemleri listelemek için done: true
filtresiyle bir Listİşlemler isteği gönderin.
İşlemler FirestoreAdmin
hizmeti tarafından oluşturulur ancak google.longrunning.Operations
hizmeti üzerinden erişilebilir.
YedeklemePlanı Oluşturma |
---|
Veritabanı üzerinde yedekleme programı oluşturur. Bir veritabanında, günlük bir yedekleme programı ve bir haftalık yedekleme planı olmak üzere en fazla iki yedekleme programı yapılandırılabilir.
|
Veritabanı Oluşturma |
---|
Veritabanı oluşturun.
|
Dizin Oluşturma |
---|
Bileşik bir dizin oluşturur. Bu, oluşturma işleminin durumunu izlemek için kullanılabilecek bir
|
Yedeklemeyi Sil |
---|
Bir yedeği siler.
|
DeleteBackupSchedule |
---|
Yedekleme planını siler.
|
Veritabanı Silme |
---|
Veritabanını siler.
|
DeleteIndex (Dizini Sil) |
---|
Bir bileşik dizini siler.
|
Dokümanları Dışa Aktar |
---|
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. Dokümanlarda yapılan son güncellemeler dışa aktarma işlemine yansıtılmayabilir. Dışa aktarma işlemi arka planda gerçekleşir ve ilerleme durumu, oluşturulan işlem kaynağıyla izlenip yönetilebilir. Dışa aktarma çıkışı, yalnızca ilişkili işlem tamamlandığında kullanılabilir. Bir dışa aktarma işlemi tamamlanmadan önce iptal edilirse kısmi veriler Google Cloud Storage'da kalabilir. Dışa aktarma davranışı ve çıkış biçimi hakkında daha fazla bilgi için https://cloud.google.com/firestore/docs/manage-data/export-import adresine bakın.
|
GetBackup |
---|
Yedekleme hakkında bilgi alır.
|
GetBackupSchedule |
---|
Yedekleme programı hakkında bilgi alır.
|
GetDatabase |
---|
Bir veritabanı hakkında bilgi alır.
|
GetField |
---|
Bir Alanın meta verilerini ve yapılandırmasını alır.
|
GetIndex |
---|
Bileşik bir dizin alır.
|
Dokümanları İçe Aktar |
---|
Belgeleri Google Cloud Firestore'a aktarır. Aynı ada sahip mevcut dokümanların üzerine yazılır. İçe aktarma işlemi arka planda gerçekleşir ve ilerleme durumu, oluşturulan işlem kaynağıyla izlenip yönetilebilir. ImportDocuments işlemi iptal edilirse verilerin bir alt kümesi zaten Cloud Firestore'a aktarılmış olabilir.
|
ListBackupSchedules |
---|
Yedekleme programlarını listeleyin.
|
Liste Yedeklemeleri |
---|
Tüm yedekleri listeler.
|
Veritabanlarını Listeleme |
---|
Projedeki tüm veritabanlarını listeleyin.
|
Liste Alanları |
---|
Bu veritabanı için alan yapılandırmasını ve meta verilerini listeler.
|
Dizin Dizinleri |
---|
Bileşik dizinleri listeler.
|
Geri Yükleme Veritabanı |
---|
Mevcut bir yedekten geri yükleyerek yeni bir veritabanı oluşturur. Yeni veritabanı, mevcut yedekle aynı bulut bölgesinde veya çoklu bölge konumunda olmalıdır. Yeni boş bir veritabanı oluşturmak yerine veritabanı türü, dizin yapılandırması ve mevcut bir yedekten dokümanlarla yeni bir veritabanı oluşturulması dışında bu [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] işlevine benzer şekilde davranır.
|
GüncellemeYedeklemePlanı |
---|
Yedekleme planını günceller.
|
Veritabanı Güncelleme |
---|
Bir veritabanını günceller.
|
GüncellemeAlanı |
---|
Alan yapılandırmasını günceller. Şu anda alan güncellemeleri yalnızca tek alanlı dizin yapılandırmasına uygulanmaktadır. Ancak Bu çağrı, alan güncellemesinin durumunu izlemek için kullanılabilecek bir Veritabanının varsayılan alan ayarlarını yapılandırmak için kaynak adına sahip özel
|
Yedek
Cloud Firestore Veritabanı Yedeği.
Yedek, belirli bir veritabanı için belirli bir zamandaki tüm dokümanları ve dizin yapılandırmalarını içerir.
Alanlar | |
---|---|
name |
Yalnızca çıkış. Yedeklemenin benzersiz kaynak adı. Biçim: |
database |
Yalnızca çıkış. Yedeğin ait olduğu Firestore veritabanının adı. Biçim: |
database_uid |
Yalnızca çıkış. Yedeklemenin ait olduğu Firestore veritabanı için sistem tarafından oluşturulan UUID4. |
snapshot_time |
Yalnızca çıkış. Yedek, şu anda veritabanının harici olarak tutarlı bir kopyasını içermektedir. |
expire_time |
Yalnızca çıkış. Bu yedeğin süresinin dolacağı zaman damgası. |
state |
Yalnızca çıkış. Yedeğin mevcut durumu. |
Eyalet
Yedeğin mevcut durumunu belirtin.
Sıralamalar | |
---|---|
STATE_UNSPECIFIED |
Durum belirtilmemiş. |
CREATING |
Beklemedeki yedek hâlâ oluşturuluyor. Yedeklemeyle ilgili işlemler bu durumda reddedilir. |
READY |
Yedekleme tamamlandı ve kullanıma hazır. |
NOT_AVAILABLE |
Yedekleme şu anda kullanılamıyor. |
Yedekleme Planlaması
Cloud Firestore Veritabanı için yedekleme planı.
Bu kaynak, yedeklediği veritabanına aittir ve veritabanıyla birlikte silinir. Ancak gerçek yedekler aynı değildir.
Alanlar | |
---|---|
name |
Yalnızca çıkış. Belirli bir proje için tüm konumlar ve veritabanlarındaki benzersiz yedekleme programı tanımlayıcısı. Bu, otomatik olarak atanacak. Biçim: |
create_time |
Yalnızca çıkış. Bu yedekleme planının oluşturulduğu ve o zamandan beri geçerli olduğu zaman damgası. Bu tarihten önce bu program için yedek oluşturulmayacak. |
update_time |
Yalnızca çıkış. Bu yedekleme programının en son güncellendiği zaman damgası. Yedekleme planı ilk oluşturulduğunda, create_time ile aynıdır. |
retention |
Yedeklemenin, oluşturulma zamanına kıyasla gelecekteki göreli herhangi bir zamanda silinmesi gerekir (ör. yedekleri 7 gün süreyle tutma). |
Birleştirme alanı recurrence . Yedeklerin ne zaman alınacağını temsil eden alanlardan biridir. recurrence şunlardan yalnızca biri olabilir: |
|
daily_recurrence |
Günlük olarak çalıştırılan bir program için. |
weekly_recurrence |
Haftalık olarak belirli bir günde çalışan bir program için. |
CreateBackupScheduleRequest
Alanlar | |
---|---|
parent |
Zorunlu. Üst veritabanı. Biçim |
backup_schedule |
Zorunlu. Oluşturulacak yedekleme programı. |
CreateDatabaseMetadata
Bu türde alan yok.
Veritabanı oluşturma işlemiyle ilgili meta veriler.
CreateDatabaseRequest
FirestoreAdmin.CreateDatabase
isteği.
Alanlar | |
---|---|
parent |
Zorunlu. |
database |
Zorunlu. Oluşturulacak Veritabanı. |
database_id |
Zorunlu. Veritabanı için kullanılacak kimlik. Bu kimlik, veritabanının kaynak adının son bileşeni olur. Bu değer 4 ila 63 karakter arasında olmalıdır. Geçerli karakterler, ilk karakteri bir harf, son karakteri ise bir harf veya rakam olmak üzere /[a-z][0-9]-/ şeklindedir. UUID benzeri /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ olmamalıdır. "(varsayılan)" veritabanı kimliği de geçerlidir. |
Dizin İsteği Oluşturma
FirestoreAdmin.CreateIndex
isteği.
Alanlar | |
---|---|
parent |
Zorunlu. |
index |
Zorunlu. Oluşturulacak bileşik dizin. |
GünlükYinelenme
Bu türde alan yok.
Her gün devam eden yinelenen bir programı temsil eder.
Saat dilimi UTC'dir.
Veritabanı
Cloud Firestore Veritabanı.
Alanlar | |
---|---|
name |
Veritabanının kaynak adı. Biçim: |
uid |
Yalnızca çıkış. Bu Veritabanı için sistem tarafından oluşturulan UUID4. |
create_time |
Yalnızca çıkış. Bu veritabanının oluşturulduğu zaman damgası. 2016'dan önce oluşturulan veritabanlarında create_time parametresi doldurulmaz. |
update_time |
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. |
location_id |
Veritabanının konumu. Özelliğin kullanılabildiği konumları https://cloud.google.com/firestore/docs/locations adresinde bulabilirsiniz. |
type |
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. |
concurrency_mode |
Bu veritabanı için kullanılacak eşzamanlılık kontrol modu. |
version_retention_period |
Yalnızca çıkış. Verilerin eski sürümlerinin veritabanında saklandığı dönem. Herhangi bir PITR özelliği etkinse saklama süresi 7 gündür. Aksi takdirde saklama süresi 1 saattir. |
earliest_version_time |
Yalnızca çıkış. Verilerin eski sürümlerinin veritabanından okunabileceği en erken zaman damgası. Yukarıdaki [version_retention_period] bölümüne bakın. Bu alan 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. |
point_in_time_recovery_enablement |
Bu veritabanında PITR özelliğinin etkinleştirilip etkinleştirilmeyeceği. |
app_engine_integration_mode |
Bu veritabanı için kullanılacak App Engine entegrasyon modu. |
key_prefix |
Yalnızca çıkış. Bu veritabanı için key_prefix. Bu key_prefix, 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 (" Bu değer boş olabilir. Böyle bir durumda, URL kodlamalı anahtarlar için kullanılacak appid proje_kimliğidir (ör. v~foo yerine foo). |
delete_protection_state |
Veritabanı için silme korumasının durumu. |
cmek_config |
İsteğe bağlı. Mevcut olması, CMEK'nin bu veritabanı için etkin olduğunu gösterir. |
etag |
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. |
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. |
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.
Alanlar | |
---|---|
kms_key_name |
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: |
active_key_version[] |
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: |
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. |
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. |
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 |
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:
Desteklenen sürümleri belirlemek için |
POINT_IN_TIME_RECOVERY_DISABLED |
Okumalar, son 1 saat içindeki verilerin herhangi bir sürümünde desteklenir. |
SilmeYedekleme İsteği
FirestoreAdmin.DeleteBackup
isteği.
Alanlar | |
---|---|
name |
Zorunlu. Silinecek yedeğin adı. biçimi şöyledir: |
DeleteBackupScheduleRequest
[FirestoreAdmin.DeleteBackupSchedules][] isteği.
Alanlar | |
---|---|
name |
Zorunlu. Yedekleme planının adı. Biçim |
DeleteDatabaseMetadata
Bu türde alan yok.
Veritabanı silme işlemiyle ilgili meta veriler.
DeleteDatabaseRequest
FirestoreAdmin.DeleteDatabase
isteği.
Alanlar | |
---|---|
name |
Zorunlu. |
etag |
Veritabanının geçerli etag'i. Bir etag sağlanır ve veritabanının mevcut durumu ile eşleşmezse silme işlemi engellenir ve FAILED_PRECONDITION hatası döndürülür. |
DeleteIndexRequest
FirestoreAdmin.DeleteIndex
isteği.
Alanlar | |
---|---|
name |
Zorunlu. |
ExportDocumentsMetadata
FirestoreAdmin.ExportDocuments
verisindeki google.longrunning.Operation
sonuçları meta verileri.
Alanlar | |
---|---|
start_time |
Bu işlemin başladığı saat. |
end_time |
Bu işlemin tamamlandığı saat. İşlem hâlâ devam ediyorsa ayarı iptal edilir. |
operation_state |
Dışa aktarma işleminin durumu. |
progress_documents |
Bu işlemin ilerleme durumu (belgelerde). |
progress_bytes |
Bu işlemin bayt cinsinden ilerleme durumu. |
collection_ids[] |
Dışa aktarılan koleksiyon kimlikleri. |
output_uri_prefix |
Dokümanların dışa aktarıldığı hedef. |
namespace_ids[] |
Dışa aktarılan ad alanı kimlikleri. |
snapshot_time |
Dışa aktarılan veritabanının sürümüne karşılık gelen zaman damgası. Bu değer belirtilmediğinde, dışa aktarılan dokümanların tutarlılığı konusunda herhangi bir garanti verilmez. |
Belgeleri Dışa Aktarma İsteği
FirestoreAdmin.ExportDocuments
isteği.
Alanlar | |
---|---|
name |
Zorunlu. Dışa aktarılacak veritabanı. |
collection_ids[] |
Dışa aktarılacak koleksiyon kimlikleri. Belirtilmemiş ifadesi, tüm koleksiyonlar anlamına gelir. |
output_uri_prefix |
Çıkış URI'sı. Şu anda yalnızca |
namespace_ids[] |
Boş bir liste tüm ad alanlarını temsil eder. Bu, ad alanları kullanmayan veritabanları için tercih edilen kullanımdır. Boş bir dize öğesi, varsayılan ad alanını temsil eder. Veritabanının varsayılan olmayan ad alanlarında verileri varsa ancak bunları dahil etmek istemiyorsa bu seçenek kullanılmalıdır. Bu listedeki her ad alanı benzersiz olmalıdır. |
snapshot_time |
Dışa aktarılacak veritabanının sürümüne karşılık gelen zaman damgası. Zaman damgası geçmişte olmalı, dakikaya yuvarlanmış ve en fazla |
ExportDocumentsResponse
google.longrunning.Operation
yanıt alanında döndürülür.
Alanlar | |
---|---|
output_uri_prefix |
Çıkış dosyalarının konumu. Bu anahtar, işlem başarıyla tamamlandıktan sonra Cloud Firestore'a (bu proje veya başka bir proje) içe aktarma işlemini başlatmak için kullanılabilir. |
Alan
Veritabanındaki tek bir alanı temsil eder.
Alanlar, veritabanındaki aynı kimliğe sahip tüm koleksiyonları temsil eden "Koleksiyon Grubu"na göre gruplandırılır.
Alanlar | |
---|---|
name |
Zorunlu. Alan yolu, basit bir alan adı (ör. Alan yolları, Örnekler: (Not: Buradaki yorumlar, markdown söz dizimiyle yazılır. Bu nedenle, bir kod bloğunu temsil eden ek bir vurgu işareti katmanı vardır) Özel bir |
index_config |
Bu alan için dizin yapılandırması. Politika ayarlanmadan bırakılırsa alan dizine ekleme işlemi, |
ttl_config |
Bu |
IndexConfig
Bu alan için dizin yapılandırması.
Alanlar | |
---|---|
indexes[] |
Bu alanda desteklenen dizinler. |
uses_ancestor_config |
Yalnızca çıkış. Doğru değerine ayarlanırsa |
ancestor_field |
Yalnızca çıkış. Bu alanın dizin yapılandırmasının ayarlandığı ( |
reverting |
Yalnızca çıkış Doğru değerine ayarlandığında |
TtlConfig
Bu Field
öğesinin ayarlandığı dokümanlar için TTL (geçerlilik süresi) yapılandırması.
Zaman damgası değerinin TTL'nin etkin olduğu bir alana depolanması, dokümanın mutlak geçerlilik süresi olarak değerlendirilir. Geçmişteki zaman damgası değerleri, belgenin anında geçerlilik bitiş tarihi için uygun olduğunu gösterir. Başka bir veri türünün kullanılması veya alanın boş bırakılması, söz konusu doküman için geçerlilik süresinin devre dışı bırakılmasına neden olur.
Alanlar | |
---|---|
state |
Yalnızca çıkış. TTL yapılandırmasının durumu. |
Eyalet
TTL yapılandırmasının tüm dokümanlara uygulanma durumu.
Sıralamalar | |
---|---|
STATE_UNSPECIFIED |
Durum belirtilmemiş veya bilinmiyor. |
CREATING |
TTL uygulanıyor. Değişikliği izlemek için uzun süreli etkin bir işlem vardır. Yeni yazılan dokümanlara, istendiği gibi TTL'ler uygulanır. Mevcut dokümanlardaki istenen TTL'ler işlenmeye devam etmektedir. Mevcut tüm dokümanların TTL'leri işlendiğinde durum "ACTIVE" olarak değişir. |
ACTIVE |
TTL tüm dokümanlar için etkindir. |
NEEDS_REPAIR |
TTL yapılandırması mevcut tüm dokümanlar için etkinleştirilemedi. Yeni yazılan dokümanların TTL'si uygulanmaya devam eder. Bu Field için TTL'yi etkinleştirme girişiminde bulunulduğu son LRO başarısız oldu ve daha fazla ayrıntı içerebilir. |
FieldOperationMetadata
FirestoreAdmin.UpdateField
verisindeki google.longrunning.Operation
sonuçları meta verileri.
Alanlar | |
---|---|
start_time |
Bu işlemin başladığı saat. |
end_time |
Bu işlemin tamamlandığı saat. İşlem hâlâ devam ediyorsa ayarı iptal edilir. |
field |
Bu işlemin üzerinde işlem yaptığı alan kaynağı. Örneğin: |
index_config_deltas[] |
Bu işlemin amacını açıklayan |
state |
İşlemin durumu. |
progress_documents |
Bu işlemin ilerleme durumu (belgelerde). |
progress_bytes |
Bu işlemin bayt cinsinden ilerleme durumu. |
ttl_config_delta |
TTL yapılandırmasının deltalarını açıklar. |
IndexConfigDelta
Dizin yapılandırması değişikliği ile ilgili bilgiler.
Alanlar | |
---|---|
change_type |
Dizinin nasıl değiştiğini belirtir. |
index |
Değiştirilmekte olan dizin. |
ChangeType
Dizinin nasıl değiştiğini belirtir.
Sıralamalar | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Değişikliğin türü belirtilmemiş veya bilinmiyor. |
ADD |
Tek alan dizini ekleniyor. |
REMOVE |
Tek alan dizini kaldırılıyor. |
TtlConfigDelta
TTL yapılandırması değişikliğiyle ilgili bilgi.
Alanlar | |
---|---|
change_type |
TTL yapılandırmasının nasıl değiştirileceğini belirtir. |
ChangeType
TTL yapılandırmasının nasıl değiştirileceğini belirtir.
Sıralamalar | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Değişikliğin türü belirtilmemiş veya bilinmiyor. |
ADD |
TTL yapılandırması ekleniyor. |
REMOVE |
TTL yapılandırması kaldırılıyor. |
GetBackupRequest
FirestoreAdmin.GetBackup
isteği.
Alanlar | |
---|---|
name |
Zorunlu. Getirilecek yedeğin adı. Biçim: |
GetBackupScheduleRequest
FirestoreAdmin.GetBackupSchedule
isteği.
Alanlar | |
---|---|
name |
Zorunlu. Yedekleme planının adı. Biçim |
GetDatabaseRequest
FirestoreAdmin.GetDatabase
isteği.
Alanlar | |
---|---|
name |
Zorunlu. |
GetFieldRequest
FirestoreAdmin.GetField
isteği.
Alanlar | |
---|---|
name |
Zorunlu. |
GetIndexRequest
FirestoreAdmin.GetIndex
isteği.
Alanlar | |
---|---|
name |
Zorunlu. |
ImportDocumentsMetadata
FirestoreAdmin.ImportDocuments
verisindeki google.longrunning.Operation
sonuçları meta verileri.
Alanlar | |
---|---|
start_time |
Bu işlemin başladığı saat. |
end_time |
Bu işlemin tamamlandığı saat. İşlem hâlâ devam ediyorsa ayarı iptal edilir. |
operation_state |
İçe aktarma işleminin durumu. |
progress_documents |
Bu işlemin ilerleme durumu (belgelerde). |
progress_bytes |
Bu işlemin bayt cinsinden ilerleme durumu. |
collection_ids[] |
Hangi koleksiyon kimliklerinin içe aktarıldığı. |
input_uri_prefix |
İçe aktarılan dokümanların konumu. |
namespace_ids[] |
Hangi ad alanı kimliklerinin içe aktarıldığı. |
Belgeleri İçe Aktarma İsteği
FirestoreAdmin.ImportDocuments
isteği.
Alanlar | |
---|---|
name |
Zorunlu. İçe aktarılacak veritabanı. |
collection_ids[] |
İçe aktarılacak koleksiyon kimlikleri. Belirtilmemiş ifadesi, içe aktarmaya dahil edilen tüm koleksiyonlar anlamına gelir. |
input_uri_prefix |
Dışa aktarılan dosyaların konumu. Bu değer, başarıyla tamamlanan bir dışa aktarmadaki ExportDocumentsResponse'un exit_uri_prefix değeriyle eşleşmelidir. Şu sayfaya göz atın: |
namespace_ids[] |
Boş bir liste tüm ad alanlarını temsil eder. Bu, ad alanları kullanmayan veritabanları için tercih edilen kullanımdır. Boş bir dize öğesi, varsayılan ad alanını temsil eder. Veritabanının varsayılan olmayan ad alanlarında verileri varsa ancak bunları dahil etmek istemiyorsa bu seçenek kullanılmalıdır. Bu listedeki her ad alanı benzersiz olmalıdır. |
Dizin
Cloud Firestore dizinleri, veritabanındaki belgelerde basit ve karmaşık sorgular yapılmasını sağlar.
Alanlar | |
---|---|
name |
Yalnızca çıkış. Bu dizin için sunucu tarafından tanımlanan bir ad. Bileşik dizinler için bu adın biçimi şu şekildedir: |
query_scope |
Koleksiyon sorgusu kapsamının belirtildiği dizinler, belirli bir belgenin alt öğesi olan, sorgu sırasında belirtilen ve aynı koleksiyon kimliğine sahip bir koleksiyonda sorgulara izin verir. Koleksiyon grubu sorgu kapsamına sahip olan dizinler, belirli bir belgeden türetilmiş olan, sorgu sırasında belirtilen ve bu dizinle aynı koleksiyon kimliğine sahip olan tüm koleksiyonlarda yapılan sorgulara izin verir. |
api_scope |
Bu dizin tarafından desteklenen API kapsamı. |
fields[] |
Bu dizin tarafından desteklenen alanlar. Bileşik dizinler için bu, en az 2 ve en fazla 100 alan gerektirir. Son alan girişi her zaman Tek alan dizinlerinde bu, her zaman ilişkili alanın alan yoluna eşit bir alan yoluna sahip tam olarak tek bir giriş olacaktır. |
state |
Yalnızca çıkış. Dizinin sunulma durumu. |
ApiScope
API Kapsamı, sorgular için desteklenen API'leri (Yerel Etiket veya Datastore Modunda Firestore) tanımlar.
Sıralamalar | |
---|---|
ANY_API |
Dizin yalnızca Firestore Yerel sorgu API'si tarafından kullanılabilir. Bu, varsayılan ayardır. |
DATASTORE_MODE_API |
Dizin yalnızca Datastore Modu'nda Firestore sorgu API'si tarafından kullanılabilir. |
DizinAlanı
Dizindeki bir alan. field_path hangi alanın dizine eklendiğini, value_mode ise alan değerinin nasıl dizine eklendiğini açıklar.
Alanlar | |
---|---|
field_path |
Ad olabilir. Tek alan dizinleri için bu ad, alanın adıyla eşleşmelidir veya atlanabilir. |
Birleştirme alanı value_mode . Alan değerinin dizine eklenme şekli. value_mode şunlardan yalnızca biri olabilir: |
|
order |
Bu alanın, belirtilen sıraya göre sıralamayı veya =, !=, <, <=, >, >= kullanarak karşılaştırma yapmayı desteklediğini belirtir. |
array_config |
Bu alanın, |
vector_config |
Bu alanın, vektör üzerinde en yakın komşu ve mesafe işlemlerini desteklediğini belirtir. |
ArrayConfig
Desteklenen dizi değeri yapılandırmaları.
Sıralamalar | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
Dizin, ek dizi sorgularını desteklemiyor. |
CONTAINS |
Dizin, dizi kapsama sorgularını destekler. |
Sipariş
Desteklenen siparişler.
Sıralamalar | |
---|---|
ORDER_UNSPECIFIED |
Sıralama belirtilmedi. Geçerli bir seçenek değil. |
ASCENDING |
Alan, artan alan değerine göre sıralanır. |
DESCENDING |
Alan, azalan alan değerine göre sıralanır. |
VectorConfig
Vektör arama işlemlerini desteklemek için dizin yapılandırması
Alanlar | |
---|---|
dimension |
Zorunlu. Bu yapılandırmanın geçerli olduğu vektör boyutu. Sonuç olarak elde edilen dizin, yalnızca bu boyuttaki vektörleri içerir ve aynı boyuta sahip vektör araması için kullanılabilir. |
Birleştirme alanı type . Kullanılan dizin türü. type şunlardan yalnızca biri olabilir: |
|
flat |
Vektör dizininin düz bir dizin olduğunu gösterir. |
FlatEndeks
Bu türde alan yok.
Vektörleri düz veri yapısında depolayan ve kapsamlı aramayı destekleyen bir dizin.
QueryScope
Sorgu Kapsamı, sorgunun çalıştırıldığı kapsamı tanımlar. Bu değer, Yapılandırılmış Sorgu'nun from
alanında belirtilir.
Sıralamalar | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
Sorgu kapsamı belirtilmedi. Geçerli bir seçenek değil. |
COLLECTION |
Koleksiyon sorgusu kapsamının belirtildiği dizinler, sorgu zamanında belirtilen ve dizin tarafından belirtilen koleksiyon kimliğine sahip belirli bir belgenin alt öğesi olan bir koleksiyonda sorgulara izin verir. |
COLLECTION_GROUP |
Koleksiyon grubu sorgu kapsamının belirtildiği dizinler, dizin tarafından belirtilen koleksiyon kimliğine sahip tüm koleksiyonlarda yapılan sorgulara izin verir. |
COLLECTION_RECURSIVE |
Tüm koleksiyonların üst öğesini dizine dahil et. Yalnızca Datastore Modundaki veritabanları için kullanılabilir. |
Eyalet
Bir dizinin durumudur. Dizin oluşturma sırasında, bir dizin CREATING
durumunda olur. Dizin başarıyla oluşturulursa READY
durumuna geçer. Dizin oluşturma işlemi bir sorunla karşılaşırsa dizin NEEDS_REPAIR
durumuna geçer.
Sıralamalar | |
---|---|
STATE_UNSPECIFIED |
Durum belirtilmemiş. |
CREATING |
Dizin oluşturuluyor. Dizin için uzun süreli etkin bir işlem mevcut. Doküman yazılırken dizin güncellenir. Bazı dizin verileri mevcut olabilir. |
READY |
Dizin kullanıma hazır. Doküman yazılırken dizin güncellenir. Dizin, geçerli olduğu tüm depolanan dokümanlardan tamamen doldurulur. |
NEEDS_REPAIR |
Dizin oluşturuluyor ancak bir sorun oluştu. Dizin için etkin bir uzun süreli işlem yok ve en son tamamlanan uzun süreli işlem başarısız oldu. Doküman yazılırken dizin güncellenmez. Bazı dizin verileri mevcut olabilir. Bu dizini oluşturmaya çalışan en son işlemin neden başarısız olduğunu belirlemek için google.longRun.İşlemler API'sını kullanın ve dizini yeniden oluşturun. |
IndexOperationMetadata
FirestoreAdmin.CreateIndex
verisindeki google.longrunning.Operation
sonuçları meta verileri.
Alanlar | |
---|---|
start_time |
Bu işlemin başladığı saat. |
end_time |
Bu işlemin tamamlandığı saat. İşlem hâlâ devam ediyorsa ayarı iptal edilir. |
index |
Bu işlemin üzerinde işlem yaptığı dizin kaynağı. Örneğin: |
state |
İşlemin durumu. |
progress_documents |
Bu işlemin ilerleme durumu (belgelerde). |
progress_bytes |
Bu işlemin bayt cinsinden ilerleme durumu. |
ListYedekPlanları İsteği
Alanlar | |
---|---|
parent |
Zorunlu. Üst veritabanı. Biçim: |
ListBackupSchedulesResponse
FirestoreAdmin.ListBackupSchedules
için yanıt.
Alanlar | |
---|---|
backup_schedules[] |
Tüm yedekleme programlarının listesi. |
ListeYedekleme İsteği
FirestoreAdmin.ListBackups
isteği.
Alanlar | |
---|---|
parent |
Zorunlu. Yedeklemelerin listeleneceği konum. Biçim: |
Yedek Listeleme Yanıtı
FirestoreAdmin.ListBackups
için yanıt.
Alanlar | |
---|---|
backups[] |
Projedeki tüm yedeklerin listesi. |
unreachable[] |
Mevcut yedeklerin getirilemediği konumların listesi. Bu yanıt, tek bir konuma erişilemediğinde isteklerin tamamında başarısız olmak yerine kısmi bir sonuç kümesi ve burada erişilemeyen konumların listesini döndürür. İstek, somut bir hata almak için tek bir konum için yeniden denenebilir. |
Liste Veritabanları İsteği
Bir projenin tüm konumlardaki Firestore Veritabanlarını listeleme isteği.
Alanlar | |
---|---|
parent |
Zorunlu. |
Liste Veritabanları Yanıtı
Bir projeye ait veritabanlarının listesi.
Alanlar | |
---|---|
databases[] |
Projedeki veritabanları. |
unreachable[] |
Bağımsız veritabanlarıyla ilgili verilerin listelenememesi halinde, bu veriler buraya kaydedilir. Örnek giriş şu şekilde olabilir: projects/some_project/locations/some_location Bu durum, Veritabanının bulunduğu Cloud Region şu anda kullanılamıyorsa ortaya çıkabilir. Bu durumda, veritabanıyla ilgili tüm ayrıntıları getiremeyiz. Kaynak için "Al" isteği veya belirli bir konum için "Liste" isteği göndererek daha ayrıntılı bir hata mesajı alabilirsiniz (veya kaynağı alabilirsiniz). |
Liste Alanları İsteği
FirestoreAdmin.ListFields
isteği.
Alanlar | |
---|---|
parent |
Zorunlu. |
filter |
Liste sonuçlarına uygulanacak filtre. |
page_size |
Döndürülecek sonuç sayısı. |
page_token |
Önceki bir |
Liste Alanları Yanıtı
FirestoreAdmin.ListFields
için yanıt.
Alanlar | |
---|---|
fields[] |
İstenen alanlar. |
next_page_token |
Başka bir sonuç sayfası istemek için kullanılabilecek bir sayfa jetonu. Boşsa bu son sayfadır. |
Liste Dizini İsteği
FirestoreAdmin.ListIndexes
isteği.
Alanlar | |
---|---|
parent |
Zorunlu. |
filter |
Liste sonuçlarına uygulanacak filtre. |
page_size |
Döndürülecek sonuç sayısı. |
page_token |
Önceki bir |
Dizin Dizini Yanıtlarını Listeleyin
FirestoreAdmin.ListIndexes
için yanıt.
Alanlar | |
---|---|
indexes[] |
İstenen dizinler. |
next_page_token |
Başka bir sonuç sayfası istemek için kullanılabilecek bir sayfa jetonu. Boşsa bu son sayfadır. |
LocationMetadata
Bu türde alan yok.
google.cloud.location.Location.metadata
için meta veri mesajı.
OperationState
İşlemin durumunu açıklar.
Sıralamalar | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Belirtilmedi. |
INITIALIZING |
İstek işlenmek üzere hazırlanıyor. |
PROCESSING |
İstek etkin olarak işleniyor. |
CANCELLING |
Kullanıcı, işlemde google.long running.Operations.Canceloperas adlı kullanıcıyı çağırdıktan sonra istek iptal edilme sürecindedir. |
FINALIZING |
İstek işlendi ve kesinleşme aşamasında. |
SUCCESSFUL |
İstek başarıyla tamamlandı. |
FAILED |
İsteğin işlenmesi tamamlandı, ancak bir hatayla karşılaşıldı. |
CANCELLED |
Kullanıcının google.longusercontent.Transactions.Canceloperasyonu çağırmasının ardından istek iptal edildi. |
İlerleme
İşlemin ilerlemesini açıklar. Çalışma birimi geneldir ve Progress
kullanıldığı yere göre yorumlanmalıdır.
Alanlar | |
---|---|
estimated_work |
Tahmin edilen iş miktarı. |
completed_work |
Tamamlanan çalışma miktarı. |
RestoreDatabaseMetadata
[RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] isteğindeki long-running operation
meta verisi.
Alanlar | |
---|---|
start_time |
Geri yüklemenin başlatıldığı zaman. |
end_time |
Geri yüklemenin sona erdiği zaman. Devam eden geri yükleme işlemleri için ayarı kaldırıldı. |
operation_state |
Geri yüklemenin işlem durumu. |
database |
Geri yüklenecek veritabanının adı. |
backup |
Geri yüklemenin yapıldığı yedeğin adı. |
progress_percentage |
Geri yükleme işleminin, kalan sürenin tahmini yüzdesi olarak ne kadar olduğu. |
Geri YüklemeDatabaseRequest
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] için istek mesajı.
Alanlar | |
---|---|
parent |
Zorunlu. Veritabanının geri yükleneceği proje. Biçim: |
database_id |
Zorunlu. Veritabanı için kullanılacak kimlik. Bu kimlik, veritabanının kaynak adının son bileşeni olur. Bu veritabanı kimliği, mevcut bir veritabanıyla ilişkilendirilmemelidir. Bu değer 4 ila 63 karakter arasında olmalıdır. Geçerli karakterler, ilk karakteri bir harf, son karakteri ise bir harf veya rakam olmak üzere /[a-z][0-9]-/ şeklindedir. UUID benzeri /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ olmamalıdır. "(varsayılan)" veritabanı kimliği de geçerlidir. |
Birleştirme alanı
|
|
backup |
Geri yükleme için kullanılacak yedekleme'ye dokunun. Üst kuruluşla aynı projeye ait olmalıdır. Biçim: |
UpdateBackupScheduleRequest
Alanlar | |
---|---|
backup_schedule |
Zorunlu. Güncellenecek yedekleme programı. |
update_mask |
Güncellenecek alanların listesi. |
UpdateDatabaseMetadata
Bu türde alan yok.
Veritabanı güncelleme işlemiyle ilgili meta veriler.
UpdateDatabaseRequest
FirestoreAdmin.UpdateDatabase
isteği.
Alanlar | |
---|---|
database |
Zorunlu. Güncellenecek veritabanı. |
update_mask |
Güncellenecek alanların listesi. |
UpdateFieldRequest
FirestoreAdmin.UpdateField
isteği.
Alanlar | |
---|---|
field |
Zorunlu. Güncellenecek alan. |
update_mask |
Alana göre bir maske. Belirtilirse alanda yalnızca bu field_mask ile belirtilen yapılandırma güncellenir. |
Haftalık Yinelenme
Haftanın belirli bir gününde çalıştırılan yinelenen bir programı temsil eder.
Saat dilimi UTC'dir.
Alanlar | |
---|---|
day |
Yayınlanmak üzere haftanın günü. DAY_OF_WEEK_UNSPECIFIED öğesine izin verilmiyor. |