管理索引

MongoDB API

使用 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 資料庫

2. 從資料庫清單中選取資料庫。
3. 在「索引」分頁中，按一下「建立索引」。
4. 輸入集合 ID。
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：資料庫 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：所選資料庫的資料庫 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 編製索引時，系統會為 {a: {1: {b: something}}} 中的 something 編製索引，但不會為 {a: [one, {b: something}]} 中的 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. 在「索引」分頁中，按一下「建立索引」。

4. 輸入集合 ID。

5. 新增一或多個欄位路徑，並為每個路徑選取索引選項。

6. 點選「建立」。

7. 新索引會顯示在索引清單中，且 MongoDB 相容作業會開始建立索引。建立索引後，索引旁會顯示綠色勾號。如果未建立索引，請參閱「索引建構錯誤」一文，瞭解可能原因。

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 Database」頁面。

   前往 Firestore 資料庫

2. 從資料庫清單中選取資料庫。

3. 在「索引」分頁中，按一下「建立索引」。

4. 輸入集合 ID。

5. 新增一或多個欄位路徑，並為每個路徑選取索引選項。

6. 點選「建立」。

7. 新索引會顯示在索引清單中，且 MongoDB 相容作業會開始建立索引。建立索引後，索引旁會顯示綠色勾號。如果未建立索引，請參閱「索引建構錯誤」一文，瞭解可能原因。

MongoDB API

使用 dropIndex() 方法刪除索引。例如：

使用索引名稱刪除索引

db.restaurants.dropIndex("cuisine_index")

使用索引定義刪除索引

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

Firebase 控制台

1. 前往 Firebase 控制台的「Firestore Database」頁面。

   前往 Firestore 資料庫

2. 從資料庫清單中選取資料庫。
3. 按一下「索引」分頁標籤。
4. 在索引清單中，針對要刪除的索引，從「更多」按鈕 more_vert 選擇「刪除」。
5. 按一下「刪除索引」。

gcloud CLI

1. 如要找出索引名稱，請使用 gcloud firestore indexes composite list 指令。

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

   將 DATABASE_ID 替換為資料庫 ID。

2. 如要刪除索引，請使用 gcloud firestore indexes composite delete 指令。

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

   更改下列內容：

   • INDEX_NAME：索引名稱
   • DATABASE_ID：資料庫 ID