Package google.firestore.admin.v1

الفهرس

مشرف FirestoreAdmin

واجهة برمجة تطبيقات المشرف في Cloud Firestore

توفّر واجهة برمجة التطبيقات هذه العديد من الخدمات الإدارية في Cloud Firestore.

يتم استخدام المشروع وقاعدة البيانات ومساحة الاسم والتجميع ومجموعة المجموعة والمستند على النحو المحدّد في واجهة برمجة تطبيقات Google Cloud Firestore.

العملية: تمثل العملية العمل الذي يتم تنفيذه في الخلفية.

تدير خدمة الفهرسة فهارس Cloud Firestore.

يتم إنشاء الفهرس بشكل غير متزامن. ويتم إنشاء مورد عملية لكل عملية غير متزامنة. يمكن الاستعلام عن حالة العملية (بما في ذلك أي أخطاء حدثت) عبر مورد العملية.

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

قد يتم حذف أي عملية مكتملة بحيث لا يتم إدراجها بعد ذلك كجزء من مجموعة "العملية". العمليات هي تجميع البيانات المهملة بعد 30 يومًا. بشكلٍ تلقائي، لن تظهر عمليات ListOperations إلا قيد التقدّم والعمليات التي تعذّر إتمامها. لإدراج عملية مكتملة، أدخِل طلب ListOperations باستخدام الفلتر done: true.

يتم إنشاء العمليات من خلال الخدمة FirestoreAdmin، ولكن يتم الوصول إليها من خلال الخدمة google.longrunning.Operations.

إنشاء جدول زمني للنسخ الاحتياطي

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

يقوم بإنشاء جدول احتياطي على قاعدة بيانات. يمكن تكوين جدولين كحد أقصى للنسخ الاحتياطي على قاعدة بيانات، أحدهما جدول نسخ احتياطي يومي وجدول نسخ احتياطي أسبوعي واحد.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
إنشاء قاعدة بيانات

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
إنشاء فهرس

rpc CreateIndex(CreateIndexRequest) returns (Operation)

ينشئ فهرسًا مركبًا. يؤدي ذلك إلى عرض رمز الاستجابة google.longrunning.Operation الذي يمكن استخدامه لتتبُّع حالة الإنشاء. ستكون البيانات الوصفية للعملية من النوع IndexOperationMetadata.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حذف النسخة الاحتياطية

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

حذف نسخة احتياطية

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حذف الجدول الزمني للنسخ الاحتياطي

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

يؤدي هذا الإجراء إلى حذف جدول زمني للنسخ الاحتياطي.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حذف قاعدة البيانات

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حذف الفهرس

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

حذف فهرس مركب.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
تصدير المستندات

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

لتصدير نسخة من كل المستندات أو مجموعة فرعية من المستندات من Google Cloud Firestore إلى نظام تخزين آخر، مثل Google Cloud Storage. قد لا تظهر التعديلات الأخيرة التي تم إجراؤها على المستندات في عملية التصدير. تحدث عملية التصدير في الخلفية ويمكن مراقبة مستوى تقدُّمها وإدارته من خلال مورد "العملية" الذي يتم إنشاؤه. ولا يمكن استخدام ناتج عملية التصدير إلا بعد الانتهاء من العملية المرتبطة. في حال إلغاء عملية تصدير قبل اكتمالها، قد يتم الاحتفاظ ببيانات جزئية في Google Cloud Storage.

لمزيد من التفاصيل حول سلوك التصدير وتنسيق النتائج، يُرجى الاطّلاع على: https://cloud.google.com/firestore/docs/manage-data/export-import.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
الحصول على نسخة احتياطية

rpc GetBackup(GetBackupRequest) returns (Backup)

الحصول على معلومات عن نسخة احتياطية

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
الحصول على الجدول الزمني للنسخ الاحتياطي

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

يمكن الحصول على معلومات حول جدول زمني للاحتفاظ بنسخة احتياطية.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
الحصول على قاعدة بيانات

rpc GetDatabase(GetDatabaseRequest) returns (Database)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حقل الحصول على حقل

rpc GetField(GetFieldRequest) returns (Field)

للحصول على البيانات الوصفية وإعدادات أحد الحقول.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
أمر GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

الحصول على فهرس مركب.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
استيراد المستندات

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

لاستيراد المستندات إلى Google Cloud Firestore. يتم استبدال المستندات الحالية التي تحمل الاسم نفسه. تحدث عملية الاستيراد في الخلفية ويمكن مراقبة مستوى تقدُّمها وإدارته من خلال مورد العملية الذي يتم إنشاؤه. في حال إلغاء عمليةImportDocuments، من المحتمل أن يكون قد تم استيراد مجموعة فرعية من البيانات إلى Cloud Firestore من قبل.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
القوائم الاحتياطية للجداول الزمنية

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

إنشاء قائمة بالجداول الزمنية للاحتفاظ بنسخة احتياطية

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
النُسخ الاحتياطية من القوائم

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
قوائم قواعد البيانات

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حقول القائمة

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

يسرد إعدادات الحقل والبيانات الوصفية لقاعدة البيانات هذه.

في الوقت الحالي، لا يدعم FirestoreAdmin.ListFields سوى حقول بطاقة البيانات التي تم إلغاؤها صراحةً. لإصدار طلب البحث هذا، عليك استدعاء FirestoreAdmin.ListFields مع ضبط الفلتر على indexConfig.usesAncestorConfig:false أو ttlConfig:*.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
فهارس القوائم

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

يسرد الفهارس المركّبة.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
استعادة قاعدة البيانات

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

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

