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.

مثال‌ها: (توجه: نظرات در اینجا با نحو علامت‌گذاری نوشته می‌شوند، بنابراین یک لایه بکتیک اضافی برای نمایش یک بلوک کد وجود دارد) \ address.city` represents a field named address.city است , not the map key in the field . "*" represents a field named *` است، نه هر فیلدی.

یک Field ویژه شامل تنظیمات نمایه سازی پیش فرض برای همه فیلدها است. نام منبع این فیلد این است: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* شاخص‌های تعریف‌شده در این Field برای همه فیلدهایی که پیکربندی نمایه Field خود را ندارند اعمال می‌شوند.

indexConfig

object ( IndexConfig )

پیکربندی شاخص برای این فیلد. اگر تنظیم نشود، نمایه سازی فیلد به پیکربندی تعریف شده توسط ancestorField باز می گردد. برای حذف صریح تمام نمایه‌های این فیلد، یک پیکربندی شاخص با فهرست خالی از نمایه‌ها را مشخص کنید.

ttlConfig

object ( TtlConfig )

پیکربندی TTL برای این Field . تنظیم یا لغو تنظیم آن، TTL را برای اسنادی که دارای این Field هستند فعال یا غیرفعال می کند.

IndexConfig

پیکربندی شاخص برای این فیلد.

نمایندگی JSON
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
زمینه های
indexes[]

object ( Index )

شاخص های پشتیبانی شده برای این زمینه

usesAncestorConfig

boolean

فقط خروجی وقتی درست است، پیکربندی نمایه Field از پیکربندی مشخص شده توسط ancestorField تنظیم می شود. هنگامی که نادرست است، پیکربندی نمایه Field به صراحت تعریف می شود.

ancestorField

string

فقط خروجی نام منبع Field را مشخص می‌کند که پیکربندی فهرست این فیلد از آن تنظیم شده است (زمانی که usesAncestorConfig درست است)، یا اگر این فیلد پیکربندی فهرستی نداشته باشد، از آن تنظیم می‌شود (زمانی که usesAncestorConfig نادرست است).

reverting

boolean

فقط خروجی وقتی درست است، پیکربندی نمایه Field در حال بازگردانی است. پس از تکمیل، پیکربندی ایندکس به همان حالت فیلد مشخص شده توسط ancestorField منتقل می‌شود، در این مرحله usesAncestorConfig true و reverting false خواهد بود.

TtlConfig

پیکربندی TTL (زمان تا زندگی) برای اسنادی که دارای این مجموعه Field هستند.

ذخیره یک مقدار مهر زمانی در یک فیلد فعال با TTL به عنوان زمان انقضای مطلق سند تلقی می شود. مقادیر مهر زمانی در گذشته نشان می دهد که سند برای انقضای فوری واجد شرایط است. استفاده از هر نوع داده دیگری یا عدم وجود فیلد، انقضا را برای سند جداگانه غیرفعال می کند.

نمایندگی JSON
{
  "state": enum (State)
}
زمینه های
state

enum ( State )

فقط خروجی وضعیت پیکربندی TTL.

حالت

وضعیت اعمال پیکربندی TTL برای همه اسناد.

Enums
STATE_UNSPECIFIED وضعیت نامشخص یا ناشناخته است.
CREATING TTL در حال اعمال است. یک عملیات طولانی مدت فعال برای ردیابی تغییر وجود دارد. اسناد جدید نوشته شده دارای TTLهای درخواستی خواهند بود. TTLهای درخواستی در اسناد موجود هنوز در حال پردازش هستند. هنگامی که TTLها در تمام اسناد موجود پردازش شدند، وضعیت به "ACTIVE" منتقل می شود.
ACTIVE TTL برای همه اسناد فعال است.
NEEDS_REPAIR پیکربندی TTL را نمی توان برای همه اسناد موجود فعال کرد. اسناد جدید نوشته شده به اعمال TTL خود ادامه خواهند داد. LRO زمانی برگشت که آخرین تلاش برای فعال کردن TTL برای این Field ناموفق بود و ممکن است جزئیات بیشتری داشته باشد.

مواد و روش ها

get

 فراداده و پیکربندی یک فیلد را دریافت می کند.

list

 پیکربندی فیلد و ابرداده را برای این پایگاه داده فهرست می کند.

patch

 پیکربندی فیلد را به روز می کند.