REST Resource: projects.databases

منبع: پایگاه داده

یک پایگاه داده Cloud Firestore.

نمایندگی JSON
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "etag": string
}
زمینه های
name

string

نام منبع پایگاه داده قالب: projects/{project}/databases/{database}

uid

string

فقط خروجی UUID4 تولید شده توسط سیستم برای این پایگاه داده.

createTime

string ( Timestamp format)

فقط خروجی مهر زمانی که این پایگاه داده در آن ایجاد شده است. پایگاه‌های داده‌ای که قبل از سال ۲۰۱۶ ایجاد شده‌اند، CreTime را پر نمی‌کنند.

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

updateTime

string ( Timestamp format)

فقط خروجی مهر زمانی که این پایگاه داده اخیراً به روز شده است. توجه داشته باشید که این فقط شامل به روز رسانی های منبع پایگاه داده است و نه داده های موجود در پایگاه داده.

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

locationId

string

محل پایگاه داده مکان‌های موجود در https://cloud.google.com/firestore/docs/locations فهرست شده‌اند.

type

enum ( DatabaseType )

نوع پایگاه داده برای اطلاعات در مورد نحوه انتخاب به https://cloud.google.com/datastore/docs/firestore-or-datastore مراجعه کنید.

concurrencyMode

enum ( ConcurrencyMode )

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

versionRetentionPeriod

string ( Duration format)

فقط خروجی دوره ای که طی آن نسخه های گذشته داده ها در پایگاه داده نگهداری می شوند.

هر read یا query می تواند یک readTime در این پنجره مشخص کند و وضعیت پایگاه داده را در آن زمان می خواند.

اگر ویژگی PITR فعال باشد، دوره نگهداری 7 روز است. در غیر این صورت مدت نگهداری 1 ساعت است.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

earliestVersionTime

string ( Timestamp format)

فقط خروجی اولین مهر زمانی که در آن می توان نسخه های قدیمی داده ها را از پایگاه داده خواند. [versionRetentionPeriod] را در بالا ببینید. این فیلد با now - versionRetentionPeriod پر شده است.

این مقدار به طور مداوم به روز می شود و در لحظه ای که از آن پرس و جو می شود بیات می شود. اگر از این مقدار برای بازیابی داده ها استفاده می کنید، مطمئن شوید که از لحظه درخواست مقدار تا لحظه شروع بازیابی، زمان را در نظر بگیرید.

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

pointInTimeRecoveryEnablement

enum ( PointInTimeRecoveryEnablement )

فعال کردن ویژگی PITR در این پایگاه داده.

appEngineIntegrationMode

enum ( AppEngineIntegrationMode )

حالت یکپارچه سازی App Engine برای استفاده برای این پایگاه داده.

keyPrefix

string

فقط خروجی کلید پیشوند برای این پایگاه داده. این کلید پیشوند در ترکیب با شناسه پروژه (" ~ ") برای ساخت شناسه برنامه که از APIهای Cloud Datastore در زمان اجراهای نسل اول Google App Engine بازگردانده می شود.

این مقدار ممکن است خالی باشد، در این صورت اپلیکیشنی که برای کلیدهای کدگذاری شده با URL استفاده می‌شود، projectId است (به عنوان مثال: foo به جای v~foo).

deleteProtectionState

enum ( DeleteProtectionState )

وضعیت حفاظت از حذف برای پایگاه داده.

etag

string

این چک‌سوم توسط سرور بر اساس مقدار فیلدهای دیگر محاسبه می‌شود و ممکن است در درخواست‌های به‌روزرسانی و حذف ارسال شود تا اطمینان حاصل شود که مشتری قبل از ادامه، مقدار به‌روزی دارد.

نوع پایگاه داده

نوع پایگاه داده برای اطلاعات در مورد نحوه انتخاب به https://cloud.google.com/datastore/docs/firestore-or-datastore مراجعه کنید.

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

Enums
DATABASE_TYPE_UNSPECIFIED مقدار پیش فرض اگر نوع پایگاه داده حذف شده باشد از این مقدار استفاده می شود.
FIRESTORE_NATIVE حالت بومی Firestore
DATASTORE_MODE Firestore در حالت Datastore.

حالت همزمانی

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

Enums
CONCURRENCY_MODE_UNSPECIFIED استفاده نشده.
OPTIMISTIC به طور پیش فرض از کنترل همزمان خوش بینانه استفاده کنید. این حالت برای پایگاه داده های Cloud Firestore در دسترس است.
PESSIMISTIC

به طور پیش فرض از کنترل همزمان بدبینانه استفاده کنید. این حالت برای پایگاه داده های Cloud Firestore در دسترس است.

این تنظیم پیش فرض برای Cloud Firestore است.

OPTIMISTIC_WITH_ENTITY_GROUPS

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

این تنها حالت موجود برای Cloud Datastore است.

این حالت برای Cloud Firestore با حالت Datastore نیز موجود است اما توصیه نمی شود.

PointInTimeRecoveryEnablement

فعال کردن ویژگی Point In Time Recovery.

Enums
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED استفاده نشده.
POINT_IN_TIME_RECOVERY_ENABLED

خواندن در نسخه‌های انتخابی داده‌ها در ۷ روز گذشته پشتیبانی می‌شود:

  • در مقابل هر مهر زمانی در یک ساعت گذشته خوانده می شود
  • در مقابل عکس‌های فوری ۱ دقیقه‌ای بیش از ۱ ساعت و در عرض ۷ روز می‌خواند

برای تعیین نسخه های پشتیبانی شده می توان از versionRetentionPeriod و earliestVersionTime استفاده کرد.

POINT_IN_TIME_RECOVERY_DISABLED خواندن در هر نسخه از داده ها در 1 ساعت گذشته پشتیبانی می شود.

AppEngineIntegrationMode

نوع حالت یکپارچه سازی App Engine.

Enums
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED استفاده نشده.
ENABLED اگر یک برنامه App Engine در همان منطقه این پایگاه داده وجود داشته باشد، پیکربندی App Engine بر این پایگاه داده تأثیر می گذارد. این شامل غیرفعال کردن برنامه و پایگاه داده و همچنین غیرفعال کردن نوشتن در پایگاه داده است.
DISABLED

App Engine هیچ تاثیری بر توانایی این پایگاه داده برای ارائه درخواست ها ندارد.

این تنظیمات پیش‌فرض برای پایگاه‌های داده ایجاد شده با Firestore API است.

DeleteProtectionState

وضعیت حفاظتی حذف پایگاه داده

Enums
DELETE_PROTECTION_STATE_UNSPECIFIED مقدار پیش فرض نوع حفاظت حذف مشخص نشده است
DELETE_PROTECTION_DISABLED حفاظت حذف غیرفعال است
DELETE_PROTECTION_ENABLED حفاظت حذف فعال است

مواد و روش ها

create

 یک پایگاه داده ایجاد کنید.

delete

 پایگاه داده را حذف می کند.

exportDocuments

 یک کپی از همه یا زیر مجموعه ای از اسناد را از Google Cloud Firestore به سیستم ذخیره سازی دیگری مانند Google Cloud Storage صادر می کند.

get

 اطلاعاتی در مورد پایگاه داده دریافت می کند.

importDocuments

 اسناد را به Google Cloud Firestore وارد می کند.

list

 لیست تمام پایگاه های داده در پروژه.

patch

 پایگاه داده را به روز می کند.

restore

 یک پایگاه داده جدید با بازیابی از یک نسخه پشتیبان موجود ایجاد می کند.