ניהול אינדקסים במהדורת Enterprise


התנהגות האינדוקס תלויה במהדורה של מסד הנתונים. בדף הזה מוסבר איך לנהל את האינדקסים שלכם ב-Firestore Enterprise edition. למידע על מהדורת Standard של Firestore, אפשר לעיין במאמר סקירה כללית על אינדקסים במהדורת Standard של Firestore.

מידע נוסף על אינדקסים במהדורת Enterprise של Firestore זמין במאמר סקירה כללית על אינדקסים.

לפני שמתחילים

לפני שיוצרים אינדקס ב-Firestore, צריך לוודא שהוקצה לכם אחד מהתפקידים הבאים:

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

הוראות להקצאת תפקיד מופיעות במאמר הקצאת תפקיד יחיד. מידע נוסף על תפקידים ב-Firestore וההרשאות שמשויכות אליהם זמין במאמר תפקידים מוגדרים מראש.

אם הגדרתם תפקידים בהתאמה אישית, צריך להקצות את כל ההרשאות הבאות כדי ליצור אינדקסים:

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

יצירת אינדקס

כדי ליצור אינדקס, מבצעים את השלבים הבאים:

מסוףGoogle Cloud

  1. נכנסים לדף Databases במסוף Google Cloud .

    מעבר אל Databases

  2. בוחרים מסד נתונים מתוך רשימת מסדי הנתונים.
  3. בתפריט הניווט, לוחצים על Indexes (אינדקסים).
  4. לוחצים על יצירת אינדקס.
  5. מזינים מזהה אוסף.
  6. מוסיפים נתיב שדה אחד או יותר ובוחרים אפשרות אינדקס לכל אחד מהם.
  7. בוחרים באפשרות של נוכחות שדה, לא דלילה או דלילה.
  8. אפשר גם להגדיר את האפשרות unique index.
  9. לוחצים על יצירה.
  10. האינדקס החדש מוצג ברשימת האינדקסים, ו-Firestore מתחיל ליצור את האינדקס. כשהאינדקס נוצר, מופיע סימן וי ירוק לצד האינדקס. אם האינדקס לא נוצר, כדאי לעיין במאמר בנושא שגיאות בבניית אינדקסים כדי לראות מה יכולות להיות הסיבות לכך.
‫CLI של gcloud

כדי ליצור אינדקס, משתמשים בפקודה gcloud firestore indexes composite create.

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

מחליפים את מה שכתוב בשדות הבאים:

  • ‫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.

כדי ליצור אינדקס ייחודי, מוסיפים את הדגל --unique.

Terraform

משתמשים במשאב google_firestore_index.

resource "google_firestore_index" "index" {
  database    = "DATABASE_ID"
  collection  = "COLLECTION"
  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

יצירת אינדקס טקסט

משתמשים במסוף Google Cloud כדי ליצור אינדקס טקסט.

  1. בGoogle Cloud מסוף, עוברים לדף Databases.

    מעבר אל Databases

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

  3. בתפריט הניווט, לוחצים על Indexes (אינדקסים).

  4. אופציונלי: מזינים שם לאינדקס.

  5. עוברים אל סוג החיפוש ובוחרים באפשרות טקסט.

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

  7. מגדירים שדה אחד או יותר לאינדקס.

  8. מגדירים את היקף השאילתה לאינדקס.

  9. בוחרים שפת ברירת מחדל.

  10. אופציונלי: מגדירים נתיב לשינוי שפה לשם שדה שמכיל את הגדרת השפה של המסמך.

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

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

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

משתמשים במסוף Google Cloud כדי ליצור אינדקס גיאו-מרחבי.

  1. בGoogle Cloud מסוף, עוברים לדף Databases.

    מעבר אל Databases

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

  3. בתפריט הניווט, לוחצים על Indexes (אינדקסים).

  4. אופציונלי: מזינים שם לאינדקס.

  5. עוברים אל סוג החיפוש ובוחרים באפשרות גיאוגרפי (2dsphere).

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

  7. מגדירים שדה אחד או יותר לאינדקס.

  8. מגדירים את היקף השאילתה לאינדקס.

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

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

מחיקת אינדקס

כדי למחוק אינדקס, פועלים לפי השלבים הבאים:

מסוףGoogle Cloud

  1. נכנסים לדף Databases במסוף Google Cloud .

    מעבר אל Databases

  2. בוחרים מסד נתונים מתוך רשימת מסדי הנתונים.
  3. בתפריט הניווט, לוחצים על Indexes (אינדקסים).
  4. ברשימת האינדקסים, לוחצים על הלחצן עוד לצד האינדקס שרוצים למחוק ובוחרים באפשרות מחיקה.
  5. לוחצים על מחיקת האינדקס.
‫CLI של gcloud

  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: מזהה מסד נתונים

זמן בניית האינדקס

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

  • משך זמן של תהליך build מינימלי של אינדקס הוא כמה דקות, גם אם מדובר במסד נתונים ריק.

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

ניהול פעולות ממושכות

יצירת אינדקסים היא פעולה ממושכת. בקטעים הבאים מוסבר איך לעבוד עם פעולות ממושכות של אינדקסים.

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