REST Resource: projects.databases.collectionGroups.indexes

منبع: فهرست

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

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

مواد و روش ها

create

 یک شاخص ترکیبی ایجاد می کند.

delete

 یک شاخص ترکیبی را حذف می کند.

get

 یک شاخص ترکیبی می گیرد.

list

 فهرست های ترکیبی را فهرست می کند.