在 Azure Cosmos DB 中的数据库或容器上预配自动缩放吞吐量Provision autoscale throughput on database or container in Azure Cosmos DB

本文介绍如何在 Azure Cosmos DB 中的数据库或容器(集合、图或表)上预配自动缩放吞吐量。This article explains how to provision autoscale throughput on a database or container (collection, graph, or table) in Azure Cosmos DB. 可以在单个容器上启用自动缩放,也可以在数据库上预配自动缩放吞吐量,并在数据库中的所有容器之间共享。You can enable autoscale on a single container, or provision autoscale throughput on a database and share it among all the containers in the database.

Azure 门户Azure portal

使用自动缩放创建新的数据库或容器Create new database or container with autoscale

  1. 登录到 Azure 门户Sign in to the Azure portal.

  2. 导航到你的 Azure Cosmos DB 帐户,打开“数据资源管理器”选项卡。Navigate to your Azure Cosmos DB account and open the Data Explorer tab.

  3. 选择“新建容器”。Select New Container. 为数据库、容器和分区键输入一个名称。Enter a name for your database, container, and a partition key. 在“吞吐量”下,选择“自动缩放”选项,并设置希望数据库或容器缩放到的最大吞吐量(RU/秒)Under Throughput, select the autoscale option, and set the maximum throughput (RU/s) that you want the database or container to scale to.

    创建容器并配置自动缩放预配吞吐量

  4. 选择“确定” 。Select OK.

若要在共享的吞吐量数据库上预配自动缩放,请在创建新数据库时选择“预配数据库吞吐量”选项。To provision autoscale on shared throughput database, select the Provision database throughput option when creating a new database.

对现有数据库或容器启用自动缩放Enable autoscale on existing database or container

Important

在当前版本中,Azure 门户是在自动缩放和标准(手动)预配吞吐量之间迁移的唯一方法。In the current release, the Azure portal is the only way to migrate between autoscale and standard (manual) provisioned throughput.

  1. 登录到 Azure 门户Sign in to the Azure portal.

  2. 导航到你的 Azure Cosmos DB 帐户,打开“数据资源管理器”选项卡。Navigate to your Azure Cosmos DB account and open the Data Explorer tab.

  3. 为容器选择“缩放和设置”,或为数据库选择“缩放”。Select Scale and Settings for your container, or Scale for your database.

  4. 在“缩放”下,选择“自动缩放”选项和“保存”。Under Scale, select the Autoscale option and Save.

    对现有容器启用自动缩放

Note

在现有数据库或容器上启用自动缩放时,“最大 RU/秒”的起始值由系统根据当前手动预配吞吐量设置和存储确定。When you enable autoscale on an existing database or container, the starting value for max RU/s is determined by the system, based on your current manual provisioned throughput settings and storage. 操作完成后,可以根据需要更改“最大 RU/秒”。After the operation completes, you can change the max RU/s if needed. 了解详细信息。Learn more.

适用于 SQL API 的 Azure Cosmos DB .NET V3 SDKAzure Cosmos DB .NET V3 SDK for SQL API

使用 3.9 或更高版本的适用于 SQL API 的 Azure Cosmos DB .NET SDK 来管理自动缩放资源。Use version 3.9 or higher of the Azure Cosmos DB .NET SDK for SQL API to manage autoscale resources.

Important

可以使用 .NET SDK 来新建自动缩放资源。You can use the .NET SDK to create new autoscale resources. SDK 不支持在自动缩放和标准(手动)吞吐量之间迁移。The SDK does not support migrating between autoscale and standard (manual) throughput. 目前只有 Azure 门户支持迁移方案。The migration scenario is currently supported in only the Azure portal.

创建具有共享吞吐量的数据库Create database with shared throughput

// Create instance of CosmosClient
CosmosClient cosmosClient = new CosmosClient(Endpoint, PrimaryKey);
 
// Autoscale throughput settings
ThroughputProperties autoscaleThroughputProperties = ThroughputProperties.CreateAutoscaleThroughput(4000); //Set autoscale max RU/s

//Create the database with autoscale enabled
database = await cosmosClient.CreateDatabaseAsync(DatabaseName, throughputProperties: autoscaleThroughputProperties);

创建具有专用吞吐量的容器Create container with dedicated throughput

// Get reference to database that container will be created in
Database database = await cosmosClient.GetDatabase("DatabaseName");

// Container and autoscale throughput settings
ContainerProperties autoscaleContainerProperties = new ContainerProperties("ContainerName", "/partitionKey");
ThroughputProperties autoscaleThroughputProperties = ThroughputProperties.CreateAutoscaleThroughput(4000); //Set autoscale max RU/s