يجب أن تكون قاعدة البيانات الجديدة في منطقة السحابة الإلكترونية نفسها أو في الموقع الجغرافي المتعدد المناطق مثل النسخة الاحتياطية الحالية. يعمل هذا على غرار [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] باستثناء بدلاً من إنشاء قاعدة بيانات جديدة جديدة، يتم إنشاء قاعدة بيانات جديدة بنوع قاعدة البيانات وإعداد الفهرس ومستندات من نسخة احتياطية حالية.

يمكن استخدام long-running operation لتتبُّع مدى تقدُّم عملية الاستعادة، مع العِلم بأنّ نوع الحقل metadata للعملية هو RestoreDatabaseMetadata. النوع response هو Database إذا تمت عملية الاستعادة بنجاح. لن تكون قاعدة البيانات الجديدة قابلة للقراءة أو الكتابة حتى اكتمال LRO.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
تحديث الجدول الزمني للنسخ الاحتياطي

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

تعديل جدول زمني للنسخ الاحتياطي

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
تحديث قاعدة البيانات

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حقل التحديث

rpc UpdateField(UpdateFieldRequest) returns (Operation)

لتعديل إعدادات حقل في الوقت الحالي، لا تنطبق تعديلات الحقول إلا على إعدادات فهرس حقل واحد. ومع ذلك، يجب أن توفّر المكالمات إلى FirestoreAdmin.UpdateField قناع حقل لتجنُّب تغيير أي إعدادات لا يكون المتصل على دراية بها. يجب تحديد قناع الحقل على النحو التالي: { paths: "index_config" }.

تعرض هذه المكالمة رمز الاستجابة google.longrunning.Operation الذي يمكن استخدامه لتتبُّع حالة تعديل الحقل. ستكون البيانات الوصفية للعملية من النوع FieldOperationMetadata.

لضبط إعدادات الحقول التلقائية لقاعدة البيانات، استخدِم Field الخاص مع اسم المورد: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.

النسخة الاحتياطية

نسخة احتياطية من قاعدة بيانات Cloud Firestore.

تحتوي النسخة الاحتياطية على جميع المستندات وتكوينات الفهرس لقاعدة البيانات المحددة في وقت معين.

الحقول
name

string

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

التنسيق هو projects/{project}/locations/{location}/backups/{backup}.
database

string

النتائج فقط. اسم قاعدة بيانات Firestore التي تم الاحتفاظ بالنسخة الاحتياطية

التنسيق هو projects/{project}/databases/{database}.
database_uid

string

النتائج فقط. UUID4 الذي أنشأه النظام لقاعدة بيانات Firestore التي تم الاحتفاظ بالنسخة الاحتياطية منها.
snapshot_time

Timestamp

النتائج فقط. تحتوي النسخة الاحتياطية على نسخة متسقة خارجيًا من قاعدة البيانات في هذا الوقت.
expire_time

Timestamp

النتائج فقط. الطابع الزمني الذي تنتهي فيه صلاحية هذه النسخة الاحتياطية.
state

State

النتائج فقط. الحالة الحالية للنسخة الاحتياطية.

الولاية

حدد الحالة الحالية للنسخ الاحتياطي.

التعدادات
STATE_UNSPECIFIED لم يتم تحديد الولاية.
CREATING جارٍ إنشاء النسخة الاحتياطية المعلَّقة. سيتم رفض العمليات على النسخة الاحتياطية في هذه الحالة.
READY النسخة الاحتياطية مكتملة وجاهزة للاستخدام.
NOT_AVAILABLE ميزة "الاحتفاظ بنسخة احتياطية" غير متاحة في الوقت الحالي.

تحديد موعد الاحتفاظ بنسخة احتياطية

جدول النسخ الاحتياطي لقاعدة بيانات Cloud Firestore.

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

الحقول
name

string

النتائج فقط. يشير ذلك المصطلح إلى معرِّف الجدول الزمني الفريد للنسخ الاحتياطي في جميع المواقع الجغرافية وقواعد البيانات للمشروع المحدّد.

سيتم تعيينه تلقائيًا.

التنسيق هو projects/{project}/databases/{database}/backupSchedules/{backup_schedule}.
create_time

Timestamp

النتائج فقط. الطابع الزمني الذي تم فيه إنشاء هذا الجدول الزمني للنسخة الاحتياطية وأصبح ساريًا منذ ذلك الحين.

لن يتم إنشاء أي نُسخ احتياطية لهذا الجدول الزمني قبل هذا الوقت.
update_time

Timestamp

النتائج فقط. الطابع الزمني الذي تم فيه تعديل آخر جدول زمني للاحتفاظ بنسخة احتياطية عند إنشاء جدول زمني للنسخ الاحتياطي لأول مرة، يتطابق ذلك مع create_time.
retention

Duration

يجب حذف النسخة الاحتياطية في أي وقت نسبي في المستقبل مقارنةً بوقت إنشائها، فعلى سبيل المثال، الاحتفاظ بالنسخ الاحتياطية لمدة 7 أيام.
حقل الاتحاد recurrence حقل واحد لتمثيل وقت إجراء النسخ الاحتياطية. يمكن أن يكون الحقل "recurrence" واحدًا فقط مما يلي:
daily_recurrence

DailyRecurrence

بالنسبة إلى جدول زمني يتم تشغيله يوميًا
weekly_recurrence

WeeklyRecurrence

بالنسبة إلى جدول زمني يتم تشغيله أسبوعيًا في يوم محدّد

إنشاء ملف احتياطي للجدول الزمني

طلب FirestoreAdmin.CreateBackupSchedule.

الحقول
parent

string

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

التنسيق projects/{project}/databases/{database}
backup_schedule

BackupSchedule

