Overview
En esta guía, puedes aprender cómo usar el controlador MongoDB .NET/C# para realizar transacciones. Transacciones le permiten ejecutar una serie de operaciones que no cambian ningún dato hasta que la transacción es confirmada. Si alguna operación en la transacción devuelve un error, el driver cancela la transacción y descarta todos los cambios de datos antes de que sean visibles.
MongoDB garantiza que los datos involucrados en sus operaciones de transacción se mantendrán coherentes, incluso si las operaciones encuentran errores inesperados.
Sesiones
En MongoDB, las transacciones se ejecutan dentro de sesiones lógicas. Una sesión es un agrupamiento de operaciones relacionadas de lectura o escritura que se pretende ejecutar en secuencia. Las sesiones permiten la coherencia causal para un grupo de operaciones o te permiten ejecutar operaciones en una transacción ACID.
Al usar el Driver .NET/C#, puedes crear una nueva sesión a partir de un
MongoClient instancia como un tipo IClientSession. Recomendamos reutilizar su cliente para múltiples sesiones y transacciones en lugar de crear una nueva instancia de cliente cada vez.
El siguiente ejemplo muestra cómo crear una sesión llamando al método StartSession():
var client = new MongoClient("mongodb://localhost:27017"); var session = client.StartSession();
Advertencia
Utiliza un IClientSession únicamente con el MongoClient (o el MongoDatabase o MongoCollection asociado) que lo haya creado. El uso de un IClientSession con un MongoClient diferente provoca errores de operación.
Opciones de sesión de cliente
Puedes personalizar el comportamiento de tu sesión pasando una instancia de la clase ClientSessionOptions al método StartSession(). La siguiente tabla describe las propiedades que puede definir en un objeto ClientSessionOptions:
Propiedad | Descripción |
|---|---|
| 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 |
La propiedad DefaultTransactionOptions acepta una instancia de la clase TransactionOptions. La siguiente tabla describe las propiedades que se pueden establecer en un objeto TransactionOptions:
Propiedad | Descripción |
|---|---|
| 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 |
El siguiente ejemplo de código muestra cómo crear una sesión con opciones 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);
Coherencia causal
MongoDB habilita la coherencia causal en ciertas sesiones de clientes. El modelo de coherencia causal garantiza que en un sistema distribuido, las operaciones dentro de una sesión se ejecuten en un orden causal. Los clientes observan resultados que son coherentes con las relaciones causales, o las dependencias entre las operaciones. Por ejemplo, si realizas una serie de operaciones donde una depende lógicamente del resultado de otra, las lecturas subsecuentes reflejarán esa relación de dependencia.
Para garantizar la coherencia causal, las sesiones de los clientes deben cumplir los siguientes requisitos:
Al iniciar una sesión, el driver debe habilitar la opción de coherencia causal. Esta opción está habilitada por defecto.
Las operaciones deben ejecutarse en una sola sesión en un solo hilo. De lo contrario, las sesiones o hilos deben comunicarse entre sí los valores de operation time y tiempo de clúster. Para ver un ejemplo de dos sesiones que comunican estos valores, consulte los Ejemplos de coherencia causal en el manual del servidor de MongoDB.
Debes usar un
ReadConcern.Majoritynivel de consistencia de lectura.Debe usar un
WriteConcern.WMajoritynivel de confirmación de escritura (write concern). Este es el valor predeterminado de nivel de confirmación de escritura (write concern).
La siguiente tabla describe las garantías que ofrecen las sesiones coherentes causales:
garantías | Descripción |
|---|---|
Leer las escrituras | Las operaciones de lectura reflejan los resultados de las operaciones de escritura anteriores. |
Lecturas monotónicas | Las operaciones de lectura no devuelven resultados que reflejen un estado de datos anterior al de una operación de lectura previa. |
Escrituras monotónicas | Si una operación de escritura debe preceder a otras operaciones de escritura, el servidor ejecutará primero esta operación de escritura. Por ejemplo, si llamas a |
Las escrituras siguen a las lecturas | Si una operación de escritura debe seguir a otras operaciones de lectura, el servidor primero ejecuta las operaciones de lectura. Por ejemplo, si llamas a |
Tip
Para aprender más sobre los conceptos mencionados en esta sección, consulta las siguientes entradas del manual del servidor MongoDB:
Métodos
Cree un IClientSession utilizando el método síncrono StartSession() o el método asíncrono StartSessionAsync() en su instancia MongoClient. A continuación, puedes modificar el estado de la sesión utilizando el método set proporcionado por la interfaz IClientSession. Seleccione entre lo siguiente
Synchronous Methods y Asynchronous Methods pestañas para aprender sobre los métodos para gestionar tu transacción:
Método | Descripción |
|---|---|
| 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: Al capturar excepciones dentro de la función de retorno utilizada por Parameters: Func <IClientSessionHandle, CancellationToken, Task<TResult>>, TransactionOptions, CancellationTokenReturn Type: Task <TResult> |
Método | Descripción |
|---|---|
| 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: Al capturar excepciones dentro de la función de retorno utilizada por Parameters: Func <IClientSessionHandle, CancellationToken, Task<TResult>>, TransactionOptions, CancellationTokenReturn Type: Task <TResult> |
Tip
Configurar Transacciones
Puedes personalizar el comportamiento de transacciones individuales pasando una instancia de la clase TransactionOptions al método StartTransaction() o WithTransaction(). Las opciones establecidas aquí sustituyen las opciones de transacción predeterminadas que estableces en el objeto ClientSessionOptions.
Ejemplo
Este ejemplo muestra cómo puedes crear una sesión, crear una transacción e insertar documentos en varias colecciones dentro de la transacción a través de los siguientes pasos:
Cree una sesión desde el cliente usando el método
StartSession().Cree un objeto
TransactionOptionspara configurar la transacción.Utiliza el método
StartTransaction()para iniciar una transacción.Inserte documentos en las colecciones
booksyfilms.Confirme la transacción usando el 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!
Nota
Operaciones paralelas no admitidas
El driver .NET/C# no admite la ejecución de operaciones paralelas dentro de una sola transacción.
Si utiliza MongoDB Server v8.0 o posterior, puede realizar operaciones de escritura en varios espacios de nombres dentro de una sola transacción utilizando el método BulkWrite() o BulkWriteAsync(). Para más información, consulta Operaciones de guardado masivo.
Información Adicional
Para **aprender** más sobre los conceptos mencionados en esta **guía**, consulta las siguientes páginas en el manual del **servidor**:
Documentación de la API
Para aprender más sobre cualquiera de los tipos o métodos discutidos en esta guía, consulta la siguiente documentación de la API: