Method: projects.databases.exportDocuments

یک کپی از همه یا زیر مجموعه ای از اسناد را از Google Cloud Firestore به سیستم ذخیره سازی دیگری مانند Google Cloud Storage صادر می کند. به‌روزرسانی‌های اخیر اسناد ممکن است در صادرات منعکس نشود. صادرات در پس‌زمینه اتفاق می‌افتد و می‌توان پیشرفت آن را از طریق منبع عملیاتی ایجاد شده کنترل و مدیریت کرد. خروجی یک صادرات فقط زمانی می تواند مورد استفاده قرار گیرد که عملیات مربوطه انجام شود. اگر عملیات صادرات قبل از تکمیل لغو شود، ممکن است داده‌های جزئی در Google Cloud Storage باقی بماند.

برای جزئیات بیشتر در مورد رفتار صادرات و قالب خروجی، مراجعه کنید: https://cloud.google.com/firestore/docs/manage-data/export-import

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
name

string

ضروری. پایگاه داده برای صادرات باید به این شکل باشد: projects/{projectId}/databases/{databaseId} .

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
زمینه های
collectionIds[]

string

کدام شناسه مجموعه را صادر کنیم. نامشخص یعنی همه مجموعه ها.

outputUriPrefix

string

URI خروجی در حال حاضر فقط از URIهای Google Cloud Storage به شکل: gs://BUCKET_NAME[/NAMESPACE_PATH] پشتیبانی می‌کند، که در آن BUCKET_NAME نام سطل Google Cloud Storage و NAMESPACE_PATH یک مسیر فضای نام فضای ذخیره‌سازی ابری Google اختیاری است. هنگام انتخاب نام، حتماً دستورالعمل‌های نام‌گذاری Google Cloud Storage را در نظر بگیرید: https://cloud.google.com/storage/docs/name . اگر URI یک سطل (بدون مسیر فضای نام) باشد، یک پیشوند بر اساس زمان شروع ایجاد می شود.

namespaceIds[]

string

یک لیست خالی همه فضاهای نام را نشان می دهد. این استفاده ارجح برای پایگاه داده هایی است که از فضای نام استفاده نمی کنند.

یک عنصر رشته خالی نشان دهنده فضای نام پیش فرض است. اگر پایگاه داده دارای داده‌هایی در فضای نام غیر پیش‌فرض است، اما نمی‌خواهد آنها را شامل شود، باید از این مورد استفاده شود. هر فضای نام در این لیست باید منحصر به فرد باشد.

snapshotTime

string ( Timestamp format)

مهر زمانی که مربوط به نسخه پایگاه داده ای است که باید صادر شود. مهر زمان باید در گذشته باشد، به دقیقه گرد شده و از earliestVersionTime قدیمی تر نباشد. در صورت مشخص شدن، اسناد صادر شده نمایانگر یک نمای ثابت از پایگاه داده در زمان ارائه شده خواهد بود. در غیر این صورت، هیچ تضمینی در مورد یکنواختی اسناد صادراتی وجود ندارد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Operation است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.