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

رابط برنامه‌نویسی کاربردی مونگودی‌بی

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

•   db.restaurants.createIndex({"cuisine" : 1})
    

•   db.restaurants.createIndex({"cuisine" : 1}, {sparse: true})
    

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

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

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

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

کنسول Firebase

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

   به پایگاه داده فایراستور بروید

2. یک پایگاه داده از لیست پایگاه‌های داده انتخاب کنید.
3. در تب Indexes ، روی Create Index کلیک کنید.
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 را اضافه کنید.

ترافرم

از منبع 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

رابط برنامه‌نویسی کاربردی مونگودی‌بی

از متد 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 از هیچ فیلدی به عنوان لغو زبان استفاده نمی‌کند.

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

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

برای ایجاد یک فهرست با یک پارتیشن، فیلد 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 از متدی با نام google.firestore.admin.v1.FirestoreAdmin.CreateIndex استفاده می‌کنند.
• برای گزینه‌های پشتیبانی‌شده برای اندیس‌ها، به اندیس‌ها و ویژگی‌های اندیس مراجعه کنید.

کنسول Firebase

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

   به پایگاه داده فایراستور بروید

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

3. در تب Indexes ، روی Create Index کلیک کنید.

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

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

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

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

رابط برنامه‌نویسی کاربردی مونگودی‌بی

برای ایجاد یک اندیس از متد 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 از متدی با نام google.firestore.admin.v1.FirestoreAdmin.CreateIndex استفاده می‌کنند.
• برای گزینه‌های پشتیبانی‌شده برای اندیس‌ها، به اندیس‌ها و ویژگی‌های اندیس مراجعه کنید.

کنسول Firebase

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

   به پایگاه داده فایراستور بروید

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

3. در تب Indexes ، روی Create Index کلیک کنید.

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

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

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

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

رابط برنامه‌نویسی کاربردی مونگودی‌بی

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

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

db.restaurants.dropIndex("cuisine_index")

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

db.restaurants.dropIndex({"cuisine" : 1})

کنسول Firebase

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

   به پایگاه داده فایراستور بروید

2. یک پایگاه داده از لیست پایگاه‌های داده انتخاب کنید.
3. روی برگه Indexes کلیک کنید.
4. در لیست ایندکس‌ها، از دکمه‌ی More more_vert گزینه‌ی Delete را برای ایندکسی که می‌خواهید حذف کنید، انتخاب کنید.
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 : شناسه پایگاه داده