مدیریت نمایه‌ها

این صفحه نحوه مدیریت نمایه‌ها را شرح می‌دهد. برای کسب اطلاعات بیشتر درباره نمایه‌ها، نمای کلی نمایه‌ها را ببینید.

قبل از شروع

قبل‌از اینکه بتوانید نمایه‌ای در Cloud Firestore ایجاد کنید، مطمئن شوید که یکی از نقش‌های زیر به شما اختصاص داده شده است:

  • roles/datastore.owner
  • roles/datastore.indexAdmin
  • roles/editor
  • roles/owner

برای اعطای نقش، اعطای یک نقش را ببینید. برای اطلاعات بیشتر درباره نقش‌های Cloud Firestore و اجازه‌های مرتبط، به نقش‌های ازپیش تعریف‌شده مراجعه کنید.

اگر نقش‌های سفارشی تعریف کرده‌اید، همه اجازه‌های زیر را برای ایجاد نمایه‌ها اختصاص دهید:

  • datastore.indexes.create
  • datastore.indexes.delete
  • datastore.indexes.get
  • datastore.indexes.list
  • datastore.indexes.update

ایجاد نمایه

برای ایجاد نمایه، مراحل زیر را تکمیل کنید:

MongoDB API

از روش createIndex() برای ایجاد نمایه استفاده کنید. برای مثال:

  •   db.restaurants.createIndex({"cuisine" : 1})
      
  •   db.restaurants.createIndex({"cuisine" : 1}, {sparse: true})
      
  • ایجاد نمایه با db.runCommand() نیز با حداکثر یک نمایه پشتیبانی می‌شود.

      db.runCommand({"createIndexes":"restaurant", "indexes": [{"key": {"cuisine":1}, "name": "cuisine_index"}]})
      

به محدودیت‌های زیر توجه کنید:

  • در هر درخواست فقط می‌توانید یک نمایه ایجاد کنید. ‫db.collection.createIndexes() پشتیبانی نمی‌شود.
  • گزارش‌های ممیزی برای ایجاد نمایه با MongoDB API از نام روش google.firestore.admin.v1.FirestoreAdmin.CreateIndex استفاده می‌کنند.
  • برای گزینه‌های نمایه پشتیبانی‌شده، نمایه‌ها و ویژگی‌های نمایه را ببینید.
کنسول Firebase
  1. در کنسول Firebase، به صفحه Firestore Database بروید.

    رفتن به Firestore Database

  2. پایگاه داده‌ای را از فهرست پایگاه‌های داده انتخاب کنید.
  3. در برگه نمایه‌ها، روی ایجاد نمایه کلیک کنید.
  4. شناسه مجموعه را وارد کنید.
  5. یک یا چند مسیر فیلد اضافه کنید و برای هرکدام یک گزینه نمایه انتخاب کنید.
  6. یکی از گزینه‌های حضور فیلد را انتخاب کنید: غیرپراکنده یا پراکنده.
  7. درصورت تمایل، می‌توانید گزینه نمایه چندکلیدی را تنظیم کنید.
  8. روی ایجاد کردن کلیک کنید.
  9. نمایه جدیدتان در فهرست نمایه‌ها نمایش داده می‌شود و Cloud Firestore شروع به ایجاد نمایه شما می‌کند. وقتی نمایه شما ایجاد شد، علامت تأیید سبزرنگی در کنار نمایه خواهید دید. اگر نمایه ایجاد نشد، برای دلایل احتمالی به خطاهای ساخت نمایه مراجعه کنید.
gcloud CLI

برای ایجاد نمایه، از فرمان gcloud firestore indexes composite create استفاده کنید. api-scope را روی mongodb-compatible-api تنظیم کرد.

gcloud firestore indexes composite create \
--database='DATABASE_ID' \
--collection-group=COLLECTION \
--field-config=FIELD_CONFIGURATION \
--query-scope=collection-group \
--density=dense \
--api-scope=mongodb-compatible-api

موارد زیر را جایگزین کنید:

  • ‫DATABASE_ID: شناسه پایگاه داده.
  • ‫COLLECTION: نام مجموعه.
  • FIELD_CONFIGURATION: پیکربندی فیلد. برای هر فیلد، --field-config=field-path= را اضافه کنید. برای مثال:
        --field-config=field-path=user-id,order=descending \
        --field-config=field-path=score,order=descending
        

    برای اطلاعات بیشتر درباره پیکربندی این فیلدها، --field-config را ببینید.

