Method: projects.databases.exportDocuments

Mengekspor salinan semua atau sebagian dokumen dari Google Cloud Firestore ke sistem penyimpanan lain, seperti Google Cloud Storage. Perubahan terbaru pada dokumen mungkin tidak ditampilkan dalam ekspor. Ekspor terjadi di latar belakang dan progresnya dapat dipantau serta dikelola melalui resource Operation yang dibuat. Output ekspor hanya dapat digunakan setelah operasi yang terkait selesai. Jika operasi ekspor dibatalkan sebelum selesai, sebagian data mungkin akan tertinggal di Google Cloud Storage.

Untuk detail selengkapnya tentang perilaku ekspor dan format output, lihat: https://cloud.google.com/firestore/docs/manage-data/export-import

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Database yang akan diekspor. Harus dalam bentuk: projects/{projectId}/databases/{databaseId}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
Kolom
collectionIds[]

string

ID koleksi yang akan diekspor. Tidak ditentukan berarti semua koleksi.
outputUriPrefix

string

URI output. Saat ini hanya mendukung URI Google Cloud Storage dalam bentuk: gs://BUCKET_NAME[/NAMESPACE_PATH], dengan BUCKET_NAME sebagai nama bucket Google Cloud Storage dan NAMESPACE_PATH sebagai jalur namespace Google Cloud Storage opsional. Saat memilih nama, pastikan untuk mempertimbangkan panduan penamaan Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Jika URI adalah bucket (tanpa jalur namespace), awalan akan dibuat berdasarkan waktu mulai.
namespaceIds[]

string

Daftar kosong mewakili semua namespace. Ini adalah penggunaan yang disarankan untuk database yang tidak menggunakan namespace.

Elemen string kosong mewakili namespace default. Ini harus digunakan jika database memiliki data dalam namespace non-default, tetapi tidak ingin menyertakannya. Setiap namespace dalam daftar ini harus unik.
snapshotTime

string (Timestamp format)

Stempel waktu yang sesuai dengan versi database yang akan diekspor. Stempel waktu harus berada di masa lampau, dibulatkan ke menit, dan tidak lebih lama dari earliestVersionTime. Jika ditentukan, dokumen yang diekspor akan mewakili tampilan database yang konsisten pada waktu yang diberikan. Jika tidak, tidak ada jaminan konsistensi dokumen yang diekspor.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Isi respons

Jika berhasil, isi respons akan berisi instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.