Method: projects.databases.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. Dokümanlarda yapılan son güncellemeler dışa aktarmaya yansıtılmayabilir. Dışa aktarma işlemi arka planda gerçekleştirilir. İşlemin ilerleme durumu, oluşturulan İşlem kaynağı aracılığıyla izlenip yönetilebilir. Dışa aktarma işleminin sonucu yalnızca ilişkili işlem tamamlandıktan sonra kullanılabilir. Bir dışa aktarma işlemi tamamlanmadan iptal edilirse Google Cloud Storage'da kısmi veriler kalabilir.

Dışa aktarma davranışı ve çıkış biçimi hakkında daha fazla bilgi için şu sayfaya bakın: https://cloud.google.com/firestore/docs/manage-data/export-import

HTTP isteği

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
name

string

Zorunlu. Dışa aktarılacak veritabanı. Şu biçimde olmalıdır: projects/{projectId}/databases/{databaseId}.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
Alanlar
collectionIds[]

string

Dışa aktarılacak koleksiyon kimlikleri. Belirtilmemiş, tüm koleksiyonlar anlamına gelir.
outputUriPrefix

string

Çıkış URI'si. Şu anda yalnızca gs://BUCKET_NAME[/NAMESPACE_PATH] biçimindeki Google Cloud Storage URI'leri desteklenmektedir. Burada BUCKET_NAME, Google Cloud Storage paketinin adıdır ve NAMESPACE_PATH ise isteğe bağlı Google Cloud Storage ad alanı yoludur. Ad seçerken Google Cloud Storage adlandırma yönergelerini dikkate almayı unutmayın: https://cloud.google.com/storage/docs/naming. URI (ad alanı yolu olmayan) bir paketse, başlangıç zamanına göre bir önek oluşturulur.
namespaceIds[]

string

Boş liste, tüm ad alanlarını temsil eder. Bu, ad alanı kullanmayan veritabanları için tercih edilen kullanımdır.

Boş dize öğesi, varsayılan ad alanını temsil eder. Veritabanı varsayılan olmayan ad alanlarında veri içeriyorsa ancak bu verilerin dahil edilmesini istemiyorsa bu kullanılmalıdır. Bu listedeki her ad alanı benzersiz olmalıdır.
snapshotTime

string (Timestamp format)

Dışa aktarılacak veritabanı sürümüne karşılık gelen zaman damgası. Zaman damgası geçmişte olmalı, dakikaya yuvarlanmalı ve en fazla earliestVersionTime olmalıdır. Belirtilirse dışa aktarılan dokümanlar, sağlanan zamanda veritabanının tutarlı bir görünümünü temsil eder. Aksi takdirde, dışa aktarılan dokümanların tutarlılığıyla ilgili bir garanti verilmez.

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

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, Operation öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleye bakın.