برای ایجاد نمایه پراکنده، --density=sparse-any را تنظیم کنید.

برای ایجاد نمایه چندکلیدی، پرچم --multikey را اضافه کنید.

برای ایجاد نمایه منحصربه‌فرد، پرچم --unique را اضافه کنید.

Terraform

از منبع google_firestore_index استفاده کنید و api_scope را روی MONGODB_COMPATIBLE_API و query_scope را روی COLLECTION_GROUP تنظیم کنید.

resource "google_firestore_index" "index" {
  database    = "DATABASE_ID"
  collection  = "COLLECTION"
  api_scope   = "MONGODB_COMPATIBLE_API"
  query_scope = "COLLECTION_GROUP"

  // You can include multiple field blocks
  fields {
    field_path = "FIELD_PATH"
    order      = "ORDER"
  }

  // Optional
  multikey = true
  density  = "DENSITY"
}

موارد زیر را جایگزین کنید:

  • ‫DATABASE_ID: شناسه پایگاه داده برای پایگاه داده انتخابی شما
  • ‫COLLECTION: نام مجموعه برای نمایه‌سازی
  • ‫FIELD_PATH: نام فیلد برای نمایه‌سازی
  • ORDER: یکی از ASCENDING یا DESCENDING
  • DENSITY: یکی از SPARSE_ANY یا DENSE

ایجاد نمایه نوشتاری

اگر می‌خواهید جستجوی نوشتاری برای رشته‌های خاصی در مجموعه انجام دهید، نمایه نوشتاری ایجاد کنید.

برای ایجاد نمایه نوشتاری برای مجموعه‌تان، مراحل زیر را تکمیل کنید:

MongoDB API

از روش createIndex() برای ایجاد نمایه نوشتاری استفاده کنید. در مثال زیر، وقتی سندی در مجموعه cities با فیلدهای country یا food نوشته می‌شود، این فیلدها برای اهداف جستجو نمایه‌سازی می‌شوند.

db.cities.createIndex({"country": "text", "food": "text"})

فیلد باید رشته یا آرایه‌ای از رشته‌ها باشد تا نمایه‌سازی شود. نمایه‌های آرایه در جستجو نمایه نمی‌شوند. درنتیجه، نمایه‌سازی a.1.b، something را در {a: {1: {b: something}}} نمایه‌سازی می‌کند، اما در {a: [one, {b: something}]} نمایه‌سازی نمی‌کند.

همچنین می‌توانید با db.runCommand() نمایه ایجاد کنید. برای هر مجموعه فقط می‌توانید یک نمایه نوشتاری داشته باشید، اما می‌توانید چندین نمایه از انواع مختلف در یک db.runCommand() ایجاد کنید. مثال زیر از db.runCommand() برای ایجاد نمایه نوشتاری استفاده می‌کند:

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text" },
      name: "country_text_food_text"
    }
  ]
})

مشخص کردن زبان پیش‌فرض

همچنین می‌توانید به‌صورت اختیاری زبان پیش‌فرض یا مسیر فیلدی را در سندتان مشخص کنید که حاوی زبان پیش‌فرض باشد.

در مثال زیر، myLanguageField به‌عنوان language_override مشخص شده است. وقتی سندی در مجموعه cities دارای فیلدی به‌نام myLanguageField باشد، از مقدار آن فیلد برای تعیین زبان نمایه‌سازی فیلد country برای آن سند خاص استفاده می‌شود. این مقدار زبان پیش‌فرض french را لغو می‌کند.

db.cities.createIndex({"country": "text"}, {"default_language": "french", "language_override": "myLanguageField"})
  • می‌توانید زبان را به‌صورت نام کامل (english) یا کد زبان ISO دو حرفی (en) وارد کنید.
  • اگر زبان پیش‌فرض تنظیم نشده باشد، Cloud Firestore به‌طور پیش‌فرض روی انگلیسی تنظیم می‌شود.
  • فیلد لغو زبان باید فیلدی در سطح بالا باشد. اگر تنظیم نشود، فیلد لغو زبان به‌طور پیش‌فرض روی language تنظیم می‌شود.
  • اگر زبان پیش‌فرض را روی نویسه null تنظیم کنید، Cloud Firestore از هیچ فیلدی به‌عنوان لغو زبان استفاده نمی‌کند.