يجب ملء الحقل. الجدول الزمني للنسخ الاحتياطي الذي سيتم إنشاؤه

إنشاء قاعدة بيانات بيانات وصفية

لا يشتمل هذا النوع على أي حقول.

بيانات التعريف المرتبطة بعملية إنشاء قاعدة البيانات

إنشاء قاعدة بيانات طلب

طلب FirestoreAdmin.CreateDatabase.

الحقول
parent

string

يجب ملء الحقل. اسم عنصر رئيسي بالنموذج projects/{project_id}
database

Database

يجب ملء الحقل. قاعدة البيانات المطلوب إنشاؤها.
database_id

string

يجب ملء الحقل. المعرِّف المطلوب استخدامه لقاعدة البيانات، والذي سيصبح المكوّن الأخير في اسم مورد قاعدة البيانات.

ويجب أن تتألف هذه القيمة من 4 إلى 63 حرفًا. الأحرف الصالحة هي /[a-z][0-9]-/ حيث يبدأ الحرف الأول بحرف آخر أو رقم. يجب ألا يشبه المعرّف الفريد العالمي (UUID) /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

رقم تعريف قاعدة البيانات "(التلقائي)" صالح أيضًا.

إنشاء طلب فهرسة

طلب FirestoreAdmin.CreateIndex.

الحقول
parent

string

يجب ملء الحقل. اسم عنصر رئيسي بالنموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

يجب ملء الحقل. الفهرس المركّب المطلوب إنشاؤه.

التكرار اليومي

لا يشتمل هذا النوع على أي حقول.

يمثل هذا الجدول جدولاً زمنيًا متكرّرًا يتم تشغيله كل يوم.

وتكون المنطقة الزمنية حسب التوقيت العالمي المنسَّق (UTC).

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

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

الحقول
name

string

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

string

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

Timestamp

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

Timestamp

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

string

موقع قاعدة البيانات. ويمكنك الاطّلاع على المواقع الجغرافية المتوفّرة على الرابط https://cloud.google.com/firestore/docs/locations.
type

DatabaseType

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

ConcurrencyMode

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

Duration

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

بإمكان أي read أو query تحديد read_time ضمن هذه النافذة، وسيقرأ حالة قاعدة البيانات في ذلك الوقت.

في حال تفعيل ميزة PITR، تكون فترة الاحتفاظ بالبيانات 7 أيام. وبخلاف ذلك، تكون فترة الاحتفاظ بالبيانات ساعة واحدة.
earliest_version_time

Timestamp

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

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

PointInTimeRecoveryEnablement

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

AppEngineIntegrationMode

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

string

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

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

DeleteProtectionState

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

CmekConfig

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

string

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

وضع دمج AppEngine

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

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

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

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

إعداد CmekConfig

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

الحقول
kms_key_name

string

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

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

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

string

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

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

وضع ConcurrencyMode

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

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

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

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

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

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

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

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

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

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

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

رسالة DeleteProtectionState

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

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

تفعيل PointInTimeRecovery

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

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

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

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

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

حذف النسخ الاحتياطي

طلب FirestoreAdmin.DeleteBackup.

الحقول
name

string

يجب ملء الحقل. اسم النسخة الاحتياطية التي تريد حذفها.

التنسيق هو projects/{project}/locations/{location}/backups/{backup}.

طلب حذف النسخ الاحتياطي

طلب [FirestoreAdmin.Delete BackupSchedules][].

الحقول
name

string

يجب ملء الحقل. اسم الجدول الزمني للنسخ الاحتياطي.

التنسيق projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

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

لا يشتمل هذا النوع على أي حقول.

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

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

طلب FirestoreAdmin.DeleteDatabase.

الحقول
name

string

يجب ملء الحقل. اسم النموذج projects/{project_id}/databases/{database_id}
etag

string

العلامة الحالية لقاعدة البيانات. في حال توفير علامة etag وعدم تطابقها مع العلامة الحالية لقاعدة البيانات، سيتم حظر الحذف وسيظهر الخطأ تعذّر_PRE وغيرها.

حذفIndexRequest

طلب FirestoreAdmin.DeleteIndex.

الحقول
name

string

يجب ملء الحقل. اسم النموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

تصدير المستندات الوصفية

البيانات الوصفية لـ google.longrunning.Operation نتيجة من FirestoreAdmin.ExportDocuments

الحقول
start_time

Timestamp

وقت بدء هذه العملية.
end_time

Timestamp

وقت اكتمال هذه العملية. سيتم إلغاء ضبط هذه السياسة إذا كانت العملية لا تزال قيد التنفيذ.
operation_state

OperationState

حالة عملية التصدير.
progress_documents

Progress

مستوى التقدم في هذه العملية ضمن المستندات
progress_bytes

Progress

مستوى تقدم هذه العملية، بالبايت.
collection_ids[]

string

معرّفات المجموعات التي يتم تصديرها
output_uri_prefix

string

المكان الذي يتم تصدير المستندات إليه.
namespace_ids[]

string

معرّفات مساحات الاسم التي يتم تصديرها
snapshot_time

Timestamp

الطابع الزمني الذي يتوافق مع إصدار قاعدة البيانات التي يتم تصديرها. في حال عدم تحديدها، ما مِن ضمانات بشأن اتساق المستندات التي يتم تصديرها.

ExportDocumentsRequest

طلب FirestoreAdmin.ExportDocuments.

الحقول
name

string

يجب ملء الحقل. قاعدة البيانات للتصدير. يجب أن يكون التنسيق: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

معرّفات المجموعات المطلوب تصديرها الحالة "غير محدّد" تعني جميع المجموعات.
output_uri_prefix

string

