トランザクション バッチ操作を作成する場合、コンテナー インスタンスから開始し、CreateTransactionalBatch を呼び出します。
PartitionKey partitionKey = new PartitionKey("road-bikes");
TransactionalBatch batch = container.CreateTransactionalBatch(partitionKey);
次に、複数の操作をバッチに追加します。
Product bike = new (
id: "68719520766",
category: "road-bikes",
name: "Chropen Road Bike"
);
batch.CreateItem<Product>(bike);
Part part = new (
id: "68719519885",
category: "road-bikes",
name: "Tronosuros Tire",
productId: bike.id
);
batch.CreateItem<Part>(part);
最後に、バッチで ExecuteAsync を呼び出します。
using TransactionalBatchResponse response = await batch.ExecuteAsync();
応答を受信した後、その応答が成功かどうかを調べます。 応答が成功を示している場合は、結果を抽出します。
if (response.IsSuccessStatusCode)
{
TransactionalBatchOperationResult<Product> productResponse;
productResponse = response.GetOperationResultAtIndex<Product>(0);
Product productResult = productResponse.Resource;
TransactionalBatchOperationResult<Part> partResponse;
partResponse = response.GetOperationResultAtIndex<Part>(1);
Part partResult = partResponse.Resource;
}
重要
エラーが発生した場合は、失敗した操作に対応するエラーの状態コードが表示されます。 その他すべての操作では 424 状態コード (依存関係の失敗) が表示されます。 既に存在する項目を作成しようとして操作が失敗した場合は、状態コード 409 (競合) が返されます。 状態コードにより、トランザクション エラーの原因を特定できます。
トランザクション バッチ操作を作成する場合、CosmosBatch.createCosmosBatch を呼び出します。
PartitionKey partitionKey = new PartitionKey("road-bikes");
CosmosBatch batch = CosmosBatch.createCosmosBatch(partitionKey);
次に、複数の操作をバッチに追加します。
Product bike = new Product();
bike.setId("68719520766");
bike.setCategory("road-bikes");
bike.setName("Chropen Road Bike");
batch.createItemOperation(bike);
Part part = new Part();
part.setId("68719519885");
part.setCategory("road-bikes");
part.setName("Tronosuros Tire");
part.setProductId(bike.getId());
batch.createItemOperation(part);
最後に、コンテナー インスタンスを使用して、バッチで executeCosmosBatch を呼び出します。
CosmosBatchResponse response = container.executeCosmosBatch(batch);
応答を受信した後、その応答が成功かどうかを調べます。 応答が成功を示している場合は、結果を抽出します。
if (response.isSuccessStatusCode())
{
List<CosmosBatchOperationResult> results = response.getResults();
}
重要
エラーが発生した場合は、失敗した操作に対応するエラーの状態コードが表示されます。 その他すべての操作では 424 状態コード (依存関係の失敗) が表示されます。 既に存在する項目を作成しようとして操作が失敗した場合は、状態コード 409 (競合) が返されます。 状態コードにより、トランザクション エラーの原因を特定できます。
コンテナー インスタンスを取得または作成します。
container = database.create_container_if_not_exists(id="batch_container",
partition_key=PartitionKey(path='/category'))
Python において、トランザクション バッチ操作は単一操作 API とよく似ており、(operation_type_string、args_tuple、batch_operation_kwargs_dictionary) を含むタプルです。 バッチ操作の機能を実演するために使用されるサンプル項目を次に示します。
create_demo_item = {
"id": "68719520766",
"category": "road-bikes",
"name": "Chropen Road Bike"
}
# for demo, assume that this item already exists in the container.
# the item id will be used for read operation in the batch
read_demo_item1 = {
"id": "68719519884",
"category": "road-bikes",
"name": "Tronosuros Tire",
"productId": "68719520766"
}
# for demo, assume that this item already exists in the container.
# the item id will be used for read operation in the batch
read_demo_item2 = {
"id": "68719519886",
"category": "road-bikes",
"name": "Tronosuros Tire",
"productId": "68719520766"
}
# for demo, assume that this item already exists in the container.
# the item id will be used for read operation in the batch
read_demo_item3 = {
"id": "68719519887",
"category": "road-bikes",
"name": "Tronosuros Tire",
"productId": "68719520766"
}
# for demo, we'll upsert the item with id 68719519885
upsert_demo_item = {
"id": "68719519885",
"category": "road-bikes",
"name": "Tronosuros Tire Upserted",
"productId": "68719520768"
}
# for replace demo, we'll replace the read_demo_item2 with this item
replace_demo_item = {
"id": "68719519886",
"category": "road-bikes",
"name": "Tronosuros Tire replaced",
"productId": "68719520769"
}
# for replace with etag match demo, we'll replace the read_demo_item3 with this item
# The use of etags and if-match/if-none-match options allows users to run conditional replace operations
# based on the etag value passed. When using if-match, the request will only succeed if the item's latest etag
# matches the passed in value. For more on optimistic concurrency control, see the link below:
# https://learn.microsoft.com/azure/cosmos-db/nosql/database-transactions-optimistic-concurrency
replace_demo_item_if_match_operation = {
"id": "68719519887",
"category": "road-bikes",
"name": "Tronosuros Tireh",
"wasReplaced": "Replaced based on etag match"
"productId": "68719520769"
}
バッチに追加する操作を作成します。
create_item_operation = ("create", (create_demo_item,), {})
read_item_operation = ("read", ("68719519884",), {})
delete_item_operation = ("delete", ("68719519885",), {})
upsert_item_operation = ("upsert", (upsert_demo_item,), {})
replace_item_operation = ("replace", ("68719519886", replace_demo_item), {})
replace_item_if_match_operation = ("replace",
("68719519887", replace_demo_item_if_match_operation),
{"if_match_etag": container.client_connection.last_response_headers.get("etag")})
バッチにその操作を追加します。
batch_operations = [
create_item_operation,
read_item_operation,
delete_item_operation,
upsert_item_operation,
replace_item_operation,
replace_item_if_match_operation
]
最後に、そのバッチを実行します。
try:
# Run that list of operations
batch_results = container.execute_item_batch(batch_operations=batch_operations, partition_key="road_bikes")
# Batch results are returned as a list of item operation results - or raise a CosmosBatchOperationError if
# one of the operations failed within your batch request.
print("\nResults for the batch operations: {}\n".format(batch_results))
except exceptions.CosmosBatchOperationError as e:
error_operation_index = e.error_index
error_operation_response = e.operation_responses[error_operation_index]
error_operation = batch_operations[error_operation_index]
print("\nError operation: {}, error operation response: {}\n".format(error_operation, error_operation_response))
# [END handle_batch_error]
バッチ内での patch 操作と replace_if_match_etag 操作の使用に関する注意事項
バッチ操作の kwargs dictionary は制限されており、合計 3 つの異なるキー値のみを受け取ります。 バッチ内で条件付きの patch を使用する場合は、patch 操作で filter_predicate キーを使用することができます。または、任意の操作で etag を使用する場合は、if_match_etag/if_none_match_etag キーを使用することもできます。
batch_operations = [
("replace", (item_id, item_body), {"if_match_etag": etag}),
("patch", (item_id, operations), {"filter_predicate": filter_predicate, "if_none_match_etag": etag}),
]
エラーが発生した場合は、失敗した操作に対応するエラーの状態コードが表示されます。 その他すべての操作では 424 状態コード (依存関係の失敗) が表示されます。 既に存在する項目を作成しようとして操作が失敗した場合は、状態コード 409 (競合) が返されます。 状態コードにより、トランザクション エラーの原因を特定できます。
トランザクション バッチ操作が実行される方法
トランザクション バッチが実行されると、トランザクション バッチ内のすべての操作はグループ化され、1 つのペイロードにシリアル化され、1 つの要求として Azure Cosmos DB サービスに送信されます。
サービスによって、要求が受信され、トランザクション スコープ内のすべての操作が実行されて、同じシリアル化プロトコルを使用して応答が返されます。 この応答は成功または失敗のいずれかで、操作ごとの個々の操作の応答を提供します。
SDK によって、結果を確認するための応答が公開され、必要に応じて、内部操作の各結果が抽出されます。
制限事項
現在、2 つの既知の制限があります。
- Azure Cosmos DB の要求サイズ制限によって、トランザクション バッチ ペイロードのサイズが 2 MB を超えないよう制限されます。また、最大実行時間は 5 秒です。
- パフォーマンスが期待どおりかつ SLA 内であることを保証するために、現在はトランザクション バッチごとに 100 操作に制限されています。
次のステップ