برای دیدن فهرست زبان‌های پشتیبانی‌شده، ازهم باز کنید

کد زبان نام زبان
«und» تشخیص خودکار
«af» آفریکانس
«ak» آکان
«sq» آلبانیایی
«صبح» آمهاریک
"ar" عربی
«hy» ارمنی
«az» آذربایجانی
«eu» باسک
«be» بلاروسی
«bn» بنگالی
«bs» بوسنیایی
«bg» بلغاری
«my» برمه‌ای
«ca» Catalan
«ceb» سبوانو
«chr» چروکی
«zh» چینی
"zh-Hant" چینی_سنتی
«ساعت» کرواتی
«cs» چک
«da» دانمارکی
"nl" هلندی
«en» انگلیسی
«eo» اسپرانتو
«et» استونیایی
«fil» فیلیپینی
«fi» فنلاندی
"fr" فرانسوی
"gl" گالیسی
«ka» گرجستانی
«de» آلمانی
«el» یونانی
"gu" گجراتی
«ht» کریول هائیتی
«ha» هوسایی
«haw» هاوایی
«iw» عبری
«سلام» کنید Hindi
«hmn» همونگ
«hu» مجاری
«is» ایسلندی
«ig» ایگبو
«id» اندونزیایی
«ga» ایرلندی
«it» ایتالیایی
«ja» ژاپنی
«jv» جاوه‌ای
«kn» کنادا
«kk» قزاقی
«کیلومتر» خمر
«ko» کره‌ای
«lo» لائوسی
«la» لاتین
"lv" لتونیایی
«lt» لیتوانیایی
«پوند» لوگزامبورگی
«mk» مقدونی
«میلی‌گرم» مالاگاسی
«میلی‌ثانیه» مالایایی
«میلی‌لیتر» مالایالام
«mt» مالتی
«مایل» مائوری
«mr» مراتی
«mfe» موریسین
«mn» مغولی
"sr-ME" صربی_مونته‌نگرو
"ne" نپالی
«نه» نروژی
«ny» نیانجایی
«یا» اودیا
"fa" فارسی
«pl» لهستانی
"pt-BR" پرتغالی_برزیل
"pt-PT" پرتغالی (پرتغال)
«pa» پنجابی
«ro» رومانیایی
"ru" روسی
«gd» گالیک اسکاتلندی
«sr» صربی
«st» سوتویی جنوبی
«si» سینهالی
«sk» اسلوواک
«sl» اسلوونیایی
«so» سومالی
«es» اسپانیایی
«su» سوندانی
«sw» سواحیلی
«sv» سوئدی
«tg» تاجیکی
«ta» Tamil
«te» تلوگو
«th» تایلندی
«tr» ترکی
«uk» اوکراینی
«ur» اردو
«uz» ازبکی
«vi» ویتنامی
«cy» ولزی
«yi» ییدیش
«yo» یوروبایی
«zu» زولو

تقسیم‌بندی نمایه نوشتار

همچنین می‌توانید نمایه‌تان را بااستفاده از یک فیلد پارتیشن‌بندی کنید تا بتوانید پُرسمان‌ها را براساس مقدار فیلد خاصی فیلتر کنید. این پیکربندی به شما امکان می‌دهد اگر همیشه به فیلتر شدن فیلد خاصی در نمایه‌ای که از آن پُرسمان می‌کنید نیاز دارید، پُرسمان‌های با عملکرد بهتری اجرا کنید.

برای ایجاد نمایه با پارتیشن، فیلد firestoreOptions را به‌صورت زیر پیکربندی کنید:

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text"},
      name: "country_text_food_text"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

مکان:

  • PARTITIONED_FIELD نام فیلدی است که برای افراز استفاده می‌شود. این مقدار باید رشته باشد و باید به فیلد سطح بالا ارجاع دهد. وقتی پُرسمانی را دربرابر نمایه پارتیشن‌بندی‌شده اجرا می‌کنید، می‌توانید نتایج را براساس مقدار این فیلد فیلتر کنید. برای مثال، می‌توانید نمایه‌تان را بااستفاده از city پارتیشن‌بندی کنید. اگر فیلد city در نمایه نوشتاری شما تعریف شده باشد، کاربران می‌توانند برای شهر خاصی پُرسمان کنند.

    بخش باید فقط یک فیلد باشد. اگر نمایه‌ای را پارتیشن‌بندی کنید، فقط می‌توانید پرسمان‌هایی را اجرا کنید که فیلد پارتیشن‌بندی‌شده در آن‌ها مشخص شده باشد.

محدودیت‌ها

  • در هر درخواست فقط می‌توانید یک نمایه ایجاد کنید.
  • گزارش‌های ممیزی برای ایجاد نمایه با MongoDB API از نام روش google.firestore.admin.v1.FirestoreAdmin.CreateIndex استفاده می‌کند.
  • برای گزینه‌های نمایه پشتیبانی‌شده، نمایه‌ها و ویژگی‌های نمایه را ببینید.

کنسول Firebase

  1. در کنسول Firebase، به صفحه پایگاه داده Firestore بروید.

    رفتن به Firestore Database

  2. پایگاه داده‌ای را از فهرست پایگاه‌های داده انتخاب کنید.

  3. در برگه نمایه‌ها، روی ایجاد نمایه کلیک کنید.

  4. شناسه مجموعه را وارد کنید.

  5. یک یا چند مسیر فیلد اضافه کنید و برای هرکدام یک گزینه نمایه انتخاب کنید.

  6. روی ایجاد کردن کلیک کنید.

  7. نمایه جدیدتان در فهرست نمایه‌ها نمایش داده می‌شود و عملیات سازگار با MongoDB شروع به ایجاد نمایه شما می‌کند. وقتی نمایه‌تان ایجاد شد، علامت تأیید سبزرنگی در کنار نمایه خواهید دید. اگر نمایه ایجاد نشده است، خطاهای ساخت نمایه را برای دلایل احتمالی ببینید.

gcloud CLI

برای ایجاد نمایه نوشتاری، از فرمان gcloud firestore indexes composite create استفاده کنید. --api-scope را روی mongodb-compatible-api تنظیم کرد.

gcloud firestore indexes composite create \
  --database='DATABASE_ID' \
  --collection-group=COLLECTION_GROUP \
  --field-config=field-path=FIELD_NAME,search-config='{"text-spec": {"index-specs": [{"index-type": "tokenized", "match-type": "match-globally"}]}}' \
  --api-scope=mongodb-compatible-api \
  --search-index-options=text-language=en \
  --async

موارد زیر را جایگزین کنید:

  • ‫DATABASE_ID: شناسه پایگاه داده.
  • COLLECTION_GROUP: شناسه مجموعه برای نمایه‌سازی.
  • FIELD_NAME: نام فیلد برای نمایه‌سازی.

پرچم --async عملیات ایجاد نمایه را در پس‌زمینه اجرا می‌کند.

ایجاد نمایه 2dsphere

نمایه 2dsphere ایجاد کنید تا پُرسمان‌های زمین‌مکانی را اجرا کنید و اسنادی را که در محدوده خاصی از طول و عرض جغرافیایی مشخصی وجود دارند جستجو کنید.

برای ایجاد نمایه 2dsphere برای مجموعه‌تان، مراحل زیر را تکمیل کنید:

MongoDB API

از روش createIndex() برای ایجاد نمایه استفاده کنید. برای مثال:

db.restaurants.createIndex({"location" : "2dsphere", "region": "2dsphere"})

ایجاد نمایه با db.runCommand() نیز با حداکثر یک نمایه پشتیبانی می‌شود:

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
    }
  ]
})

پارتیشن‌بندی نمایه 2dsphere

همچنین می‌توانید نمایه‌تان را بااستفاده از یک فیلد پارتیشن‌بندی کنید تا بتوانید پُرسمان‌ها را براساس مقدار فیلد خاصی فیلتر کنید. این پیکربندی به شما امکان می‌دهد اگر همیشه به فیلتر شدن فیلد خاصی در نمایه‌ای که از آن پُرسمان می‌کنید نیاز دارید، پُرسمان‌های با عملکرد بهتری اجرا کنید.

برای ایجاد نمایه با پارتیشن، فیلد firestoreOptions را به‌صورت زیر پیکربندی کنید:

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