معرِّف الموارد المنتظم (URI) للمخرجات. لا تتوافق حاليًا سوى مع معرِّفات الموارد المنتظمة (URI) لخدمة Google Cloud Storage على النحو التالي: gs://BUCKET_NAME[/NAMESPACE_PATH]، حيث يكون BUCKET_NAME هو اسم حزمة Google Cloud Storage وNAMESPACE_PATH مسارًا اختياريًا لمساحة الاسم في Google Cloud Storage. عند اختيار اسم، احرص على مراعاة إرشادات التسمية في Google Cloud Storage: https://cloud.google.com/storage/docs/naming. إذا كان معرّف الموارد المنتظم (URI) عبارة عن حزمة (بدون مسار مساحة اسم)، سيتم إنشاء بادئة استنادًا إلى وقت البدء.
namespace_ids[]

string

تمثل القائمة الفارغة جميع مساحات الاسم. هذا هو الاستخدام المفضل لقواعد البيانات التي لا تستخدم مساحات الاسم.

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

Timestamp

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

ExportDocumentsResponse (تصدير المستندات)

تم عرضه في حقل الرد google.longrunning.Operation.

الحقول
output_uri_prefix

string

موقع ملفات الإخراج يمكن استخدام ذلك لبدء عملية الاستيراد إلى Cloud Firestore (هذا المشروع أو مشروع آخر) بعد اكتمال العملية بنجاح.

الحقل

تمثل حقلاً واحدًا في قاعدة البيانات.

يتم تجميع الحقول حسب "مجموعة المجموعة" التي تمثل كل المجموعات في قاعدة البيانات بالمعرف نفسه.

الحقول
name

string

يجب ملء الحقل. اسم حقل بالنموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

يمكن أن يكون مسار الحقل اسم حقل بسيطًا، مثل address أو مسار إلى حقول ضمن map_value، مثل address.city، أو مسار حقل خاص. الحقل الخاص الوحيد الصالح هو *، الذي يمثّل أي حقل.

يمكن اقتباس مسارات الحقول باستخدام (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` بالإضافة إلى أي أحرف ASCII رمزية.

أمثلة: (ملاحظة: تتم كتابة التعليقات هنا ببنية markdown، وبالتالي تتوفّر طبقة إضافية من الفواصل العليا المائلة لتمثيل كتلة الرموز) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`، وليس أي حقل.

يحتوي حقل Field الخاص على إعدادات الفهرسة التلقائية لجميع الحقول. اسم مورد هذا الحقل هو: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* سيتم تطبيق الفهارس المحدّدة في Field على جميع الحقول التي لا تحتوي على إعدادات فهرس Field الخاصة بها.
index_config

IndexConfig

إعدادات الفهرس لهذا الحقل. في حال ترك هذه السياسة بدون ضبط، ستتم إعادة فهرسة الحقول إلى الإعدادات التي حدّدتها سياسة ancestor_field. لإزالة جميع الفهارس لهذا الحقل بشكل صريح، حدِّد إعداد فهرس مع قائمة فارغة من الفهارس.
ttl_config

TtlConfig

إعدادات مدة البقاء (TTL) الخاصة بجهاز Field هذا. سيؤدي ضبط هذا الإعداد أو إلغاء ضبطه إلى تفعيل مدة البقاء (TTL) أو إيقافها للمستندات التي تحتوي على Field هذه.

إعدادات الفهرس

إعدادات الفهرس لهذا الحقل.

الحقول
indexes[]

Index

الفهارس المتوافقة مع هذا الحقل
uses_ancestor_config

bool

النتائج فقط. عندما تكون القيمة "صحيح"، يتم ضبط إعدادات فهرس Field من الإعدادات التي تحدّدها ancestor_field. أمّا في حال ضبط السياسة على "خطأ"، فسيتم تحديد إعدادات فهرس Field بشكل صريح.
ancestor_field

string

النتائج فقط. يحدد اسم مورد Field الذي تم ضبط إعدادات الفهرس لهذا الحقل منه (عندما تكون قيمة uses_ancestor_config true)، أو الذي سيتم ضبطه إذا كان هذا الحقل لا يتضمن أي إعدادات فهرسة (عندما يكون uses_ancestor_config خطأ).
reverting

bool

النتائج فقط عندما تكون القيمة "صحيح"، يعني ذلك أنّ إعدادات فهرس Field قيد عملية التراجع. وبعد اكتمال العملية، ستنتقل إعدادات الفهرس إلى حالة الحقل نفسها المتوفّرة في الحقل ancestor_field، وبذلك سيكون uses_ancestor_config هو true وسيصبح reverting false.

إعداد TtlConfig

إعداد TTL (مدة البقاء) للمستندات التي تم ضبط Field فيها.

سيتم التعامل مع تخزين قيمة الطابع الزمني في حقل مُفعّل مدة البقاء (TTL) على أنّه وقت انتهاء الصلاحية المطلق للمستند. تشير قيم الطوابع الزمنية في الماضي إلى أنّ المستند مؤهَّل لانتهاء الصلاحية الفوري. سيؤدي استخدام أي نوع بيانات آخر أو ترك الحقل فارغًا إلى إيقاف انتهاء الصلاحية للمستند الفردي.

الحقول
state

State

النتائج فقط. حالة تهيئة مدة البقاء.

الولاية

حالة تطبيق إعداد مدة البقاء على جميع المستندات.

التعدادات
STATE_UNSPECIFIED الولاية غير محدّدة أو غير معروفة.
CREATING يجري تطبيق مدة البقاء. هناك عملية نشطة لفترة طويلة لتتبع التغيير. وسيتم تطبيق مدة البقاء (TTL) للمستندات المكتوبة حديثًا على النحو المطلوب. لا تزال مدة البقاء المطلوبة في المستندات الحالية قيد المعالجة. عند معالجة مدة البقاء على جميع المستندات الحالية، سيتم نقل الحالة إلى "نشطة".
ACTIVE مدة البقاء نشطة لجميع المستندات.
NEEDS_REPAIR تعذر تفعيل تهيئة TTL لجميع المستندات الحالية. وسيستمر تطبيق مدة البقاء (TTL) الخاصة بالمستندات المكتوبة حديثًا. تمت إعادة LRO عند تعذُّر إجراء آخر محاولة لتفعيل مدة البقاء (TTL) لهذا Field، وقد يحتوي على مزيد من التفاصيل.

البيانات الوصفية للعمليات الميدانية

البيانات الوصفية لـ google.longrunning.Operation نتيجة من FirestoreAdmin.UpdateField

الحقول
start_time

Timestamp

وقت بدء هذه العملية.
end_time

Timestamp

وقت اكتمال هذه العملية. سيتم إلغاء ضبط هذه السياسة إذا كانت العملية لا تزال قيد التنفيذ.
field

string

تمثّل هذه السمة مورد الحقل الذي تعمل عليه هذه العملية. مثلاً: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

هذه قائمة من IndexConfigDelta تصف الغرض من هذه العملية.
state

OperationState

حالة العملية.
progress_documents

Progress

مستوى التقدم في هذه العملية ضمن المستندات
progress_bytes

Progress

مستوى تقدم هذه العملية، بالبايت.
ttl_config_delta

TtlConfigDelta

لوصف دلتا لإعداد TTL.

IndexConfigDelta

معلومات حول تغيير في إعدادات الفهرس.

الحقول
change_type

ChangeType

تحدد هذه السمة كيفية تغيّر الفهرس.
index

Index

الفهرس الذي يتم تغييره.

نوع التغيير

تحدد هذه السمة كيفية تغيّر الفهرس.

التعدادات
CHANGE_TYPE_UNSPECIFIED نوع التغيير غير محدّد أو معروف.
ADD تتم إضافة فهرس الحقل الفردي.
REMOVE جارٍ إزالة فهرس الحقل الفردي.

لغة TtlConfigDelta

معلومات حول تغيير إعدادات مدة البقاء (TTL)

الحقول
change_type

ChangeType

تحدد هذه السمة كيفية تغيير إعدادات مدة البقاء (TTL).

نوع التغيير

يحدد كيفية تغيير إعداد TTL.

التعدادات
CHANGE_TYPE_UNSPECIFIED نوع التغيير غير محدّد أو معروف.
ADD تتم الآن إضافة إعداد TTL.
REMOVE جارٍ إزالة إعداد TTL.

الحصول على طلب الاحتفاظ بنسخة احتياطية

طلب FirestoreAdmin.GetBackup.

الحقول
name

string

يجب ملء الحقل. اسم النسخة الاحتياطية المطلوب استرجاعها

التنسيق هو projects/{project}/locations/{location}/backups/{backup}.

الحصول على نسخة احتياطية حول المجدول

طلب FirestoreAdmin.GetBackupSchedule.

الحقول
name

string

يجب ملء الحقل. اسم الجدول الزمني للنسخ الاحتياطي.

التنسيق projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

GetDatabaseRequest

طلب FirestoreAdmin.GetDatabase.

الحقول
name

string

يجب ملء الحقل. اسم النموذج projects/{project_id}/databases/{database_id}

طلب حقل الحصول على حقل

طلب FirestoreAdmin.GetField.

الحقول
name

string

يجب ملء الحقل. اسم النموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

طلب الحصول على الفهرس

طلب FirestoreAdmin.GetIndex.

الحقول
name

string

يجب ملء الحقل. اسم النموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

استيراد المستندات الوصفية

البيانات الوصفية لـ google.longrunning.Operation نتيجة من FirestoreAdmin.ImportDocuments

الحقول
start_time

Timestamp

وقت بدء هذه العملية.
end_time

Timestamp

وقت اكتمال هذه العملية. سيتم إلغاء ضبط هذه السياسة إذا كانت العملية لا تزال قيد التنفيذ.
operation_state

OperationState

حالة عملية الاستيراد.
progress_documents

Progress

مستوى التقدم في هذه العملية ضمن المستندات
progress_bytes

Progress

مستوى تقدم هذه العملية، بالبايت.
collection_ids[]

string

معرّفات المجموعات التي يتم استيرادها.
input_uri_prefix

string

موقع المستندات التي يتم استيرادها.
namespace_ids[]

string

معرّفات مساحات الاسم التي يتم استيرادها

طلب استيراد المستندات

طلب FirestoreAdmin.ImportDocuments.

الحقول
name

string

يجب ملء الحقل. قاعدة بيانات ليتم الاستيراد إليها. يجب أن يكون التنسيق: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

معرّفات المجموعات المطلوب استيرادها. الحالة "غير محدّد" تعني جميع المجموعات المضمّنة في عملية الاستيراد.
input_uri_prefix

string

موقع الملفات التي تم تصديرها يجب أن يتطابق هذا الأمر مع out_uri_prefix أمر ExportDocumentsResponse (الاستجابة للطلب) من عملية تصدير اكتملت بنجاح. يُرجى الاطّلاع على: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
namespace_ids[]

string

تمثل القائمة الفارغة جميع مساحات الاسم. هذا هو الاستخدام المفضل لقواعد البيانات التي لا تستخدم مساحات الاسم.

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

الفهرس

تتيح فهارس Cloud Firestore استعلامات بسيطة ومعقدة مقابل المستندات الموجودة في قاعدة البيانات.

الحقول
name

string

النتائج فقط. اسم محدد من قِبل الخادم لهذا الفهرس. سيكون هذا الاسم للفهارس المركّبة كما يلي: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} بالنسبة إلى فهارس الحقل الفردي، سيكون هذا الحقل فارغًا.
query_scope

