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 "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

زمان تکمیل این عملیات اگر عملیات هنوز در حال انجام باشد، تنظیم نخواهد شد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "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 )

دامنه API که توسط این شاخص پشتیبانی می شود.

fields[]

object ( IndexField )

فیلدهای پشتیبانی شده توسط این شاخص

برای ایندکس های ترکیبی، حداقل 2 و حداکثر 100 فیلد لازم است. آخرین ورودی فیلد همیشه برای مسیر فیلد __name__ است. اگر در هنگام ایجاد، __name__ به عنوان آخرین فیلد مشخص نشده بود، به طور خودکار با همان جهت آخرین فیلد تعریف شده اضافه می شود. اگر فیلد نهایی در یک نمایه ترکیبی جهت دار نباشد، __name__ به صورت صعودی مرتب می شود (مگر اینکه به صراحت مشخص شده باشد).

برای فهرست های تک فیلد، این همیشه دقیقاً یک ورودی با مسیر فیلد برابر با مسیر فیلد مربوطه خواهد بود.

state

enum ( State )

فقط خروجی وضعیت خدمات شاخص.

IndexField

یک فیلد در یک شاخص 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

می تواند نام باشد. برای فهرست های تک فیلد، این باید با نام فیلد مطابقت داشته باشد یا ممکن است حذف شود.

فیلد اتحادیه value_mode . چگونه مقدار فیلد ایندکس می شود. value_mode فقط می تواند یکی از موارد زیر باشد:
order

enum ( Order )

نشان می دهد که این فیلد از ترتیب با ترتیب مشخص شده یا مقایسه با استفاده از =، !=، <، <=، >، >= پشتیبانی می کند.

arrayConfig

enum ( ArrayConfig )

نشان می دهد که این فیلد از عملیات روی arrayValue s پشتیبانی می کند.

vectorConfig

object ( VectorConfig )

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

VectorConfig

پیکربندی نمایه برای پشتیبانی از عملیات جستجوی برداری

نمایندگی 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 )

نشان می دهد که شاخص برداری یک شاخص مسطح است.

FlatIndex

این نوع هیچ فیلدی ندارد.

شاخصی که بردارها را در یک ساختار داده مسطح ذخیره می کند و از جستجوی جامع پشتیبانی می کند.

TtlConfigDelta

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

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

enum ( ChangeType )

نحوه تغییر پیکربندی TTL را مشخص می کند.