مکان:

  • PARTITIONED_FIELD نام فیلدی است که برای افراز استفاده می‌شود. وقتی پُرسمانی را دربرابر نمایه پارتیشن‌بندی‌شده اجرا می‌کنید، می‌توانید نتایج را براساس مقدار این فیلد فیلتر کنید. برای مثال، اگر نمایه‌تان فیلد region برای مکان‌های منطقه‌ای داشته باشد، می‌توانید نمایه‌تان را بااستفاده از region پارتیشن‌بندی کنید تا کاربران بتوانند درباره رستوران‌های منطقه خودشان پُرسمان کنند.

    اگر نمایه‌ای را پارتیشن‌بندی کنید، فقط می‌توانید پُرسمان‌هایی را اجرا کنید که فیلد پارتیشن‌بندی‌شده در آن‌ها مشخص شده باشد.

محدودیت‌ها

  • در هر درخواست فقط می‌توانید یک نمایه ایجاد کنید.
  • گزارش‌های ممیزی برای ایجاد نمایه با MongoDB API از نام روش google.firestore.admin.v1.FirestoreAdmin.CreateIndex استفاده می‌کند.
  • برای گزینه‌های نمایه پشتیبانی‌شده، نمایه‌ها و ویژگی‌های نمایه را ببینید.

کنسول Firebase

  1. در کنسول Firebase، به صفحه پایگاه داده Firestore بروید.

    رفتن به Firestore Database

  2. پایگاه داده‌ای را از فهرست پایگاه‌های داده انتخاب کنید.

  3. در برگه نمایه‌ها، روی ایجاد نمایه کلیک کنید.

  4. شناسه مجموعه را وارد کنید.

  5. یک یا چند مسیر فیلد اضافه کنید و برای هرکدام یک گزینه نمایه انتخاب کنید.

  6. روی ایجاد کردن کلیک کنید.

  7. نمایه جدیدتان در فهرست نمایه‌ها نمایش داده می‌شود و عملیات سازگار با MongoDB شروع به ایجاد نمایه شما می‌کند. وقتی نمایه‌تان ایجاد شد، علامت تأیید سبزرنگی در کنار نمایه خواهید دید. اگر نمایه ایجاد نشده است، خطاهای ساخت نمایه را برای دلایل احتمالی ببینید.

gcloud CLI

برای ایجاد نمایه 2dsphere، از فرمان gcloud firestore indexes composite create استفاده کنید. --api-scope را روی mongodb-compatible-api تنظیم کرد.

gcloud firestore indexes composite create \
  --database='DATABASE_ID' \
  --collection-group=COLLECTION_GROUP \
  --field-config=field-path=FIELD_NAME,search-config='{"geo-spec": {}}' \
  --api-scope=mongodb-compatible-api \
  --async

موارد زیر را جایگزین کنید:

  • ‫DATABASE_ID: شناسه پایگاه داده.
  • COLLECTION_GROUP: شناسه مجموعه برای نمایه‌سازی.
  • FIELD_NAME: نام فیلد برای نمایه‌سازی.

پرچم --async عملیات ایجاد نمایه را در پس‌زمینه اجرا می‌کند.

حذف نمایه

برای حذف نمایه، مراحل زیر را تکمیل کنید:

MongoDB API

از روش dropIndex() برای حذف نمایه استفاده کنید. برای مثال:

حذف نمایه بااستفاده از نام نمایه

db.restaurants.dropIndex("cuisine_index")

حذف نمایه بااستفاده از تعریف نمایه

db.restaurants.dropIndex({"cuisine" : 1})
کنسول Firebase
  1. در کنسول Firebase، به صفحه Firestore Database بروید.

    رفتن به Firestore Database

  2. پایگاه داده‌ای را از فهرست پایگاه‌های داده انتخاب کنید.
  3. روی برگه نمایه‌ها کلیک کنید.
  4. در فهرست نمایه‌ها، حذف را از دکمه بیشتر برای نمایه‌ای که می‌خواهید حذف کنید انتخاب کنید.
  5. روی حذف نمایه کلیک کنید.
