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),
  "cmekConfig": {
    object (CmekConfig)
  },
  "etag": string
}
الحقول
name

string

اسم مورد قاعدة البيانات. تنسيق الملف: projects/{project}/databases/{database}
uid

string

النتائج فقط. UUID4 الذي أنشأه النظام لقاعدة البيانات هذه.
createTime

string (Timestamp format)

النتائج فقط. الطابع الزمني الذي تم فيه إنشاء قاعدة البيانات هذه. لا تعمل قواعد البيانات التي تم إنشاؤها قبل عام 2016 على تعبئة createTime.

طابع زمني بتنسيق 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 أيام. وبخلاف ذلك، تكون فترة الاحتفاظ بالبيانات ساعة واحدة.

مدة بالثواني يصل عددها إلى تسعة أرقام كسرية وتنتهي بـ "s". مثال: "3.5s".
earliestVersionTime

string (Timestamp format)

النتائج فقط. أقرب طابع زمني يمكن عنده قراءة الإصدارات الأقدم من البيانات من قاعدة البيانات. يمكنك الاطّلاع على [versionBACKUPPeriod] أعلاه، حيث تتم تعبئة هذا الحقل بـ 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

النتائج فقط. keyPrefix لقاعدة البيانات هذه. يتم استخدام keyPrefix هذا مع رقم تعريف المشروع ("~") لإنشاء معرّف التطبيق الذي يتم عرضه من واجهات برمجة تطبيقات Cloud Datastore في أوقات تشغيل الجيل الأول من Google App Engine.

قد تكون هذه القيمة فارغة، وفي هذه الحالة يكون معرّف التطبيق المراد استخدامه للمفاتيح بترميز عنوان URL هو projectId (مثلاً: foo بدلاً من v~foo).
deleteProtectionState

enum (DeleteProtectionState)

حالة حماية الحذف لقاعدة البيانات.
cmekConfig

object (CmekConfig)

هذه السمة اختيارية. يشير التواجد إلى تفعيل CMEK لقاعدة البيانات هذه.
etag

string

يحسب الخادم هذا المجموع الاختباري بناءً على قيمة الحقول الأخرى، ويمكن إرساله عند طلبات التحديث والحذف للتأكد من أن العميل لديه قيمة حديثة قبل المتابعة.

نوع قاعدة البيانات

نوع قاعدة البيانات. يُرجى الانتقال إلى https://cloud.google.com/datastore/docs/firestore-or-datastore للحصول على معلومات حول كيفية الاختيار.

لا يُسمَح بتغييرات الوضع إلا إذا كانت قاعدة البيانات فارغة.

التعدادات
DATABASE_TYPE_UNSPECIFIED القيمة التلقائية. يتم استخدام هذه القيمة إذا تم حذف نوع قاعدة البيانات.
FIRESTORE_NATIVE الوضع الأصلي في Firestore
DATASTORE_MODE متجر Firestore في وضع تخزين البيانات.

وضع ConcurrencyMode

نوع وضع التحكم في التزامن للمعاملات.

التعدادات
CONCURRENCY_MODE_UNSPECIFIED غير مستخدَم.
OPTIMISTIC يمكنك استخدام التحكم المتفائل في التزامن افتراضيًا. يتوفر هذا الوضع لقواعد بيانات Cloud Firestore.
PESSIMISTIC

يمكنك استخدام التحكم في التزامن المتشائم افتراضيًا. يتوفر هذا الوضع لقواعد بيانات Cloud Firestore.

وهذا هو الإعداد التلقائي لـ Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

يمكنك استخدام تحكُّم متفائل في التزامن مع مجموعات الكيانات تلقائيًا.

هذا هو الوضع الوحيد المتاح لتخزين البيانات في السحابة الإلكترونية.

هذا الوضع متاح أيضًا لـ Cloud Firestore مع وضع "تخزين البيانات"، ولكن لا يُنصَح به.

تفعيل PointInTimeRecovery

