REST Resource: projects.databases

المورد: قاعدة بيانات

قاعدة بيانات Cloud Firestore.

تمثيل JSON 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": 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)
  },
  "previousId": string,
  "etag": string
}
الحقول
name

string

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

string

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

string (Timestamp format)

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

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

النتائج فقط. الطابع الزمني الذي تم فيه تعديل قاعدة البيانات هذه مؤخرًا. يُرجى ملاحظة أنّ ذلك لا يتضمن سوى تعديلات على مورد قاعدة البيانات وليس البيانات الواردة في قاعدة البيانات.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

النتائج فقط. الطابع الزمني الذي تم عنده حذف قاعدة البيانات هذه. يتم ضبط هذا الإعداد فقط إذا تم حذف قاعدة البيانات.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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)

النتائج فقط. أقرب طابع زمني يمكن عنده قراءة النُسخ القديمة من البيانات من قاعدة البيانات. يُرجى الاطّلاع على الإصدار [version بناPeriod] أعلاه. تمّت تعبئة هذا الحقل بـ now - versionRetentionPeriod.

يتم تعديل هذه القيمة باستمرار، وتصبح قديمة عند الاستعلام عنها. إذا كنت تستخدم هذه القيمة لاسترداد البيانات، فتأكد من حساب الوقت من اللحظة التي يتم فيها الاستعلام عن القيمة إلى اللحظة التي تبدأ فيها عملية الاسترداد.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

ما إذا كان سيتم تمكين ميزة PITR على قاعدة البيانات هذه.
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

وضع دمج App Engine لاستخدامه مع قاعدة البيانات هذه
keyPrefix

string

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

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

enum (DeleteProtectionState)

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

object (CmekConfig)

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

string

النتائج فقط. معرّف قاعدة البيانات السابق لمورد قاعدة البيانات. تتم تعبئة هذا الحقل لقواعد البيانات المحذوفة فقط.
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 مع "وضع تخزين البيانات"، ولكن لا يُنصح به.

تفعيل ميزة PointInTimeRecoveryEnablement

تفعيل ميزة "الاسترداد خلال الوقت"

تعدادات
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

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