QueryScope

تسمح الفهارس ذات نطاق طلب بحث المجموعة المحدد بطلبات البحث ضمن مجموعة تابعة لمستند معيّن، والتي تم تحديدها في وقت طلب البحث، وتحتوي على معرّف المجموعة نفسه.

إنّ الفهارس ذات نطاق طلبات البحث المحدّدة لمجموعة المجموعات تسمح بطلبات البحث مقابل كل المجموعات الواردة من مستند معيّن، والتي يتم تحديدها في وقت طلب البحث، والتي لها معرّف المجموعة نفسه كهذا الفهرس.
api_scope

ApiScope

نطاق واجهة برمجة التطبيقات المتوافق مع هذا الفهرس.
fields[]

IndexField

الحقول التي يتيحها هذا الفهرس.

بالنسبة إلى الفهارس المركّبة، يتطلب هذا الأمر حقلين كحد أدنى و100 حقل كحد أقصى. يكون إدخال الحقل الأخير دائمًا لمسار الحقل __name__. في حال عدم تحديد "__name__" كحقل أخير عند الإنشاء، ستتم إضافته تلقائيًا باتجاه الحقل الأخير المحدّد. إذا لم يكن الحقل الأخير في الفهرس المركب توجيهيًا، سيتم ترتيب __name__ تصاعديًا (ما لم يتم تحديد ذلك بشكل صريح).

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

State

النتائج فقط. حالة عرض الفهرس

أبيسكوب

يحدّد نطاق واجهة برمجة التطبيقات واجهات برمجة التطبيقات (Firestore Native أو Firestore في وضع Datastore) المتوافقة مع طلبات البحث.

التعدادات
ANY_API لا يمكن استخدام الفهرس إلا بواسطة واجهة برمجة تطبيقات Firestore Native query. هذا هو الخيار التلقائي.
DATASTORE_MODE_API يمكن استخدام الفهرس فقط بواسطة Firestore في واجهة برمجة تطبيقات استعلام وضع Datastore Mode.

حقل الفهرس

حقل في فهرس. يصف field_path الحقل الذي تمت فهرسته، ويصف value_mode كيفية فهرسة قيمة الحقل.

الحقول
field_path

string

يمكن أن يكون name. بالنسبة إلى فهارس الحقل الفردي، يجب أن تتطابق مع اسم الحقل أو قد يتم حذفها.
حقل الاتحاد value_mode كيفية فهرسة قيمة الحقل يمكن أن يكون الحقل "value_mode" واحدًا فقط مما يلي:
order

Order

تشير هذه السمة إلى أن هذا الحقل يتيح الترتيب حسب الترتيب المحدّد أو المقارنة باستخدام = أو != أو < أو <= أو > أو >=.
array_config

ArrayConfig

تشير هذه السمة إلى أنّ هذا الحقل يتيح العمليات على array_value.
vector_config

VectorConfig

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

إعدادات المصفوفة

إعدادات قيم المصفوفة المتوافقة.

التعدادات
ARRAY_CONFIG_UNSPECIFIED لا يتيح الفهرس طلبات صفيف إضافية.
CONTAINS يدعم الفهرس استعلامات احتواء الصفيف.

طلب

الطلبات المتوافقة.

التعدادات
ORDER_UNSPECIFIED لم يتم تحديد الترتيب. هذا الخيار غير صالح.
ASCENDING يتم ترتيب الحقل حسب قيمة حقل تصاعدية.
DESCENDING يتم ترتيب الحقل حسب قيمة الحقل التنازلي.

ملف VectorConfig

تهيئة الفهرس لدعم عمليات البحث عن المتجهات

الحقول
dimension

int32

يجب ملء الحقل. سمة المتّجه التي تنطبق عليها هذه الإعدادات

سيتضمن الفهرس الناتج فقط متجهات من هذا البُعد، ويمكن استخدامه للبحث المتجهات بالبُعد نفسه.
حقل الاتحاد type نوع الفهرس المستخدَم. يمكن أن يكون الحقل "type" واحدًا فقط مما يلي:
flat

FlatIndex

يشير إلى أن فهرس الخط المتجه هو فهرس مسطح.

المؤشر الثابت

لا يشتمل هذا النوع على أي حقول.

يشير ذلك المصطلح إلى فهرس يخزِّن المتجهات في بنية بيانات ثابتة ويوفّر إمكانية البحث الشامل.

نطاق طلب البحث

يحدد نطاق طلب البحث النطاق الذي يتم تشغيل طلب البحث فيه. ويتم تحديد ذلك في حقل from في طلب بحث منظَّم.

التعدادات
QUERY_SCOPE_UNSPECIFIED نطاق طلب البحث غير محدد. هذا الخيار غير صالح.
COLLECTION تسمح الفهارس ذات نطاق طلب بحث المجموعة المحدد بطلبات البحث في مجموعة تابعة لمستند معيّن، والتي تم تحديدها في وقت طلب البحث، وتحتوي على معرّف المجموعة المحدد في الفهرس.
COLLECTION_GROUP إنّ الفهارس ذات نطاق طلبات البحث المحدّدة لمجموعة المجموعات تسمح بإجراء طلبات بحث مقابل كل المجموعات التي تم تحديد معرّف المجموعة لها في الفهرس.
COLLECTION_RECURSIVE أدرِج أصل المجموعات كلّها في الفهرس. متاح فقط لقواعد بيانات وضع مخزن البيانات.

