本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 索引建立
<a name="index-creation"></a>

在 Amazon DocumentDB 中建置索引需要做出許多決策：
+ 需要多快完成？
+ 當組建發生時，集合是否無法存取？
+ 可以配置多少執行個體的運算能力給組建？
+ 應該建立哪種類型的索引？

本節可協助您回答這些問題，並提供命令和監控範例，以在執行個體型叢集集合上建立 Amazon DocumentDB 索引。

## 指導方針
<a name="index-creation-guidelines"></a>

下列準則包括在建立新索引時的基本限制和組態權衡：
+ **Amazon DocumentDB 版本支援** - 雖然所有 Amazon DocumentDB 版本都支援單一工作者索引，但僅在 Amazon DocumentDB 4.0 和 5.0 版上支援多個工作者索引。
+ **效能權衡** - 在索引建立程序中增加工作者數量會增加 CPU 使用率，並在 Amazon DocumentDB 資料庫的主要執行個體上讀取 IO。建立新索引所需的資源將不適用於您執行中的工作負載。
+ **彈性叢集** - Amazon DocumentDB 彈性叢集不支援平行索引。
+ **工作者數量上限** - 您可以設定的工作者數量上限取決於資料庫叢集中主要執行個體的大小。這是資料庫叢集主要執行個體上 vCPUs總數的一半。例如，您可以在具有 64 個 vCPUs 的 db.r6g.16xlarge 執行個體上執行最多 32 個工作者。

**注意**  
執行個體 2xlarge 及更高版本支援平行索引建置。
+ **最低工作者** - 您可以設定的工作者數量下限為 1。在執行個體型叢集上建立索引的預設設定為兩個工作者。不過，您可以使用「工作者執行緒」選項，將工作者數量減少為一個。這將使用單一工作者執行程序。
+ **索引壓縮** - Amazon DocumentDB 不支援索引壓縮。索引的資料大小可能大於您使用其他選項時的大小。
+ **索引多個集合** - 資料庫叢集主要執行個體上的一半 vCPUs 可用於在多個集合上執行索引建立的設定工作者。
+ **索引類型** - [索引類型](index-types.md) 如需 Amazon DocumentDB 上支援的索引類型清單，請參閱 。

## 索引建置類型
<a name="index-creation-build-types"></a>

索引組建的四種類型為：
+ **前景：**前景索引建置會封鎖建立索引之集合上的所有其他資料庫操作，直到索引建立完成為止。Amazon DocumentDB 前景建置由五個階段組成。
+ **前景 （唯一）：**單一文件 （唯一） 前景索引建置會封鎖其他資料庫操作，例如一般前景建置。與基本前景建置不同，唯一建置會使用額外的階段 （排序金鑰 2) 來尋找重複的金鑰。前景 （唯一） 建置由六個階段組成。
+ **背景：**背景索引建置允許在建立索引時，在前景中執行其他資料庫操作。Amazon DocumentDB 背景建置由八個階段組成。
+ **背景 （唯一）：**單一文件 （唯一） 背景索引建置可讓其他資料庫操作在建立索引時於前景執行。與基本背景建置不同，唯一建置會使用額外的階段 （排序金鑰 2) 來尋找重複的金鑰。背景 （唯一） 建置由九個階段組成。

預設索引建置類型為前景。

若要在背景中建立索引，請在建立索引時新增「背景」： true 參數。

## 開始使用
<a name="index-creation-getting-started"></a>

若要開始在集合上建立索引，請使用 createIndexes 命令。根據預設，命令會執行兩個平行工作者，將索引建立程序的速度增加兩次。

例如，下列命令程序示範如何在文件中為 "user\_name" 欄位建立索引，並將索引程序速度提高到四名工作者：

1. 在叢集上使用兩個平行工作者在背景建立索引：

   ```
   db.runCommand({"createIndexes":"test","indexes":[{"key": {"user_name":1}, "name":"username_idx", "background":true }]})
   ```

1. 若要最佳化索引建立程序的速度，您可以使用 db.runCommand createIndexes 命令中的「工作者執行緒」選項 (「工作者」：<number>) 來指定工作者數量。

   將程序的速度提高到四個平行工作者：

   ```
   db.runCommand({"createIndexes":"test","indexes":[{"key": {"user_name":1}, "name":"username_idx", "workers":4}]})
   ```

**注意**  
工作者數量越高，建立索引的速度就越快。不過，工作者數量越高，主要執行個體vCPUs 和讀取 IO 的負載越高。確保您的叢集已充分佈建，以處理增加的負擔，而不會降低其他工作負載。

## 索引進度狀態
<a name="index-creation-progress-status"></a>

索引建立程序的運作方式是初始化、掃描集合、排序索引鍵，最後則是透過索引建置器插入索引鍵。當您在前景執行時，此程序最多有六個階段，而在背景執行時最多有九個階段。您可以依階段檢視狀態指標，例如完成百分比、掃描的儲存區塊總數、已排序的金鑰和插入的金鑰。

使用 mongo shell 中的 db.currentOp() 命令來監控索引程序的進度。完成最後一個階段的 100% 顯示已成功建立所有索引：

```
db.currentOp({"command.createIndexes": { $exists : true } })
```

**注意**  
只有 Amazon DocumentDB 5.0 才支援檢視索引進度狀態。

## 索引建置階段
<a name="index-creation-build-stages"></a>


| 階段 | 前景 | 前景 （唯一） | 背景介紹 | 背景 （唯一） | 
| --- | --- | --- | --- | --- | 
| 初始化 | 1 | 1 | 1 | 1 | 
| 建置索引：初始化 | 2 | 2 | 2 | 2 | 
| 建置索引：掃描集合 | 3 | 3 | 3 | 3 | 
| 建置索引：排序索引鍵 1 | 4 | 4 | 4 | 4 | 
| 建置索引：排序索引鍵 2 |  | 5 |  | 5 | 
| 建置索引：插入索引鍵 | 5 | 6 | 5 | 6 | 
| 驗證：掃描索引 |  |  | 6 | 7 | 
| 驗證：排序元組 |  |  | 7 | 8 | 
| 驗證：掃描集合 |  |  | 8 | 9 | 
+ **初始化** - createIndex 正在準備索引建置器。此階段應該非常簡短。
+ **建置索引：初始化** - 索引建置器正在準備建立索引。此階段應該非常簡短。
+ **建置索引：掃描集合** - 索引建置器正在執行集合掃描以收集索引鍵。度量單位為「區塊」。

**注意**  
如果針對索引建置設定了多個工作者，則會顯示在此階段。「掃描集合」階段是唯一在索引建置過程中使用多個工作者的階段。所有其他階段都會顯示單一工作者。
+ **建置索引：排序索引鍵 1** - 索引建置器正在排序收集的索引鍵。度量單位為「金鑰」。
+ **建置索引：排序索引鍵 2** - 索引建置器正在排序與無效元組對應的收集索引鍵。此階段僅適用於唯一的索引建置。度量單位為「金鑰」。
+ **建置索引：插入索引鍵** - 索引建置器正在將索引鍵插入新索引。度量單位為「金鑰」。
+ **驗證：掃描索引** - createIndex 正在掃描索引，以尋找需要驗證的金鑰。度量單位為「區塊」。
+ **驗證：排序元組** - createIndex 正在排序索引掃描階段的輸出。
+ **驗證：掃描集合** - createIndex 正在掃描集合，以驗證前兩個階段中找到的索引鍵。度量單位為「區塊」。

## 索引建置輸出範例
<a name="index-creation-build-output"></a>

在下列輸出範例中 （前景索引建置），會顯示索引建立的狀態。"msg" 欄位會指出建置的階段和完成百分比，以摘要說明建置進度。「工作者」欄位指出索引建置的該階段期間所使用的工作者數量。「進度」欄位會顯示用於計算完成百分比的實際數字。

**注意**  
Amazon DocumentDB 4.0 版不支援 "currentIndexBuildName"、"msg" 和 "progress" 欄位。

```
{
    "inprog" : [{
    … 
        "command": {
            "createIndexes": "test",
            "indexes": [{
                "v": 2,
                "key": {
                    "user_name": 1
                },
                "name": "user_name_1"
            }],
            "lsid": {
                "id": UUID("094d0fba-8f41-4373-82c3-7c4c7b5ff13b")
            },
            "$db": "test"
        },
        "currentIndexBuildName": user_name_1,
        "msg": "Index Build: building index number_1, stage 6/6 building index: 656860/1003520 (keys) 65%",
        "workers": 1,
        "progress": {
            "done": 656861,
            "total": 1003520
        },
    … 
    ],
 
    "ok" : 1
}
```

## 疑難排解資源
<a name="index-creation-troubleshooting"></a>

請參閱下列有關對索引建立問題進行疑難排解的資源：
+ [索引建置失敗](troubleshooting.index-creation.md#troubleshooting.index-build-fails)
+ [背景索引建置延遲問題和失敗](troubleshooting.index-creation.md#troubleshooting.background-index-build-fails)