ניהול האינדקסים

MongoDB API

משתמשים ב-method‏ 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 API משתמשים בשם השיטה google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• אפשרויות האינדקס הנתמכות מפורטות במאמר אינדקסים ומאפייני אינדקס.

מסוף Firebase

1. במסוף Firebase, עוברים לדף Firestore Database.

   מעבר אל Firestore Database

2. בוחרים מסד נתונים מתוך רשימת מסדי הנתונים.
3. בכרטיסייה Indexes, לוחצים על Create Index.
4. מזינים מזהה אוסף.
5. מוסיפים נתיב שדה אחד או יותר ובוחרים אפשרות אינדקס לכל אחד מהם.
6. בוחרים באפשרות של נוכחות שדה, לא דלילה או דלילה.
7. אפשר גם להגדיר את האפשרות multikey index.
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

משתמשים ב-method‏ createIndex() כדי ליצור אינדקס טקסט. בדוגמה הבאה, כשמסמך נכתב לאוסף cities עם השדות country או food מלאים, השדות האלה עוברים אינדוקס לצורכי חיפוש.

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

כדי ליצור אינדקס לשדה, הוא צריך להיות מחרוזת או מערך של מחרוזות. אינדקסים של מערכים לא נוספים לאינדקס החיפוש. כתוצאה מכך, הפעולה indexing 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 API משתמשים בשם השיטה google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• אפשרויות האינדקס הנתמכות מפורטות במאמר אינדקסים ומאפייני אינדקס.

מסוף Firebase

1. במסוף Firebase, עוברים לדף Firestore Database.

   מעבר אל Firestore Database

2. בוחרים מסד נתונים מתוך רשימת מסדי הנתונים.

3. בכרטיסייה Indexes, לוחצים על Create Index.

4. מזינים מזהה אוסף.

5. מוסיפים נתיב שדה אחד או יותר ובוחרים אפשרות אינדקס לכל אחד מהם.

6. לוחצים על יצירה.

7. האינדקס החדש מוצג ברשימת האינדקסים, והמערכת מתחילה ליצור את האינדקס באמצעות פעולות שתואמות ל-MongoDB. אחרי שהאינדקס נוצר, יופיע סימן וי ירוק ליד האינדקס. אם האינדקס לא נוצר, כדאי לעיין בשגיאות בבניית אינדקס כדי לראות מה יכולות להיות הסיבות לכך.

MongoDB API

משתמשים ב-method‏ 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 Database.

   מעבר אל Firestore Database

2. בוחרים מסד נתונים מתוך רשימת מסדי הנתונים.

3. בכרטיסייה Indexes, לוחצים על Create Index.

4. מזינים מזהה אוסף.

5. מוסיפים נתיב שדה אחד או יותר ובוחרים אפשרות אינדקס לכל אחד מהם.

6. לוחצים על יצירה.

7. האינדקס החדש מוצג ברשימת האינדקסים, והמערכת מתחילה ליצור את האינדקס באמצעות פעולות שתואמות ל-MongoDB. אחרי שהאינדקס נוצר, יופיע סימן וי ירוק ליד האינדקס. אם האינדקס לא נוצר, כדאי לעיין בשגיאות בבניית אינדקס כדי לראות מה יכולות להיות הסיבות לכך.

MongoDB API

כדי למחוק אינדקס, משתמשים ב-method ‏dropIndex(). לדוגמה:

מחיקת אינדקס באמצעות שם האינדקס

db.restaurants.dropIndex("cuisine_index")

מחיקת אינדקס באמצעות הגדרת אינדקס

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

מסוף Firebase

1. במסוף Firebase, עוברים לדף Firestore Database.

   מעבר אל Firestore Database

2. בוחרים מסד נתונים מתוך רשימת מסדי הנתונים.
3. לוחצים על הכרטיסייה Indexes (אינדקסים).
4. ברשימת האינדקסים, לוחצים על Delete (מחיקה) בלחצן More (אפשרויות נוספות) more_vert של האינדקס שרוצים למחוק.
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: מזהה מסד נתונים