الولاية

حالة الفهرس. أثناء إنشاء الفهرس، سيكون الفهرس بالحالة CREATING. في حال إنشاء الفهرس بنجاح، سيتم نقله إلى الحالة READY. إذا واجهنا مشكلة في إنشاء الفهرس، سينتقل الفهرس إلى حالة NEEDS_REPAIR.

التعدادات
STATE_UNSPECIFIED لم يتم تحديد الولاية.
CREATING يتم إنشاء الفهرس. هناك عملية نشطة لفترة طويلة للفهرس. يتم تحديث الفهرس عند كتابة مستند. قد تتوفر بعض بيانات الفهرس.
READY الفهرس جاهز للاستخدام. يتم تحديث الفهرس عند كتابة مستند. تتم تعبئة الفهرس بالكامل من جميع المستندات المخزنة التي ينطبق عليها.
NEEDS_REPAIR تم إنشاء الفهرس، ولكن حدث خطأ. ليست هناك عملية نشطة لفترة طويلة للفهرس، وقد تعذّر إتمام آخر عملية طويلة الأمد تمت معالجتها مؤخرًا. لا يتم تحديث الفهرس عند كتابة مستند. قد تتوفر بعض بيانات الفهرس. استخدِم واجهة برمجة التطبيقات google.long running.Operations لتحديد سبب إخفاق العملية الأخيرة التي حاولت إنشاء هذا الفهرس، ثم أعد إنشاء الفهرس.

IndexOperationMetadata

البيانات الوصفية لـ google.longrunning.Operation نتيجة من FirestoreAdmin.CreateIndex

الحقول
start_time

Timestamp

وقت بدء هذه العملية.
end_time

Timestamp

وقت اكتمال هذه العملية. سيتم إلغاء ضبط هذه السياسة إذا كانت العملية لا تزال قيد التنفيذ.
index

string

مورد الفهرس الذي يتم تنفيذ هذه العملية عليه. مثلاً: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

حالة العملية.
progress_documents

Progress

مستوى التقدم في هذه العملية ضمن المستندات
progress_bytes

Progress

مستوى تقدم هذه العملية، بالبايت.

قائمة النسخ الاحتياطي للجداول الزمنية

طلب FirestoreAdmin.ListBackupSchedules.

الحقول
parent

string

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

التنسيق هو projects/{project}/databases/{database}.

ردّ ListالاحتفاظsSchedulesResponse

الردّ على FirestoreAdmin.ListBackupSchedules.

الحقول
backup_schedules[]

BackupSchedule

قائمة بكل الجداول الزمنية للاحتفاظ بنسخة احتياطية

قائمة النسخ الاحتياطي

طلب FirestoreAdmin.ListBackups.

الحقول
parent

string

يجب ملء الحقل. الموقع المطلوب إدراج النُسخ الاحتياطية منه.

التنسيق هو projects/{project}/locations/{location}. استخدِم "{location} = '-'" لسرد النسخ الاحتياطية من جميع المواقع الجغرافية للمشروع المعني. يتيح ذلك سرد نسخ احتياطية من موقع واحد أو من جميع المواقع.

قائمة النسخ الاحتياطي

الردّ على FirestoreAdmin.ListBackups.

الحقول
backups[]

Backup

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

string

قائمة بالمواقع الجغرافية التي تعذّر جلب النُسخ الاحتياطية منها

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

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

طلب سرد قواعد بيانات Firestore في جميع المواقع الخاصة بمشروع.

الحقول
parent

string

يجب ملء الحقل. اسم عنصر رئيسي بالنموذج projects/{project_id}

استجابة قاعدة بيانات قوائم البيانات

تمثّل هذه السمة قائمة قواعد البيانات لأحد المشاريع.

الحقول
databases[]

Database

قواعد البيانات في المشروع.
unreachable[]

string

في حالة عدم إمكانية سرد بيانات متعلقة بقواعد البيانات الفردية، فسيتم تسجيلها هنا.

قد يكون الإدخال على سبيل المثال: project/some_project/locations/some_location. يمكن أن يحدث ذلك إذا كانت منطقة السحابة الإلكترونية التي تقع فيها قاعدة البيانات غير متوفّرة حاليًا. في هذه الحالة، لا يمكننا جلب كل التفاصيل المتعلقة بقاعدة البيانات. قد يمكنك الحصول على رسالة خطأ أكثر تفصيلاً (أو ربما جلب المورد) من خلال إرسال طلب "Get" للمورد أو طلب "قائمة" للموقع المحدد.

طلب حقول القائمة

طلب FirestoreAdmin.ListFields.

الحقول
parent

string

يجب ملء الحقل. اسم عنصر رئيسي بالنموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

الفلتر المطلوب تطبيقه على نتائج القائمة. في الوقت الحالي، لا يدعم FirestoreAdmin.ListFields سوى حقول بطاقة البيانات التي تم إلغاؤها صراحةً. لإصدار هذا الطلب، عليك استدعاء FirestoreAdmin.ListFields باستخدام فلتر يتضمّن indexConfig.usesAncestorConfig:false .
page_size

int32

عدد النتائج المطلوب عرضها.
page_token

string

رمز مميز للصفحة تم عرضه من خلال مكالمة سابقة إلى FirestoreAdmin.ListFields، ويمكن استخدامه للحصول على الصفحة التالية من النتائج.

استجابة حقول القائمة

الردّ على FirestoreAdmin.ListFields.

الحقول
fields[]

Field

الحقول المطلوبة.
next_page_token

string

هو الرمز المميز للصفحة الذي يمكن استخدامه لطلب صفحة أخرى من النتائج. إذا كان فارغًا، تكون هذه هي الصفحة الأخيرة.

طلب ListIndexes

طلب FirestoreAdmin.ListIndexes.

الحقول
parent

string

يجب ملء الحقل. اسم عنصر رئيسي بالنموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

الفلتر المطلوب تطبيقه على نتائج القائمة.
page_size

int32

عدد النتائج المطلوب عرضها.
page_token

string

رمز مميز للصفحة تم عرضه من خلال مكالمة سابقة إلى FirestoreAdmin.ListIndexes، ويمكن استخدامه للحصول على الصفحة التالية من النتائج.

استجابة ListIndexesResponse

الردّ على FirestoreAdmin.ListIndexes.

الحقول
indexes[]

Index

الفهارس المطلوبة.
next_page_token

string

هو الرمز المميز للصفحة الذي يمكن استخدامه لطلب صفحة أخرى من النتائج. إذا كان فارغًا، تكون هذه هي الصفحة الأخيرة.

البيانات الوصفية للموقع الجغرافي

لا يشتمل هذا النوع على أي حقول.

رسالة البيانات الوصفية للموقع الإلكتروني google.cloud.location.Location.metadata.

حالة العملية

لوصف حالة العملية.

التعدادات
OPERATION_STATE_UNSPECIFIED الحالة غير محدّدة.
INITIALIZING يتم تجهيز الطلب للمعالجة.
PROCESSING تتم حاليًا معالجة الطلب.
CANCELLING جارٍ إلغاء الطلب بعد أن يُدعى المستخدم google.long running.Operations.CancelOperation on العملية.
FINALIZING تمت معالجة الطلب وهو في المرحلة النهائية.
SUCCESSFUL تم إكمال الطلب بنجاح.
FAILED انتهت معالجة الطلب، ولكن حدث خطأ.
CANCELLED تم إلغاء الطلب بعد أن يُسمّى المستخدم google.long running.Operations.CancelOperation.

مستوى التقدّم

وصف مستوى تقدم العملية. وحدة العمل عامة ويجب تفسيرها استنادًا إلى مكان استخدام Progress.

الحقول
estimated_work

int64

مقدار العمل المقدر.
completed_work

int64

مقدار العمل المنجز.

استعادة قاعدة بيانات البيانات الوصفية

البيانات الوصفية لـ long-running operation من طلب [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase]

الحقول
start_time

Timestamp

الوقت الذي بدأت فيه عملية الاستعادة.
end_time

Timestamp

وقت انتهاء عملية الاستعادة، لا يتم ضبط الوقت المحدَّد لعمليات الاستعادة الجارية.
operation_state

OperationState

حالة عملية الاستعادة.
database

string

اسم قاعدة البيانات التي تتم استعادة البيانات إليها.
backup

string

اسم النسخة الاحتياطية التي تتم استعادة البيانات منها.
progress_percentage

Progress

المدة الزمنية لعملية الاستعادة هي كنسبة مئوية مقدَّرة للوقت المتبقي.

استعادة قاعدة البياناتRequest

رسالة الطلب لـ [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

الحقول
parent

string

يجب ملء الحقل. المشروع الذي ستتم استعادة قاعدة البيانات فيه. التنسيق هو projects/{project_id}.
database_id

string

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

ويجب أن تتألف هذه القيمة من 4 إلى 63 حرفًا. الأحرف الصالحة هي /[a-z][0-9]-/ حيث يبدأ الحرف الأول بحرف آخر أو رقم. يجب ألا يشبه المعرّف الفريد العالمي (UUID) /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

رقم تعريف قاعدة البيانات "(التلقائي)" صالح أيضًا.

حقل الاتحاد source

يمكن أن يكون الحقل "source" واحدًا فقط مما يلي:
backup

string

نسخة احتياطية للاستعادة منها. يجب أن يكون الطالب من المشروع نفسه الذي ينتمي إليه أحد الوالدَين.

التنسيق هو: projects/{project_id}/locations/{location}/backups/{backup}

طلب تحديث الجدول الزمني للنسخ الاحتياطي

طلب FirestoreAdmin.UpdateBackupSchedule.

الحقول
backup_schedule

BackupSchedule

يجب ملء الحقل. الجدول الزمني للنسخ الاحتياطي الذي سيتم تعديله.
update_mask

FieldMask

قائمة الحقول التي سيتم تعديلها.

تحديث قاعدة البيانات الوصفية

لا يشتمل هذا النوع على أي حقول.

بيانات التعريف المتعلّقة بعملية تعديل قاعدة البيانات

تحديث قاعدة البياناتRequest

طلب FirestoreAdmin.UpdateDatabase.

الحقول
database

Database

يجب ملء الحقل. قاعدة البيانات المطلوب تحديثها.
update_mask

FieldMask

قائمة الحقول التي سيتم تعديلها.

طلب تعديل الحقل

طلب FirestoreAdmin.UpdateField.

الحقول
field

Field

يجب ملء الحقل. الحقل الذي سيتم تعديله.
update_mask

FieldMask

قناع، مرتبط بالحقل. في حال تحديد هذه السمة، سيتم تعديل الإعدادات التي حدّدها هذا الحقل_mask فقط في الحقل.

التكرار الأسبوعي

يُمثِّل ذلك جدولاً زمنيًا متكرّرًا يتم تشغيله في يوم محدَّد من الأسبوع.

وتكون المنطقة الزمنية حسب التوقيت العالمي المنسَّق (UTC).

الحقول
day

DayOfWeek

اليوم من الأسبوع الذي يتم فيه عرض الإعلانات.

يوم DAY_OF_WEEK_UNSPECIFIED غير مسموح به.