如何为 NoSQL 全局辅助索引配置 Azure Cosmos DB（预览版）

1. 登录到 Azure 门户。

2. 转到你的 Azure Cosmos DB for NoSQL 帐户。

3. 在资源菜单中，选择“设置”。

4. 导航到“功能”页。 然后选择 NoSQL API 的全局辅助索引（预览版） 并 启用。

   

使用 Azure CLI，通过本机命令或 REST API 操作在 Azure Cosmos DB for NoSQL 帐户上启用全局辅助索引功能。

1. 登录 Azure CLI。

   az login
   

   注释

   此操作需要使用 Azure CLI，请参阅如何安装 Azure CLI。

2. 为现有 Azure Cosmos DB for NoSQL 帐户的资源组和帐户名称定义变量。

   # Variable for resource group name
   $resourceGroupName="<resource-group-name>"
   
   # Variable for account name
   $accountName="<account-name>"
   
   # Variable for Azure subscription
   $subscriptionId="<subscription-id>"
   

3. 使用功能清单创建一个名为 capabilities.json 的新 JSON 文件。

   {
     "properties": {
       "enableMaterializedViews": true
     }
   }
   

   注释

   用于启用全局辅助索引的属性名称是 enableMaterializedViews以前的特征名称。 启用具体化视图将启用全局辅助索引。

4. 获取帐户的标识符，并将其存储在名为 $accountId 的 shell 变量中。

   $accountId="/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/$accountName"
   

5. 使用 REST API 和 az rest，通过 HTTP PATCH 动词为账户启用预览全球二级索引功能。

   az rest \
       --method PATCH \
       --uri "https://management.azure.com/$accountId/?api-version=2022-11-15-preview" \
       --body @capabilities.json
   

1. 导航到 Azure Cosmos DB 帐户中的“数据资源管理器”。 在此示例中， gsi-src 选择源容器，然后从下拉列表中选择 “新建全局辅助索引 ”。

   

2. 将为你填充源容器 ID。 在 “索引容器 ID ”字段中，输入 gsi-target。

3. 在 “全局辅助索引定义 ”字段中，输入 SELECT c.customerId, c.emailAddress FROM c。

4. 在 “分区”键 字段中，输入 /emailAddress。

   

5. 全局辅助索引容器必须使用自动缩放吞吐量。 配置所需的任何其他容器设置，然后选择“ 确定 ”以创建全局辅助索引容器。

6. 创建全局辅助索引容器后，数据会自动从源容器同步。 尝试在源容器中执行创建、更新和删除操作。 您会看到相同的更改被传播到全局辅助索引中的项目。

1. 创建与源容器不同的分区键路径命名 gsi-target 的全局辅助索引。 对于此示例，请将 /emailAddress 指定为 gsi-target 容器的分区键路径。

   1. 为全局辅助索引创建定义清单，并将其保存在名为 gsi-definition.json的 JSON 文件中。 全局辅助索引容器必须使用自动缩放吞吐量。 在此阶段，还可以定义任何其他相关的容器属性，例如索引策略。

      {
        "location": "West US 2",
        "tags": {},
        "properties": {
          "resource": {
            "id": "gsi-target",
            "partitionKey": {
              "paths": [
                "/emailAddress"
              ]
            },
            "materializedViewDefinition": {
              "sourceCollectionId": "gsi-src",
              "definition": "SELECT c.customerId, c.emailAddress FROM c"
            }
          },
          "options": {
            "autoscaleSettings": {
              "maxThroughput": 1000
            }
          }
        }
      }        
      

   重要

   请注意，分区键路径设置为 /emailAddress.

   定义全局辅助索引的属性是 materializedViewDefinition此功能的前一个名称。 定义 sourceCollectionId 源容器和 definition 包含用于确定索引容器的数据模型的查询。 创建全局辅助索引源容器和定义查询后无法更改。 详细了解 如何定义全局辅助索引 和查询约束。

2. 接下来，进行 REST API 调用以创建 gsi-definition.json 文件中定义的全局辅助索引。 使用 Azure CLI 发出 REST API 调用。

   1. 为全局辅助索引和源数据库名称的名称创建变量：

      # This should match the resource ID you defined in your json file
      $gsiContainerName = "gsi-target"
      
      # Database name for the source and index containers
      $databaseName = "<Database that contains source container>"
      
      # Azure Cosmos DB account name
      $accountName = "<Azure Cosmos DB account name>"
      
      # Resource name for your Azure Cosmos DB account
      $resourceGroupName = "<Resource group for Azure Cosmos DB account>"
      
      # Subscription id for your Azure Cosmos DB account
      $subscriptionId = "<Subscription id>"
      

   2. 使用这些变量构造资源 ID。

      $accountId = "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/$accountName"
      

   3. 进行 REST API 调用以创建全局辅助索引：

      az rest \
          --method PUT \
          --uri "https://management.azure.com$accountId/sqlDatabases/$databaseName/containers/$gsiContainerName/?api-version=2022-11-15-preview" \
          --body @gsi-definition.json \
          --headers content-type=application/json \
          --output json \
          --verbose
      

   4. 使用 REST API 检查全局辅助索引容器创建的状态：

      az rest \
          --method GET \
          --uri "https://management.azure.com$accountId/sqlDatabases/$databaseName/containers/$gsiContainerName/?api-version=2022-11-15-preview" \
          --headers content-type=application/json \
          --query "{mvCreateStatus: properties.Status}"
      

3. 创建全局辅助索引后，数据会自动从源容器同步。 尝试在源容器中执行创建、更新和删除操作。 您会看到相同的更改被传播到全局辅助索引中的项目。

Container container = client.GetDatabase("gsi-db").GetContainer("gsi-target");

FeedIterator<MyClass> myQuery = container.GetItemQueryIterator<MyClass>(new QueryDefinition("SELECT * FROM c WHERE c.emailAddress = 'justine@contoso.com'"));

CosmosAsyncDatabase container = client.getDatabase("gsi-db");
CosmosAsyncContainer container = database.getContainer("gsi-target");

CosmosPagedFlux<MyClass> pagedFluxResponse = container.queryItems(
        "SELECT * FROM c WHERE c.emailAddress = 'justine@contoso.com'", null, MyClass.class);

const database = client.database("gsi-db");
const container = database.container("gsi-target");

const querySpec = {
    query: "SELECT * FROM c WHERE c.emailAddress = 'justine@contoso.com'"
 };
const { resources: items } = await container.items
    .query(querySpec)
    .fetchAll();

database = client.get_database_client("gsi-db")
container = database.get_container_client("gsi-target")

query = "SELECT * FROM c WHERE c.emailAddress = 'justine@contoso.com'"
container.query_items(
    query=query
)

gsiContainer, err := client.NewContainer("gsi-db", "gsi-target")

pager := gsiContainer.NewQueryItemsPager("select * from c where c.state = @state", azcosmos.NewPartitionKey(), &azcosmos.QueryOptions{
	QueryParameters: []azcosmos.QueryParameter{
		{
			Name:  "@state",
			Value: "Alaska",
		},
	},
})

if pager.More() {
  // Iterate through the results
  // page, _ := pager.NextPage(context.Background())
}