Transações
Visão geral
Neste guia, você pode aprender como usar o Driver Java para executar transações. As transaçõ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 Java , você pode criar uma nova sessão a partir de uma instância MongoClient
como tipo ClientSession
. 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 uma ClientSession
apenas com o MongoClient
(ou MongoDatabase
ou MongoCollection
associada) que a criou. Utilizar uma ClientSession
com um MongoClient
diferente resulta em erros de operação.
Importante
Você deve incluir session
como parâmetro para quaisquer operações que queira incluir em uma transação.
Métodos
Crie um ClientSession
utilizando o método startSession()
na sua instância do MongoClient
. Você pode então modificar o estado da sessão usando os métodos fornecidos por ClientSession
. A tabela a seguir descreve os métodos que você pode usar para gerenciar sua transação:
Método | Descrição |
---|---|
startTransaction() | Starts a new transaction for this session with the
default transaction options. Pass an instance of TransactionOptions
as a parameter to start a transaction with given options. You
cannot start a transaction if there's already an active transaction
running in the session.Parameter: TransactionOptions transactionOptions |
abortTransaction() | Ends the active transaction for this session. Returns an error
if there is no active transaction for the
session or the transaction was previously ended. |
commitTransaction() | Commits the active transaction for this session. Returns an
error if there is no active transaction for the session or if the
transaction was ended. |
withTransaction() | Starts a new transaction for this session and runs the given function. This
method handles retries, committing, and aborting transactions. Pass an
instance of TransactionBody as a parameter that defines the
operations you want to execute within the transaction.Parameter: TransactionBody<T> transactionBody |
Um ClientSession
também tem métodos para recuperar propriedades da sessão e modificar propriedades da sessão mutáveis. Consulte a documentação da API para saber mais sobre esses métodos.
Exemplo
O exemplo a seguir demonstra como você pode criar uma sessão, criar uma transação e confirmar uma operação de inserção de vários documentos por meio das seguintes etapas:
Crie uma sessão a partir do cliente usando o método
startSession()
.Defina as opções de transação para configurar o comportamento da transação.
Use o método
withTransaction()
para iniciar uma transação.Insere vários documentos. O método
withTransaction()
executa, confirma e aborta a transação. Se qualquer operação resultar em erros, owithTransaction()
lida com o cancelamento da transação.
String connectionString = "<connection string>"; // Replace with your connection string try (MongoClient mongoClient = MongoClients.create(connectionString)) { MongoDatabase database = mongoClient.getDatabase("transaction_db"); MongoCollection<Document> collection = database.getCollection("books"); // Sets transaction options TransactionOptions txnOptions = TransactionOptions.builder() .writeConcern(WriteConcern.MAJORITY) .build(); try (ClientSession session = mongoClient.startSession()) { // Uses withTransaction and lambda for transaction operations session.withTransaction(() -> { collection.insertMany(session, Arrays.asList( new Document("title", "The Bluest Eye").append("author", "Toni Morrison"), new Document("title", "Sula").append("author", "Toni Morrison"), new Document("title", "Song of Solomon").append("author", "Toni Morrison") )); return null; // Return value as expected by the lambda }, txnOptions); } } catch (Exception e) { e.printStackTrace(); }
Se você precisar de mais controle sobre suas transações, poderá usar o método startTransaction()
. Você pode usar esse método com os métodos commitTransaction()
e abortTransaction()
descritos na seção anterior para gerenciar manualmente o ciclo de vida da transação.
Informações adicionais
Para saber mais sobre os conceitos mencionados neste guia, consulte as seguintes páginas no manual do servidor:
Para saber mais sobre a ACID compliance, consulte Quais são as propriedades ACID nos sistemas de gerenciamento de banco de dados? artigo no site do MongoDB .
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: