Visão geral
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.
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.
Sessões
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 escrita 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.
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.
O exemplo seguinte mostra como criar uma sessão chamando o método StartSession():
var client = new MongoClient("mongodb://localhost:27017"); var session = client.StartSession();
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.
ClientSessionOptions
Você pode personalizar o comportamento da sua sessão passando uma instância da classe ClientSessionOptions para o método StartSession(). A tabela a seguir descreve as propriedades que você pode definir em um objeto ClientSessionOptions :
Propriedade | Descrição |
|---|---|
| Specifies whether the session is causally consistent. In a causally consistent session,
the driver executes operations in the order they were issued. To learn more, see
Causal Consistency. Data Type: booleanDefault: true |
| Specifies the default transaction options for the session. This includes the maximum commit
time, read concern, read preference, and write concern. Data Type: TransactionOptions Default: null |
| Specifies whether the driver performs snapshot reads. To learn more about snapshot
reads, see Read Concern "snapshot"
in the MongoDB Server manual. Data Type: booleanDefault: false |
| Specifies the cluster time at which the driver reads
all data in the session. You must set Snapshot to
true when setting this property. To learn more, see
Read Concern "snapshot" in the MongoDB Server manual.Data Type: BsonTimestamp Default: null |
A propriedade DefaultTransactionOptions aceita uma instância da classe TransactionOptions. A tabela a seguir descreve as propriedades que você pode definir em um objeto TransactionOptions :
Propriedade | Descrição |
|---|---|
| Maximum amount of time that a single commitTransaction command
can run. If the commit exceeds this limit, MongoDB Server returns a
MaxTimeMSExpired error and doesn't commit the changes in the transaction.
The driver doesn't retry the commit after this error.If you omit this property, MongoDB Server applies the
default transaction runtime limit. Data Type: TimeSpan?Default: null |
| Read concern for each transaction in the session. To learn
more, see Read Concern
in the MongoDB Server manual. If you omit this property, the transactions use the session-level
read concern, if you set one. If you also omit the session-level read concern,
the transactions use the client-level read concern. Data Type: ReadConcern Default: null |
| Read preference for each transaction in the session. To learn
more, see
Read Preference in
the MongoDB Server manual. If you omit this property, the transactions use the session-level
read preference, if you set one. If you also omit the session-level read preference,
the transactions use the client-level read preference. Data Type: ReadPreference Default: null |
| Write concern for each transaction in the session. To learn
more, see
Write Concern in
the MongoDB Server manual. If you omit this property, the transactions use the session-level
write concern, if you set one. If you also omit the session-level write concern,
the transactions use the client-level write concern. Data Type: WriteConcern Default: null |
O seguinte exemplo de código mostra como criar uma sessão com opções personalizadas:
var client = new MongoClient("mongodb://localhost:27017"); var sessionOptions = new ClientSessionOptions { CausalConsistency = true, DefaultTransactionOptions = new TransactionOptions( readConcern: ReadConcern.Available, writeConcern: WriteConcern.Acknowledged) }; var session = client.StartSession(sessionOptions);
Consistência causal
O MongoDB permite consistência causal em determinadas sessões de cliente. O modelo de consistência causal garante que, em um sistema distribuído, as operações dentro de uma sessão sejam executadas em uma ordem causal. Os clientes observam resultados consistentes com as relações causais ou as dependências entre as operações. Por exemplo, se você executar uma série de operações em que uma operação depende logicamente do resultado de outra, todas as leituras subsequentes refletirão o relacionamento de dependência .
Para garantir a consistência causal, as sessões de cliente devem atender aos seguintes requisitos:
Ao iniciar uma sessão, o driver deve habilitar a opção de consistência causal. Esta opção está habilitada por padrão.
As operações devem ser executadas em uma única sessão em um único thread. Caso contrário, as sessões ou threads devem comunicar os valores de optime e tempo de cluster uns aos outros. Para exibir um exemplo de duas sessões que comunicam esses valores, consulte os exemplos de Consistência causal no manual do MongoDB Server.
Você deve usar uma preocupação de leitura
ReadConcern.Majority.Você deve usar uma preocupação de gravação
WriteConcern.WMajority. Este é o valor padrão de preocupação de gravação .
A tabela a seguir descreve as garantias que as sessões causalmente consistentes oferecem:
Garantia | Descrição |
|---|---|
Ler suas gravações | As operações de leitura refletem os resultados das operações de gravação anteriores. |
Leituras monotônicas | As operações de leitura não retornam resultados que reflitam um estado de dados anterior a uma operação de leitura anterior. |
Escritas monotônicas | Se uma operação de gravação precisar preceder outras operações de gravação, o servidor executará essa operação de gravação primeiro. Por exemplo, se você chamar |
Escritas que seguem as leituras | Se uma operação de gravação precisar seguir outras operações de leitura, o servidor executará primeiro as operações de leitura. Por exemplo, se você chamar |
Dica
Para saber mais sobre os conceitos mencionados nesta seção, consulte as seguintes entradas de manual do MongoDB Server :
Métodos
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 |
|---|---|
| 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) |
| 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 |
| 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 |
| 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 Parameters: Func <IClientSessionHandle, CancellationToken, Task<TResult>>, TransactionOptions, CancellationTokenReturn Type: Task <TResult> |
Método | Descrição |
|---|---|
| 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) |
| 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: CancellationTokenReturn Type: Task |
| 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: CancellationTokenReturn Type: Task |
| 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 Parameters: Func <IClientSessionHandle, CancellationToken, Task<TResult>>, TransactionOptions, CancellationTokenReturn Type: Task <TResult> |
Dica
Configurar transações
Você pode personalizar o comportamento de transações individuais passando uma instância da classe TransactionOptions para o método StartTransaction() ou WithTransaction(). As opções definidas aqui substituem as opções de transação padrão definidas no objeto ClientSessionOptions.
Exemplo
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:
Crie uma sessão a partir do cliente usando o método
StartSession().Crie um objeto
TransactionOptionspara configurar a transação.Use o método
StartTransaction()para iniciar uma transação.Insira documentos nas coleções
booksefilms.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.
Se você estiver usando o MongoDB Server v8.0 ou posterior, poderá executar operações de gravação em vários namespaces em uma única transação usando o método BulkWrite() ou BulkWriteAsync(). Para mais informações, consulte Operações de Gravação em Massa.
Informações adicionais
Para saber mais sobre os conceitos mencionados neste guia, consulte as seguintes páginas no manual do servidor:
Documentação da API
Para saber mais sobre qualquer um dos tipos ou métodos discutidos neste guia, consulte a seguinte documentação da API: