Method: projects.databases.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. 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.

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ı. projects/{projectId}/databases/{databaseId} biçiminde olmalıdır.

İstek içeriği

İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:

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

string

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

string

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

string

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.
snapshotTime

string (Timestamp format)

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 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ığı konusunda herhangi bir garanti verilmez.

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".

Yanıt gövdesi

Başarılıysa yanıt metni, 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ış sayfasına göz atın.