/ /

Driver C#/.NET

Fundamentals

Docs Home

Librerías de clientes

Driver C#/.NET

Fundamentals

Utiliza Transacciones en C#

Overview

En esta guía, puedes aprender a utilizar el controlador MongoDB .NET/C# para ejecutar transacciones. Las transacciones permiten ejecutar una serie de operaciones que no modifican ningún dato hasta que se confirme la transacción. Si alguna operación en la transacción devuelve un error, el controlador cancela la transacción y descarta todos los cambios de datos antes de que lleguen a ser visibles.

En MongoDB, las transacciones se ejecutan dentro de sesiones lógicas. Una sesión es un agrupamiento de operaciones de lectura o escritura relacionadas que usted planea ejecutar secuencialmente. Las sesiones habilitan la coherencia causal para un conjunto de operaciones o te permiten ejecutar operaciones en una ACID transaction. MongoDB garantiza que los datos involucrados en sus operaciones de transacción permanezcan coherentes, incluso si las operaciones encuentran errores inesperados.

Cuando uses el controlador .NET/C#, puedes crear una nueva sesión a partir de una instancia MongoClient como un tipo IClientSession. Recomendamos reutilizar tu cliente para múltiples sesiones y transacciones en lugar de instanciar un nuevo cliente cada vez.

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.

Métodos

Cree un IClientSession usando el método StartSession() síncrono o StartSessionAsync() asíncrono en su instancia de MongoClient. Luego puedes modificar el estado de la sesión utilizando el método set proporcionado por la interfaz IClientSession. Selecciona una de las siguientes opciones en las pestañas Synchronous Methods y Asynchronous Methods para conocer los métodos de gestión de tu transacción:

Método	Descripción
`StartTransaction()`	Inicia una nueva transacción, configurada con las opciones dadas, en esta sesión. Genera una excepción si ya hay una transacción en curso para la sesión. Para aprender más sobre este método, consulte la página startTransaction() en el manual del servidor. Parámetro: `TransactionOptions` (opcional)
`AbortTransaction()`	Finaliza la transacción activa de esta sesión. Genera una excepción si no hay una transacción activa para la sesión o si la transacción se ha confirmado o finalizado. Para obtener más información sobre este método, consulte la página abortTransaction() en el manual del servidor. Parámetro: `CancellationToken`
`CommitTransaction()`	Confirma la transacción activa de esta sesión. Genera una excepción si no hay una transacción activa para la sesión o si la transacción finalizó. Para obtener más información sobre este método, consulte la página commitTransaction() en el manual del servidor. Parámetro: `CancellationToken`
`WithTransaction()`	Inicia una transacción en esta sesión y ejecuta la función de retorno proporcionada. Para obtener más información sobre este método, consulta la página withTransaction() en el manual del Servidor. IMPORTANTE: Al capturar excepciones dentro de la función de retorno utilizada por `WithTransaction()`, debes relanzar la excepción antes de salir del bloque try-catch. No hacerlo puede resultar en un ciclo infinito. Para obtener más detalles sobre cómo gestionar excepciones en este caso, consulta Transacciones en el manual del servidor y selecciona C# en el menú desplegable de lenguaje para ver el ejemplo. Parámetros: `Func <IClientSessionHandle, CancellationToken, Task<TResult>>`, `TransactionOptions`, `CancellationToken` Tipo de devolución: `Task <TResult>`

Método	Descripción
`StartTransaction()`	Inicia una nueva transacción, configurada con las opciones dadas, en esta sesión. Genera una excepción si ya hay una transacción en curso para la sesión. Para aprender más sobre este método, consulte la página startTransaction() en el manual del servidor. Parámetro: `TransactionOptions` (opcional)
`AbortTransactionAsync()`	Finaliza la transacción activa de esta sesión. Genera una excepción si no hay una transacción activa para la sesión o si la transacción se ha confirmado o finalizado. Para obtener más información sobre este método, consulte la página abortTransaction() en el manual del servidor. Parámetro: `CancellationToken` Tipo de devolución: `Task`
`CommitTransactionAsync()`	Confirma la transacción activa de esta sesión. Genera una excepción si no hay una transacción activa para la sesión o si la transacción finalizó. Para obtener más información sobre este método, consulte la página commitTransaction() en el manual del servidor. Parámetro: `CancellationToken` Tipo de devolución: `Task`
`WithTransactionAsync()`	Inicia una transacción en esta sesión y ejecuta la función de retorno proporcionada. Para obtener más información sobre este método, consulta la página withTransaction() en el manual del Servidor. IMPORTANTE: Al capturar excepciones dentro de la función de retorno utilizada por `WithTransactionAsync()`, debes relanzar la excepción antes de salir del bloque try-catch. No hacerlo puede resultar en un ciclo infinito. Para obtener más detalles sobre cómo gestionar excepciones en este caso, consulta Transacciones en el manual del servidor y selecciona C# en el menú desplegable de lenguaje para ver el ejemplo. Parámetros: `Func <IClientSessionHandle, CancellationToken, Task<TResult>>`, `TransactionOptions`, `CancellationToken` Tipo de devolución: `Task <TResult>`

Opciones de transacción

Para configurar una transacción individual, pase una instancia de TransactionOptions al método StartTransaction() o WithTransaction(). El ejemplo de esta sección establece el nivel de consistencia de lectura en ReadConcern.Majority y el nivel de confirmación de escritura (write concern) en WriteConcern.WMajority.

Puede configurar un objeto TransactionOptions con las siguientes propiedades:

Propiedad	Descripción
`MaxCommitTime`	Cantidad máxima de tiempo que se puede ejecutar un solo comando `commitTransaction`. Si la confirmación supera este límite, MongoDB Server devuelve un error `MaxTimeMSExpired` y no confirma la transacción. Si omite esta propiedad, MongoDB Server aplica el límite de tiempo de ejecución de transacciones por defecto. Tipo de dato: `TimeSpan?`
`ReadConcern`	Nivel de consistencia de lectura para la transacción. Para aprender más, consulte Nivel de consistencia de lectura en el manual del MongoDB Server. Tipo de dato: ReadConcern
`ReadPreference`	Preferencia de lectura para la transacción. Para obtener más información, consulte Preferencia de lectura en el manual de MongoDB Server. Tipo de dato: ReadPreference
`WriteConcern`	Nivel de confirmación de escritura (write concern) para la transacción. Para obtener más información, consulte nivel de confirmación de escritura (write concern) en el manual de MongoDB Server. Tipo de dato: WriteConcern

Ejemplo

Este ejemplo muestra cómo puede crear una sesión, configurar opciones de transacción, crear una transacción e insertar documentos en varias colecciones dentro de la transacción mediante los siguientes pasos:

Cree una sesión desde el cliente usando el método StartSession().
Cree un objeto TransactionOptions para configurar la transacción.
Utiliza el método StartTransaction() para iniciar una transacción.
Inserte documentos en las colecciones books y films.
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.

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:

Volver

GUIDs

Indexes