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

MongoDB API

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

מסוף Firebase

1. במסוף Firebase, נכנסים לדף Firestore Database.

   כניסה למסד הנתונים ב-Firestore

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

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

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 מריץ את פעולת יצירת האינדקס ברקע.

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

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

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

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 מריץ את פעולת יצירת האינדקס ברקע.