// Create the container with autoscale enabled
container = await database.CreateContainerAsync(autoscaleContainerProperties, autoscaleThroughputProperties);

读取当前吞吐量(RU/秒)Read the current throughput (RU/s)

// Get a reference to the resource
Container container = cosmosClient.GetDatabase("DatabaseName").GetContainer("ContainerName");

// Read the throughput on a resource
ThroughputProperties autoscaleContainerThroughput = await container.ReadThroughputAsync(requestOptions: null); 

// The autoscale max throughput (RU/s) of the resource
int? autoscaleMaxThroughput = autoscaleContainerThroughput.AutoscaleMaxThroughput;

// The throughput (RU/s) the resource is currently scaled to
int? currentThroughput = autoscaleContainerThroughput.Throughput;

更改自动缩放最大吞吐量(RU/秒)Change the autoscale max throughput (RU/s)

// Change the autoscale max throughput (RU/s)
await container.ReplaceThroughputAsync(ThroughputProperties.CreateAutoscaleThroughput(newAutoscaleMaxThroughput));

适用于 SQL API 的 Azure Cosmos DB Java V4 SDKAzure Cosmos DB Java V4 SDK for SQL API

可使用 4.0 或更高版本的适用于 SQL API 的 Azure Cosmos DB Java SDK 来管理自动缩放资源。You can use version 4.0 or higher of the Azure Cosmos DB Java SDK for SQL API to manage autoscale resources.

Important

可以使用 Java SDK 来新建自动缩放资源。You can use the Java SDK to create new autoscale resources. SDK 不支持在自动缩放和标准(手动)吞吐量之间迁移。The SDK does not support migrating between autoscale and standard (manual) throughput. 目前只有 Azure 门户支持迁移方案。The migration scenario is currently supported in only the Azure portal.

创建具有共享吞吐量的数据库Create database with shared throughput

// Create instance of CosmosClient
CosmosAsyncClient client = new CosmosClientBuilder()
    .setEndpoint(HOST)
    .setKey(MASTER)
    .setConnectionPolicy(CONNECTIONPOLICY)
    .buildAsyncClient();

// Autoscale throughput settings
ThroughputProperties autoscaleThroughputProperties = ThroughputProperties.createAutoscaledThroughput(4000); //Set autoscale max RU/s

//Create the database with autoscale enabled
CosmosAsyncDatabase database = client.createDatabase(databaseName, autoscaleThroughputProperties).block().getDatabase();

创建具有专用吞吐量的容器Create container with dedicated throughput

// Get reference to database that container will be created in
CosmosAsyncDatabase database = client.createDatabase("DatabaseName").block().getDatabase();

// Container and autoscale throughput settings
CosmosContainerProperties autoscaleContainerProperties = new CosmosContainerProperties("ContainerName", "/partitionKey");
ThroughputProperties autoscaleThroughputProperties = ThroughputProperties.createAutoscaledThroughput(4000); //Set autoscale max RU/s

// Create the container with autoscale enabled
CosmosAsyncContainer container = database.createContainer(autoscaleContainerProperties, autoscaleThroughputProperties, new CosmosContainerRequestOptions())
                                .block()
                                .getContainer();

读取当前吞吐量(RU/秒)Read the current throughput (RU/s)

// Get a reference to the resource
CosmosAsyncContainer container = client.getDatabase("DatabaseName").getContainer("ContainerName");

// Read the throughput on a resource
ThroughputProperties autoscaleContainerThroughput = container.readThroughput().block().getProperties();

// The autoscale max throughput (RU/s) of the resource
int autoscaleMaxThroughput = autoscaleContainerThroughput.getAutoscaleMaxThroughput();

// The throughput (RU/s) the resource is currently scaled to
int currentThroughput = autoscaleContainerThroughput.Throughput;

更改自动缩放最大吞吐量(RU/秒)Change the autoscale max throughput (RU/s)

// Change the autoscale max throughput (RU/s)
container.replaceThroughput(ThroughputProperties.createAutoscaledThroughput(newAutoscaleMaxThroughput)).block();

Cassandra APICassandra API

请参阅此文,了解如何使用 CQL 命令启用自动缩放。See this article on how to use CQL commands to enable autoscale.

用于 MongoDB 的 Azure Cosmos DB APIAzure Cosmos DB API for MongoDB

请参阅此文,了解如何使用 MongoDB 扩展命令启用自动缩放。See this article on how to use MongoDB extension commands to enable autoscale.

Azure Resource ManagerAzure Resource Manager

可以使用资源管理器模板为任何 API 预配数据库或容器的自动缩放吞吐量。You can use an Resource Manager template to provision autoscale throughput on a database or container for any API. 有关示例,请参阅此文See this article for a sample.

后续步骤Next steps