gcloud CLI
  1. برای پیدا کردن نام نمایه، از فرمان gcloud firestore indexes composite list استفاده کنید.

    gcloud firestore indexes composite list \
    --database='DATABASE_ID'

    DATABASE_ID را با شناسه پایگاه داده جایگزین کنید.

  2. برای حذف نمایه، از فرمان gcloud firestore indexes composite delete استفاده کنید.

    gcloud firestore indexes composite delete INDEX_NAME \
    --database='DATABASE_ID'

    موارد زیر را جایگزین کنید:

    • INDEX_NAME: نام نمایه
    • ‫DATABASE_ID: شناسه پایگاه داده

زمان ساخت نمایه

برای ساختن نمایه، Cloud Firestore باید نمایه را ایجاد کند و سپس ورودی‌های نمایه را با داده‌های موجود پر کند. زمان لازم برای ایجاد نمایه با موارد زیر تعیین می‌شود:

  • حداقل زمان ساخت برای نمایه چند دقیقه است، حتی برای پایگاه داده خالی.

  • مدت‌زمان لازم برای پر کردن ورودی‌های نمایه به مقدار داده‌های موجودی که به نمایه جدید تعلق دارد بستگی دارد. هرچه مقادیر فیلد بیشتری با تعریف نمایه مطابقت داشته باشد، تکمیل ورودی‌های نمایه بیشتر طول می‌کشد.

مدیریت عملیات‌های طولانی‌مدت

ساخت نمایه‌ها عملیات طولانی‌مدت است. بخش‌های زیر نحوه کار با عملیات طولانی‌مدت برای نمایه‌ها را شرح می‌دهد.

پس‌از شروع ایجاد نمایه، Cloud Firestore نامی یکتا به عملیات اختصاص می‌دهد. نام‌های عملیات با پیشوند projects/PROJECT_ID/databases/DATABASE_ID/operations/ شروع می‌شوند، برای مثال:

projects/PROJECT_ID/databases/DATABASE_ID/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

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

فهرست کردن همه عملیات‌های طولانی‌مدت

برای فهرست کردن عملیات طولانی‌مدت، از فرمان gcloud firestore operations list استفاده کنید. این فرمان عملیات‌های درحال انجام و اخیراً تکمیل‌شده را فهرست می‌کند. عملیات‌ها تا چند روز پس‌از تکمیل فهرست می‌شوند:

gcloud firestore operations list

بررسی وضعیت عملیات

به‌جای فهرست کردن همه عملیات‌های طولانی‌مدت، می‌توانید جزئیات یک عملیات را فهرست کنید:

gcloud firestore operations describe operation-name

درحال تخمین زدن زمان تکمیل

وقتی عملیاتتان اجرا می‌شود، مقدار فیلد state را برای وضعیت کلی عملیات ببینید.

درخواست وضعیت عملیات طولانی‌مدت نیز سنجه‌های workEstimated و workCompleted را برمی‌گرداند. workEstimated تعداد کل تخمینی اسنادی را که یک عملیات پردازش خواهد کرد نشان می‌دهد. workCompleted تعداد اسنادی را که تاکنون پردازش شده‌اند نشان می‌دهد. پس‌از تکمیل عملیات، workCompleted نشان‌دهنده تعداد کل اسنادی است که واقعاً پردازش شده‌اند، که ممکن است با مقدار workEstimated متفاوت باشد.

برای برآورد پیشرفت عملیات، workCompleted را بر workEstimated تقسیم کنید.

در زیر نمونه‌ای از پیشرفت ایجاد نمایه آورده شده است:

{
  "operations": [
    {
      "name": "projects/project-id/operations/AyAyMDBiM2U5NTgwZDAtZGIyYi0zYjc0LTIzYWEtZjg1ZGdWFmZWQHEjF0c2Flc3UtcmV4ZWRuaS1uaW1kYRUKSBI",
      "metadata": {
        "@type": "type.googleapis.com/google.firestore.admin.v1.IndexOperationMetadata",
        "common": {
          "operationType": "CREATE_INDEX",
          "startTime": "2020-06-23T16:52:25.697539Z",
          "state": "PROCESSING"
        },
        "progressDocuments": {
          "workCompleted": "219327",
          "workEstimated": "2198182"
        }
       },
    },
    ...

وقتی عملیاتی تکمیل می‌شود، شرح عملیات حاوی "done": true خواهد بود. برای نتیجه عملیات، مقدار فیلد state را ببینید. اگر فیلد done در پاسخ تنظیم نشده باشد، عملیات تکمیل نشده است.