Menu Docs
Página inicial do Docs
/ / /
C#/.NET
/

Transações

Nesta página

  • Visão geral
  • Métodos
  • Exemplo
  • Informações adicionais
  • Documentação da API

Neste guia, você aprenderá a usar o driver .NET/C# do MongoDB para realizar transações. As transações permitem executar uma série de operações que não alteram nenhum dado até que a transação seja confirmada. Se alguma operação na transação retornar um erro, o driver cancelará a transação e descartará todas as alterações de dados antes que elas se tornem visíveis.

No MongoDB, as transações são executadas dentro de sessões lógicas. Uma sessão é um agrupamento de operações de leitura ou gravação relacionadas que você pretende executar sequencialmente. As sessões permitem consistência causal para um grupo de operações ou permitem que você execute operações em uma transação ACID. O MongoDB garante que os dados envolvidos em suas operações de transação permaneçam consistentes, mesmo que as operações encontrem erros inesperados.

Ao usar o driver .NET/C#, você pode criar uma nova sessão a partir de uma instância MongoClient como tipo IClientSession . Recomendamos que você reutilize seu cliente para várias sessões e transações, em vez de fazer a instância de um novo cliente a cada vez.

Aviso

Utilize um IClientSession apenas com o MongoClient (ou MongoDatabase ou MongoCollection associada) que o criou. Utilizar uma IClientSession com um MongoClient diferente resulta em erros de operação.

Crie um IClientSession utilizando o método StartSession() síncrono ou o método assíncrono StartSessionAsync() em sua instância do MongoClient . Você pode então modificar o estado da sessão usando o conjunto de métodos fornecido pela interface IClientSession . Selecione a partir dos seguintes separadores Synchronous Methods e Asynchronous Methods para saber mais sobre os métodos para gerir a sua transação:

Método
Descrição
StartTransaction()
Starts a new transaction, configured with the given options, on this session. Throws an exception if there is already a transaction in progress for the session. To learn more about this method, see the startTransaction() page in the Server manual.

Parameter: TransactionOptions (optional)
AbortTransaction()
Ends the active transaction for this session. Throws an exception if there is no active transaction for the session or the transaction has been committed or ended. To learn more about this method, see the abortTransaction() page in the Server manual.

Parameter: CancellationToken
CommitTransaction()
Commits the active transaction for this session. Throws an exception if there is no active transaction for the session or if the transaction was ended. To learn more about this method, see the commitTransaction() page in the Server manual.

Parameter: CancellationToken
WithTransaction()
Starts a transaction on this session and runs the given callback. To learn more about this method, see the withTransaction() page in the Server manual.

Importante

Tratamento de exceções

Ao capturar exceções na função de chamada de resposta usada por WithTransaction(), você deve relançar a exceção antes de sair do bloco try-catch. Não fazer isso pode resultar em um loop infinito. Para obter mais detalhes sobre como lidar com exceções nesse caso, consulte Transações no manual do MongoDB Server e selecione C# no menu suspenso de idioma para ver o exemplo.


Parameters: Func <IClientSessionHandle, CancellationToken, Task<TResult>>, TransactionOptions, CancellationToken
Return Type: Task <TResult>
Método
Descrição
StartTransaction()
Starts a new transaction, configured with the given options, on this session. Throws an exception if there is already a transaction in progress for the session. To learn more about this method, see the startTransaction() page in the Server manual.

Parameter: TransactionOptions (optional)
AbortTransactionAsync()
Ends the active transaction for this session. Throws an exception if there is no active transaction for the session or the transaction has been committed or ended. To learn more about this method, see the abortTransaction() page in the Server manual.

Parameter: CancellationToken
Return Type: Task
CommitTransactionAsync()
Commits the active transaction for this session. Throws an exception if there is no active transaction for the session or if the transaction was ended. To learn more about this method, see the commitTransaction() page in the Server manual.

Parameter: CancellationToken
Return Type: Task
WithTransactionAsync()
Starts a transaction on this session and runs the given callback. To learn more about this method, see the withTransaction() page in the Server manual.

Importante

Tratamento de exceções

Ao capturar exceções na função de chamada de resposta usada por WithTransactionAsync(), você deve relançar a exceção antes de sair do bloco try-catch. Não fazer isso pode resultar em um loop infinito. Para obter mais detalhes sobre como lidar com exceções nesse caso, consulte Transações no manual do MongoDB Server e selecione C# no menu suspenso de idioma para ver o exemplo.


Parameters: Func <IClientSessionHandle, CancellationToken, Task<TResult>>, TransactionOptions, CancellationToken
Return Type: Task <TResult>

Este exemplo mostra como criar uma sessão, criar uma transação e inserir documentos em várias coleções dentro da transação por meio das seguintes etapas:

  1. Crie uma sessão a partir do cliente usando o método StartSession().

  2. Use o método StartTransaction() para iniciar uma transação.

  3. Insira documentos nas coleções books e films .

  4. Confirme a transação usando o método CommitTransaction() .

var books = database.GetCollection<Book>("books");
var films = database.GetCollection<Film>("films");
// Begins transaction
using (var session = mongoClient.StartSession())
{
session.StartTransaction();
try
{
// Creates sample data
var book = new Book
{
Title = "Beloved",
Author = "Toni Morrison",
InStock = true
};
var film = new Film
{
Title = "Star Wars",
Director = "George Lucas",
InStock = true
};
// Inserts sample data
books.InsertOne(session, book);
films.InsertOne(session, film);
// Commits our transaction
session.CommitTransaction();
}
catch (Exception e)
{
Console.WriteLine("Error writing to MongoDB: " + e.Message);
return;
}
// Prints a success message if no error thrown
Console.WriteLine("Successfully committed transaction!");
}

Para saber mais sobre os conceitos mencionados neste guia, consulte as seguintes páginas no manual do servidor:

Para saber mais sobre qualquer um dos tipos ou métodos discutidos neste guia, consulte a seguinte documentação da API:

  • IClientSession

  • Cliente Mongo

  • startTransaction()

  • AbortTransaction() / AbortTransactionAsync()

  • CommitTransaction() / CommitTransactionAsync()

  • WithTransaction() / WithTransactionAsync()

  • opções de transação

Voltar

GUIDs