Package google.firestore.admin.v1

الفهرس

مشرف في متجر Firestore

واجهة برمجة تطبيقات المشرف في 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. يتم استبدال المستندات الحالية التي تحمل الاسم نفسه. يحدث الاستيراد في الخلفية ويمكن مراقبة مستوى تقدُّمه وإدارته من خلال مورد "العملية" الذي يتم إنشاؤه. في حال إلغاء عملية الاستيراد، من المحتمل أن تكون مجموعة فرعية من البيانات قد تم استيرادها من قبل إلى 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 أيام.

الحد الأقصى لفترة الاحتفاظ بالبيانات المتوفرة هو 14 أسبوعًا.
حقل الاتحاد 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

النتائج فقط. الطابع الزمني الذي تم فيه تعديل قاعدة البيانات هذه مؤخرًا. يُرجى ملاحظة أنّ ذلك لا يتضمن سوى تعديلات على مورد قاعدة البيانات وليس البيانات الواردة في قاعدة البيانات.
delete_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 API في بيئات تشغيل الجيل الأول من Google App Engine.

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

DeleteProtectionState

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

CmekConfig

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

string

النتائج فقط. معرّف قاعدة البيانات السابق لمورد قاعدة البيانات. تتم تعبئة هذا الحقل لقواعد البيانات المحذوفة فقط.
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 تم تفعيل حماية الحذف

تفعيل ميزة PointInTimeRecoveryEnablement

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

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

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

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

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

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

طلب الحصول على FirestoreAdmin.DeleteDatabase

الحقول
name

string

مطلوب. اسم النموذج projects/{project_id}/databases/{database_id}
etag

string

العلامة التجارية الحالية لقاعدة البيانات. إذا تم توفير علامة إلكترونية ولا تتطابق مع العلامة الإلكترونية الحالية لقاعدة البيانات، سيتم حظر الحذف وعرض خطأ FAILED_PREcondition.

طلب حذف الفهرس

طلب الحصول على FirestoreAdmin.DeleteIndex

الحقول
name

string

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

ExportDocumentsMetadata

البيانات الوصفية لـ 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

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

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

طلب الحصول على 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

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

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

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

الحقول
indexes[]

Index

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

bool

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

string

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

bool

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

ضبط الإعدادات

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

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

الحقول
state

State

النتائج فقط. حالة إعداد TTL.

الولاية

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

تعدادات
STATE_UNSPECIFIED الولاية غير محدّدة أو غير معروفة.
CREATING يتم تطبيق مدة البقاء (TTL). هناك عملية نشطة وطويلة الأمد لتتبُّع التغيير. سيتم تطبيق مدة البقاء على المستندات المكتوبة حديثًا على النحو المطلوب. لا تزال حالات TTL المطلوبة للمستندات الحالية قيد المعالجة. عندما تتم معالجة فترات البقاء على جميع المستندات الحالية، ستنتقل الحالة إلى "نشط".
ACTIVE وتكون مدة البقاء (TTL) نشطة لجميع المستندات.
NEEDS_REPAIR تعذر تفعيل إعداد مدة البقاء لجميع المستندات الحالية. سيستمر تطبيق مدة البقاء (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

لتحديد كيفية تغيير إعدادات مدة البقاء.

نوع التغيير

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

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

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

طلب الحصول على FirestoreAdmin.GetDatabase

الحقول
name

string

مطلوب. اسم النموذج projects/{project_id}/databases/{database_id}

طلب GetFieldRequest

طلب الحصول على FirestoreAdmin.GetField

الحقول
name

string

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

طلب GetIndexRequest

طلب الحصول على FirestoreAdmin.GetIndex

الحقول
name

string

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

ImportDocumentsMetadata

البيانات الوصفية لـ 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

موقع الملفات التي تم تصديرها يجب أن يتطابق هذا الحقل مع معلَمة Export_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 في وضع تخزين البيانات) المتاحة لطلبات البحث.

تعدادات
ANY_API لا يمكن استخدام الفهرس إلا من خلال واجهة برمجة تطبيقات طلب البحث الأصلي Firestore. هذا هو الخيار التلقائي.
DATASTORE_MODE_API يمكن استخدام الفهرس فقط من خلال Firestore في واجهة برمجة تطبيقات طلب البحث في وضع تخزين البيانات.

حقل الفهرس

حقل في الفهرس. يصف 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 يتم ترتيب الحقل تنازليًا حسب قيمة الحقل.

إعداد Vector

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

الحقول
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 API لتحديد سبب فشل العملية الأخيرة التي حاولت إنشاء هذا الفهرس، ثم أعد إنشاء الفهرس.

البيانات الوصفية الخاصة بعملية الفهرسة

البيانات الوصفية لـ 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

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

قائمة BackupschedulesRequest

طلب الحصول على FirestoreAdmin.ListBackupSchedules

الحقول
parent

string

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

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

الرد

تمثّل هذه السمة الردّ على 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}
show_deleted

bool

إذا كانت القيمة هي true، سيتم أيضًا عرض الموارد المحذوفة.

سرد قاعدة البيانات (ListDatabasesResponse)

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

الحقول
databases[]

Database

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

string

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

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

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

طلب الحصول على FirestoreAdmin.ListFields

الحقول
parent

string

مطلوب. اسم أحد الوالدين للنموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

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

int32

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

string

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

استجابة ListFieldsResponse

تمثّل هذه السمة الردّ على FirestoreAdmin.ListFields.

الحقول
fields[]

Field

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

string

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

طلب ListIndexesRequest

طلب الحصول على 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.longrun.Operations.CancelOperation.
FINALIZING تمت معالجة الطلب وهو في مرحلة المعالجة النهائية.
SUCCESSFUL اكتمل الطلب بنجاح.
FAILED انتهت معالجة الطلب، ولكن حدث خطأ.
CANCELLED اكتمل إلغاء الطلب بعد أن يحمل المستخدم الاسم google.longrun.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

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

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

رسالة الطلب لـ [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

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

UpdateDatabaseMetadata

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

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

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

طلب الحصول على FirestoreAdmin.UpdateDatabase

الحقول
database

Database

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

FieldMask

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

طلب التحديث

طلب الحصول على FirestoreAdmin.UpdateField

الحقول
field

Field

مطلوب. الحقل المطلوب تعديله
update_mask

FieldMask

قناع، نسبةً إلى الحقل. في حال تحديد هذا الخيار، سيتم تعديل الإعدادات المحدّدة من خلال هذا الحقل (قناع الحقل) فقط في الحقل.

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

يمثل جدولاً زمنيًا متكررًا يعمل في يوم محدد من الأسبوع.

المنطقة الزمنية هي التوقيت العالمي المتفق عليه (UTC).

الحقول
day

DayOfWeek

يوم من الأسبوع لعرضه.

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