Method: projects.databases.exportDocuments

Dokümanların tamamının veya bir alt kümesinin bir kopyasını Google Cloud Firestore'dan Google Cloud Storage gibi başka bir depolama sistemine aktarır. Belgelerde yapılan son güncellemeler dışa aktarma işlemine yansıtılmayabilir. Dışa aktarma arka planda gerçekleşir ve ilerlemesi, oluşturulan Operasyon kaynağı aracılığıyla izlenebilir ve yönetilebilir. Bir dışa aktarmanın çıktısı yalnızca ilgili işlem tamamlandıktan sonra kullanılabilir. Bir dışa aktarma işlemi tamamlanmadan iptal edilirse, Google Bulut Depolama'da kısmi veriler kalabilir.

Dışa aktarma davranışı ve çıktı biçimi hakkında daha fazla ayrıntı için şu adrese 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özdizimini kullanır.

Yol parametreleri

Parametreler
name

string

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

Talep gövdesi

İ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

Hangi koleksiyon kimliklerinin dışa aktarılacağı. Belirtilmemiş tüm koleksiyonlar anlamına gelir.

outputUriPrefix

string

Çıkış URI'si. Şu anda yalnızca şu biçimdeki Google Cloud Storage URI'lerini desteklemektedir: gs://BUCKET_NAME[/NAMESPACE_PATH] ; burada BUCKET_NAME , Google Cloud Storage paketinin adıdır ve NAMESPACE_PATH isteğe bağlı bir Google Cloud Storage ad alanı yoludur. Bir ad seçerken Google Cloud Storage adlandırma yönergelerini göz önünde bulundurduğunuzdan emin olun: https://cloud.google.com/storage/docs/naming . URI bir paketse (ad alanı yolu yoksa), başlangıç ​​zamanına göre bir önek oluşturulacaktır.

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 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 earliestVersionTime değerinden daha eski olmamalıdır. Belirtilirse, dışa aktarılan belgeler belirtilen zamanda veritabanının tutarlı bir görünümünü temsil edecektir. Aksi takdirde ihraç edilen belgelerin tutarlılığı konusunda herhangi bir garanti verilmemektedir.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Ö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 örneğini içerir.

Yetki 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ış bölümüne bakın.