REST Resource: projects.databases.indexes

منبع: فهرست

یک تعریف شاخص

نمایندگی JSON
{
  "name": string,
  "collectionId": string,
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
زمینه های
name

string

نام منبع شاخص فقط خروجی

collectionId

string

شناسه مجموعه ای که این شاخص برای آن اعمال می شود. ضروری.

fields[]

object ( IndexField )

فیلدهایی که باید نمایه شوند.

state

enum ( State )

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

IndexField

یک فیلد از یک شاخص

نمایندگی JSON
{
  "fieldPath": string,
  "mode": enum (Mode)
}
زمینه های
fieldPath

string

مسیر میدان. باید با مشخصات مسیر میدانی که توسط [google.firestore.v1beta1.Document.fields][fields] توضیح داده شده مطابقت داشته باشد. مسیر فیلد ویژه __name__ ممکن است به تنهایی یا در انتهای یک مسیر استفاده شود. __type__ فقط در انتهای مسیر قابل استفاده است.

mode

enum ( Mode )

حالت میدان.

حالت

حالت نحوه نمایه شدن یک فیلد را تعیین می کند.

Enums
MODE_UNSPECIFIED حالت نامشخص است.
ASCENDING مقادیر فیلد به گونه‌ای ایندکس می‌شوند که از ترتیب‌بندی به ترتیب صعودی پشتیبانی می‌کنند و همچنین با <، >، <=، >=، و = پرس و جو می‌شوند.
DESCENDING مقادیر فیلد به گونه‌ای ایندکس می‌شوند که از ترتیب‌دهی به ترتیب نزولی پشتیبانی می‌کنند و همچنین با <، >، <=، >=، و = پرس و جو می‌شوند.
ARRAY_CONTAINS مقادیر آرایه فیلد برای پشتیبانی از عضویت با استفاده از پرس و جوهای ARRAY_CONTAINS ایندکس می شوند.

حالت

وضعیت یک شاخص در طول ایجاد ایندکس، یک نمایه در حالت CREATING خواهد بود. اگر نمایه با موفقیت ایجاد شود، به حالت READY منتقل می شود. اگر نمایه ایجاد نشود، به حالت ERROR تبدیل می شود.

Enums
STATE_UNSPECIFIED ایالت نامشخص است.
CREATING شاخص در حال ایجاد است. یک عملیات طولانی مدت فعال برای شاخص وجود دارد. نمایه هنگام نوشتن یک سند به روز می شود. برخی از داده های شاخص ممکن است وجود داشته باشد.
READY شاخص آماده استفاده است. نمایه هنگام نوشتن یک سند به روز می شود. فهرست به طور کامل از تمام اسناد ذخیره شده ای که برای آنها اعمال می شود پر شده است.
ERROR شاخص در حال ایجاد بود، اما مشکلی پیش آمد. هیچ عملیات بلندمدت فعالی برای شاخص وجود ندارد و آخرین عملیات بلندمدت به پایان رسیده با شکست مواجه شد. هنگام نوشتن یک سند، ایندکس به روز نمی شود. برخی از داده های شاخص ممکن است وجود داشته باشد.

مواد و روش ها

create

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

delete

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

get

 شاخص می گیرد.

list

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