REST Resource: projects.databases.collectionGroups.fields

المورد: حقل

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

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

تمثيل JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
الحقول
name

string

مطلوب. اسم حقل للنموذج projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

قد يكون مسار الحقل اسم حقل بسيطًا، على سبيل المثال: address أو مسار إلى حقول داخل mapValue، على سبيل المثال. 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/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* الفهارس المحدّدة في Field هذا سيتم تطبيقها على جميع الحقول التي ليس لها إعدادات فهرس Field الخاصة بها.
indexConfig

object (IndexConfig)

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

object (TtlConfig)

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

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

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

تمثيل JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
الحقول
indexes[]

object (Index)

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

boolean

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

string

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

boolean

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

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

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

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

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

enum (State)

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

الولاية

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

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

الطُرق

get

 الحصول على البيانات الوصفية والتهيئة للحقل.

list

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

patch

 يتم تعديل إعدادات الحقل.