Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Menu Docs
Página inicial do Docs
/ /

Usar transações em C#

Neste guia, você pode aprender como usar o Driver MongoDB .NET/C# para executar transações. Astransações permitem que você execute uma série de operações que não alteram nenhum dado até que a transação seja confirmada. Se qualquer 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: ao capturar exceções dentro da função de chamada de resposta WithTransaction() usada por, você deve lançar novamente 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 servidor 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: ao capturar exceções dentro da função de chamada de resposta WithTransactionAsync() usada por, você deve lançar novamente 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 servidor e selecione C# no menu suspenso de idioma para ver o exemplo.


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

Para configurar uma transação individual, passe uma instância TransactionOptions para o método StartTransaction() ou WithTransaction(). O exemplo nesta seção define a preocupação de leitura como ReadConcern.Majority e a preocupação de gravação como WriteConcern.WMajority.

Você pode configurar um objeto TransactionOptions com as seguintes propriedades:

Propriedade
Descrição

MaxCommitTime

Maximum amount of time that a single commitTransaction command can run. If the commit exceeds this limit, MongoDB Server returns a MaxTimeMSExpired error and does not commit the transaction.

If you omit this property, MongoDB Server applies the default transaction runtime limit.

Data Type: TimeSpan?

ReadConcern

Read concern for the transaction. To learn more, see Read Concern in the MongoDB Server manual.

Data Type: ReadConcern

ReadPreference

Read preference for the transaction. To learn more, see Read Preference in the MongoDB Server manual.

Data Type: ReadPreference

WriteConcern

Write concern for the transaction. To learn more, see Write Concern in the MongoDB Server manual.

Data Type: WriteConcern

Este exemplo mostra como criar uma sessão, configurar as opções de transaçã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. Crie um objeto TransactionOptions para configurar a transação.

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

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

  5. 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())
{
// Configures transaction options
var transactionOptions = new TransactionOptions(
readConcern: ReadConcern.Majority,
writeConcern: WriteConcern.WMajority
);
session.StartTransaction(transactionOptions);
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!");
}
Successfully committed transaction!

Observação

Operações paralelas não suportadas

O driver .NET/C# não suporta a execução de operações paralelas em uma única transação.

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:

Voltar

GUIDs

Nesta página