تفعيل ميزة "استرداد البيانات في نقطة زمنية"

التعدادات
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED غير مستخدَم.
POINT_IN_TIME_RECOVERY_ENABLED

تتوفّر عمليات القراءة في إصدارات محدَّدة من البيانات خلال آخر 7 أيام:

  • تتم القراءة مقابل أي طابع زمني خلال الساعة الماضية.
  • تتم القراءة استنادًا إلى لقطات مدتها دقيقة واحدة والتي تتجاوز ساعة واحدة وفي غضون 7 أيام

يمكن استخدام versionRetentionPeriod وearliestVersionTime لتحديد الإصدارات المتوافقة.
POINT_IN_TIME_RECOVERY_DISABLED تتوفّر عمليات القراءة على أي نسخة من البيانات خلال آخر ساعة.

وضع دمج AppEngine

نوع وضع دمج App Engine.

التعدادات
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED غير مستخدَم.
ENABLED وفي حالة وجود تطبيق App Engine في المنطقة نفسها التي توجد بها قاعدة البيانات هذه، ستؤثر تهيئة App Engine على قاعدة البيانات هذه. ويتضمن ذلك تعطيل التطبيق وقاعدة البيانات، وكذلك تعطيل عمليات الكتابة إلى قاعدة البيانات.
DISABLED

ولا يؤثر App Engine في قدرة قاعدة البيانات هذه على خدمة الطلبات.

وهذا هو الإعداد الافتراضي لقواعد البيانات التي يتم إنشاؤها باستخدام واجهة برمجة تطبيقات Firestore.

رسالة DeleteProtectionState

حالة حماية حذف قاعدة البيانات.

التعدادات
DELETE_PROTECTION_STATE_UNSPECIFIED القيمة التلقائية. لم يتم تحديد نوع الحماية من الحذف.
DELETE_PROTECTION_DISABLED ميزة الحماية من الحذف غير مفعّلة.
DELETE_PROTECTION_ENABLED ميزة الحماية من الحذف مفعّلة.

إعداد CmekConfig

تهيئة مفتاح التشفير المُدار للعميل (CMEK) لقاعدة بيانات Firestore. وفي حال عدم توفّرها، يتم تأمين قاعدة البيانات باستخدام مفتاح تشفير Google التلقائي.

تمثيل JSON 
{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}
الحقول
kmsKeyName

string

يجب ملء الحقل. لا يُسمح باستخدام سوى المفاتيح للتشفير في الموقع الجغرافي نفسه لقاعدة البيانات هذه.

بالنسبة إلى متاجر nam5 المتعددة المناطق في Firestore، يتطابق ذلك مع Cloud KMS المتعددة المناطق. بالنسبة إلى البلدان المتعددة المناطق في eur3 في Firestore، يتوافق هذا مع Cloud KMS في أوروبا متعددة المناطق. يمكنك الانتقال إلى https://cloud.google.com/kms/docs/locations.

التنسيق المتوقَّع هو projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
activeKeyVersion[]

string

النتائج فقط. إصدارات KMS المستخدَمة حاليًا. أثناء تغيير المفاتيح، يمكن أن يكون هناك عدة إصدارات للمفاتيح قيد الاستخدام.

التنسيق المتوقَّع هو projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

الطُرق

create

 أنشئ قاعدة بيانات.

delete

 لحذف قاعدة بيانات.

exportDocuments

 لتصدير نسخة من كل المستندات أو مجموعة فرعية من المستندات من Google Cloud Firestore إلى نظام تخزين آخر، مثل Google Cloud Storage.

get

 للحصول على معلومات حول قاعدة بيانات.

importDocuments

 لاستيراد المستندات إلى Google Cloud Firestore.

list

 وضع قائمة بجميع قواعد البيانات في المشروع.

patch

 تحديث قاعدة بيانات.

restore

 ينشئ قاعدة بيانات جديدة عن طريق الاستعادة من نسخة احتياطية موجودة.