TransactionalBatch Classe

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.39.0

Source:

TransactionalBatch.cs

Représente un lot d’opérations sur des éléments avec les mêmes PartitionKey dans un conteneur qui seront effectuées de manière transactionnelle sur le service Azure Cosmos DB. Utilisez CreateTransactionalBatch(PartitionKey) pour créer un instance de TransactionalBatch.

public abstract class TransactionalBatch

type TransactionalBatch = class

Public MustInherit Class TransactionalBatch

Héritage

Object

TransactionalBatch

Exemples

Cet exemple modifie de manière atomique un ensemble de documents sous forme de lot.

public class ToDoActivity
{
    public string type { get; set; }
    public string id { get; set; }
    public string status { get; set; }
}

string activityType = "personal";
ToDoActivity test1 = new ToDoActivity()
{
    type = activityType,
    id = "learning",
    status = "ToBeDone"
};

ToDoActivity test2 = new ToDoActivity()
{
    type = activityType,
    id = "shopping",
    status = "Done"
};

ToDoActivity test3 = new ToDoActivity()
{
    type = activityType,
    id = "swimming",
    status = "ToBeDone"
};

ToDoActivity test4 = new ToDoActivity()
{
    type = activityType,
    id = "running",
    status = "ToBeDone"
};

List<PatchOperation> patchOperations = new List<PatchOperation>();
patchOperations.Add(PatchOperation.Replace("/status", "InProgress");
patchOperations.Add(PatchOperation.Add("/progress", 50);

using (TransactionalBatchResponse batchResponse = await container.CreateTransactionalBatch(new Cosmos.PartitionKey(activityType))
    .CreateItem<ToDoActivity>(test1)
    .ReplaceItem<ToDoActivity>(test2.id, test2)
    .UpsertItem<ToDoActivity>(test3)
    .PatchItem(test4.id, patchOperations)
    .DeleteItem("reading")
    .CreateItemStream(streamPayload1)
    .ReplaceItemStream("eating", streamPayload2)
    .UpsertItemStream(streamPayload3)
    .ExecuteAsync())
{
   if (!batchResponse.IsSuccessStatusCode)
   {
       // Handle and log exception
       return;
   }

   // Look up interested results - eg. via typed access on operation results
   TransactionalBatchOperationResult<ToDoActivity> replaceResult = batchResponse.GetOperationResultAtIndex<ToDoActivity>(0);
   ToDoActivity readActivity = replaceResult.Resource;
}

Cet exemple lit de manière atomique un ensemble de documents sous forme de lot.

string activityType = "personal";
using (TransactionalBatchResponse batchResponse = await container.CreateTransactionalBatch(new Cosmos.PartitionKey(activityType))
   .ReadItem("playing")
   .ReadItem("walking")
   .ReadItem("jogging")
   .ReadItem("running")
   .ExecuteAsync())
{
    // Look up interested results - eg. via direct access to operation result stream
    List<string> resultItems = new List<string>();
    foreach (TransactionalBatchOperationResult operationResult in batchResponse)
    {
        using (StreamReader streamReader = new StreamReader(operationResult.ResourceStream))
        {
            resultItems.Add(await streamReader.ReadToEndAsync());
        }
    }
}

Remarques

Limites des requêtes TransactionalBatch

Constructeurs

TransactionalBatch()

Représente un lot d’opérations sur des éléments avec les mêmes PartitionKey dans un conteneur qui seront effectuées de manière transactionnelle sur le service Azure Cosmos DB. Utilisez CreateTransactionalBatch(PartitionKey) pour créer un instance de TransactionalBatch.

Méthodes

CreateItem<T>(T, TransactionalBatchItemRequestOptions)	Ajoute une opération pour créer un élément dans le lot.
CreateItemStream(Stream, TransactionalBatchItemRequestOptions)	Ajoute une opération pour créer un élément dans le lot.
DeleteItem(String, TransactionalBatchItemRequestOptions)	Ajoute une opération pour supprimer un élément dans le lot.
ExecuteAsync(CancellationToken)	Exécute le lot transactionnel sur le service Azure Cosmos en tant qu’opération asynchrone.
ExecuteAsync(TransactionalBatchRequestOptions, CancellationToken)	Exécute le lot transactionnel sur le service Azure Cosmos en tant qu’opération asynchrone.
PatchItem(String, IReadOnlyList<PatchOperation>, TransactionalBatchPatchItemRequestOptions)	Ajoute une opération pour corriger un élément dans le lot.
ReadItem(String, TransactionalBatchItemRequestOptions)	Ajoute une opération pour lire un élément dans le lot.
ReplaceItem<T>(String, T, TransactionalBatchItemRequestOptions)	Ajoute une opération pour remplacer un élément dans le lot.
ReplaceItemStream(String, Stream, TransactionalBatchItemRequestOptions)	Ajoute une opération pour remplacer un élément dans le lot.
UpsertItem<T>(T, TransactionalBatchItemRequestOptions)	Ajoute une opération pour upserter un élément dans le lot.
UpsertItemStream(Stream, TransactionalBatchItemRequestOptions)	Ajoute une opération pour upserter un élément dans le lot.