FieldOperationMetadata

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

تمثيل JSON
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
الحقول
startTime

string (Timestamp format)

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

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

endTime

string (Timestamp format)

وقت اكتمال هذه العملية. سيتم إلغاء التعيين في حال استمرار تنفيذ العملية.

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

field

string

تمثّل هذه السمة المورد الميداني الذي تعمل عليه هذه العملية. مثلاً: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object (IndexConfigDelta)

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

state

enum (OperationState)

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

progressDocuments

object (Progress)

التقدم في هذه العملية في المستندات.

progressBytes

object (Progress)

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

ttlConfigDelta

object (TtlConfigDelta)

تصف دلتا تكوين TTL.

أداة IndexConfigDelta

معلومات حول تغيير تهيئة الفهرس.

تمثيل JSON
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
الحقول
changeType

enum (ChangeType)

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

index

object (Index)

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

الفهرس

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

تمثيل JSON
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
الحقول
name

string

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

queryScope

enum (QueryScope)

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

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

apiScope

enum (ApiScope)

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

fields[]

object (IndexField)

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

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

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

state

enum (State)

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

حقل الفهرس

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

تمثيل JSON
{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}
الحقول
fieldPath

string

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

حقل الاتحاد value_mode. طريقة فهرسة قيمة الحقل يمكن أن يكون value_mode واحدًا فقط مما يلي:
order

enum (Order)

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

arrayConfig

enum (ArrayConfig)

يشير إلى أنّ هذا الحقل يتيح العمليات التي تتم على arrayValue.

vectorConfig

object (VectorConfig)

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

إعداد Vector

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

تمثيل JSON
{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}
الحقول
dimension

integer

مطلوب. بُعد الخط المتجه الذي تنطبق عليه هذه التهيئة.

سيتضمن الفهرس الناتج فقط متجهات لهذا البُعد، ويمكن استخدامه للبحث عن متجهات بنفس البُعد.

حقل الاتحاد type. نوع الفهرس المستخدَم. يمكن أن يكون type واحدًا فقط مما يلي:
flat

object (FlatIndex)

يشير إلى أن فهرس المتجه هو فهرس ثابت.

مؤشر فلات

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

فهرس يخزن المتجهات في هيكل بيانات مسطح ويدعم البحث الشامل.

لغة TtlConfigDelta

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

تمثيل JSON
{
  "changeType": enum (ChangeType)
}
الحقول
changeType

enum (ChangeType)

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