Operaciones de escritura masiva

Datos de muestra

Los ejemplos de esta guía utilizan las colecciones sample_restaurants.restaurants y sample_mflix.movies del Atlas datasets de muestra. Para aprender a crear un clúster gratuito de MongoDB Atlas y cargar los conjuntos de datos de muestra, consulta la Guía de inicio rápido de MongoDB.

Operaciones de inserción

Para realizar una operación de inserción, cree una instancia de InsertOneModel<TDocument> y especifique el documento que desea insertar.

El siguiente ejemplo crea una instancia de la clase InsertOneModel<BsonDocument>. Esta instancia orienta al driver a insertar un documento en el que el campo "name" es "Mongo's Deli" en la colección restaurants.

var insertOneModel = new InsertOneModel<BsonDocument>(
    new BsonDocument{
        { "name", "Mongo's Deli" },
        { "cuisine", "Sandwiches" },
        { "borough", "Manhattan" },
        { "restaurant_id", "1234" }
    }
);

Para insertar varios documentos, cree una instancia de InsertOneModel<TDocument> para cada documento.

Operaciones de actualizar

Para actualizar un solo documento, cree un instancia de UpdateOneModel<TDocument> y pase los siguientes argumentos:

• Filtro de query que especifica los criterios utilizados para seleccionar documentos en tu colección. Para obtener más información sobre cómo especificar una query, consulta Operadores de query y proyección en el manual del MongoDB Server.

• Actualizar el documento que describe la actualización que se debe realizar. Para obtener más información sobre cómo especificar una actualización, consulta Operadores de actualización en el manual del MongoDB Server.

Una instancia de UpdateOneModel<TDocument> especifica una actualización para el primer documento que coincida con el filtro de query.

En el siguiente ejemplo de código, el objeto UpdateOneModel<BsonDocument> representa una operación de actualización en la colección restaurants. La operación coincide con el primer documento en la colección donde el valor del campo name es "Mongo's Deli". Luego actualiza el valor del campo cuisine en el documento coincidente a "Sandwiches and Salads".

var updateOneModel = new UpdateOneModel<BsonDocument>(
    Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli"),
    Builders<BsonDocument>.Update.Set("cuisine", "Sandwiches and Salads")
);

Para actualizar varios documentos, cree una instancia de UpdateManyModel<TDocument> y pase los mismos argumentos que para UpdateOneModel<TDocument>. La clase UpdateManyModel<TDocument> especifica actualizaciones para todos los documentos que coincidan con su filtro de query.

En el siguiente ejemplo de código, el objeto UpdateManyModel<BsonDocument> representa una operación de actualización en la colección restaurants. La operación coincide con todos los documentos de la colección donde el valor del campo name es "Mongo's Deli". Luego actualiza el valor del campo cuisine a "Sandwiches and Salads".

var updateManyModel = new UpdateManyModel<BsonDocument>(
    Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli"),
    Builders<BsonDocument>.Update.Set("cuisine", "Sandwiches and Salads")
);

Reemplazar operaciones

Una operación de reemplazo remueve todos los campos y valores de un documento especificado y los reemplaza por nuevos campos y valores que usted especifica. Para realizar una operación de reemplazo, crea una instancia de ReplaceOneModel<TDocument> y pasa un filtro de query junto con los campos y valores con los que deseas reemplazar el documento coincidente.

En el siguiente ejemplo, el objeto ReplaceOneModel<BsonDocument> representa una operación de reemplazo en la colección restaurants. La operación coincide con el documento en la colección donde el valor del campo restaurant_id es "1234". Luego remueve todos los campos, excepto _id, de este documento y establece nuevos valores en los campos name, cuisine, borough y restaurant_id.

var replaceOneModel = new ReplaceOneModel<BsonDocument>(
    Builders<BsonDocument>.Filter.Eq("restaurant_id", "1234"),
    new BsonDocument{
        { "name", "Mongo's Pizza" },
        { "cuisine", "Pizza" },
        { "borough", "Brooklyn" },
        { "restaurant_id", "5678" }
    }
);

Para reemplazar varios documentos, debe crear una instancia de ReplaceOneModel<TDocument> para cada documento.

Operaciones de borrar

Para borrar un documento, crea una instancia de DeleteOneModel<TDocument> y pasa un filtro de query que especifique el documento que deseas borrar. Una instancia DeleteOneModel<TDocument> proporciona instrucciones para eliminar solo el primer documento que coincida con tu filtro de query.

En el siguiente ejemplo de código, el objeto DeleteOneModel<BsonDocument> representa una operación de eliminación en la colección restaurants. La operación busca y elimina el primer documento donde el valor del campo restaurant_id es "5678".

var deleteOneModel = new DeleteOneModel<BsonDocument>(
    Builders<BsonDocument>.Filter.Eq("restaurant_id", "5678")
);

Para borrar varios documentos, crea una instancia de DeleteManyModel<TDocument> y pasa un filtro de query que especifique los documentos que deseas borrar. Una instancia de DeleteManyModel<TDocument> proporciona instrucciones para remover todos los documentos que coincidan con el filtro de query.

En el siguiente ejemplo de código, el objeto DeleteManyModel<BsonDocument> representa una operación de eliminación en la colección restaurants. La operación coincide y elimina todos los documentos donde el valor del campo name es "Mongo's Deli".

var deleteManyModel = new DeleteManyModel<BsonDocument>(
    Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli")
);

Realizar la Operación Masiva

Después de definir una instancia WriteModel para cada operación que desee realizar, cree una instancia de una clase que implemente la interfaz IEnumerable. Agrega tus objetos de WriteModel a este IEnumerable, luego pasa el IEnumerable al método BulkWrite() o BulkWriteAsync(). Por defecto, estos métodos ejecutan las operaciones en el orden en que están definidos en la lista.

Selecciona de las siguientes pestañas para ver cómo usar el método sincrónico BulkWrite() y el método asincrónico BulkWriteAsync() para realizar una operación de escritura masiva en la colección restaurants:

var models = new List<WriteModel<BsonDocument>>
{
    new InsertOneModel<BsonDocument>(
        new BsonDocument{
            { "name", "Mongo's Deli" },
            { "cuisine", "Sandwiches" },
            { "borough", "Manhattan" },
            { "restaurant_id", "1234" }
        }
    ),
    new InsertOneModel<BsonDocument>(
        new BsonDocument{
            { "name", "Mongo's Deli" },
            { "cuisine", "Sandwiches" },
            { "borough", "Brooklyn" },
            { "restaurant_id", "5678" }
        }
    ),
    new UpdateManyModel<BsonDocument>(
        Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli"),
        Builders<BsonDocument>.Update.Set("cuisine", "Sandwiches and Salads")
    ),
    new DeleteOneModel<BsonDocument>(
        Builders<BsonDocument>.Filter.Eq("restaurant_id", "1234")
    )
};
var results = collection.BulkWrite(models);
Console.WriteLine(results);

var models = new List<WriteModel<BsonDocument>>
{
    new InsertOneModel<BsonDocument>(
        new BsonDocument{
            { "name", "Mongo's Deli" },
            { "cuisine", "Sandwiches" },
            { "borough", "Manhattan" },
            { "restaurant_id", "1234" }
        }
    ),
    new InsertOneModel<BsonDocument>(
        new BsonDocument{
            { "name", "Mongo's Deli" },
            { "cuisine", "Sandwiches" },
            { "borough", "Brooklyn" },
            { "restaurant_id", "5678" }
        }
    ),
    new UpdateManyModel<BsonDocument>(
        Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli"),
        Builders<BsonDocument>.Update.Set("cuisine", "Sandwiches and Salads")
    ),
    new DeleteOneModel<BsonDocument>(
        Builders<BsonDocument>.Filter.Eq("restaurant_id", "1234")
    )
};
var results = await collection.BulkWriteAsync(models);
Console.WriteLine(results);

Los siguientes ejemplos de código producen la siguiente salida:

MongoDB.Driver.BulkWriteResult1+Acknowledged[MongoDB.Bson.BsonDocument]

Personalizar la operación de guardar masiva

Cuando llamas al método BulkWrite() o BulkWriteAsync(), puedes pasar una instancia de la clase BulkWriteOptions. La clase BulkWriteOptions contiene las siguientes propiedades, que representan opciones que puedes usar para configurar la operación de escritura masiva:

Los siguientes ejemplos de código usan un objeto BulkWriteOptions para realizar una operación de guardado masivo no ordenada:

var models = new List<WriteModel<BsonDocument>>
{
new DeleteOneModel<BsonDocument>(
    Builders<BsonDocument>.Filter.Eq("restaurant_id", "5678")
)
};
var options = new BulkWriteOptions
{
    IsOrdered = false,
};
collection.BulkWrite(models, options);

var models = new List<WriteModel<BsonDocument>>
{
new DeleteOneModel<BsonDocument>(
    Builders<BsonDocument>.Filter.Eq("restaurant_id", "5678")
)
};
var options = new BulkWriteOptions
{
    IsOrdered = false,
};
await collection.BulkWriteAsync(models, options);

Valor de retorno

Los métodos BulkWrite() y BulkWriteAsync() devuelven un objeto BulkWriteResult que contiene las siguientes propiedades:

Manejo de excepciones

Si alguna de las operaciones en una operación de escritura masiva falla, el driver .NET/C# lanza un BulkWriteError y no realiza ninguna otra operación.

Un objeto BulkWriteError contiene la propiedad Index que describe el índice de la solicitud que resultó en un error.

Operaciones de inserción

Para realizar una operación de inserción, crea una instancia de la clase BulkWriteInsertOneModel<TDocument>. El constructor BulkWriteInsertOneModel<TDocument> acepta los siguientes parámetros:

El siguiente ejemplo crea instancias de la clase BulkWriteInsertOneModel<TDocument>. Estas instancias indican al controlador que inserte documentos en las colecciones sample_restaurants.restaurants y sample_mflix.movies.

var restaurantToInsert = new BulkWriteInsertOneModel<BsonDocument>(
    "sample_restaurants.restaurants",
    new BsonDocument{
        { "name", "Mongo's Deli" },
        { "cuisine", "Sandwiches" },
        { "borough", "Manhattan" },
        { "restaurant_id", "1234" }
    }
);
var movieToInsert = new BulkWriteInsertOneModel<BsonDocument>(
    "sample_mflix.movies",
    new BsonDocument{
        { "title", "Silly Days" },
        { "year", 2022 }
    }
);

Operaciones de actualizar

Para actualizar un solo documento, cree una instancia de la clase BulkWriteUpdateOneModel<TDocument>. El constructor BulkWriteUpdateOneModel<TDocument> acepta los siguientes parámetros:

En el siguiente ejemplo de código, los objetos BulkWriteUpdateOneModel<BsonDocument> representan operaciones de actualización en las colecciones sample_restaurants.restaurants y sample_mflix.movies.

var restaurantUpdate = new BulkWriteUpdateOneModel<BsonDocument>(
    "sample_restaurants.restaurants",
    Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli"),
    Builders<BsonDocument>.Update.Set("cuisine", "Sandwiches and Salads")
);
var movieUpdate = new BulkWriteUpdateOneModel<BsonDocument>(
    "sample_mflix.movies",
    Builders<BsonDocument>.Filter.Eq("title", "Carrie"),
    Builders<BsonDocument>.Update.Set("seen", True)
);

Para actualizar varios documentos, cree una instancia de la clase BulkWriteUpdateManyModel<TDocument>. El constructor de esta clase acepta los mismos parámetros que el constructor BulkWriteUpdateOneModel<TDocument>. La operación BulkWriteUpdateManyModel<TDocument> actualiza todos los documentos que coinciden con tu filtro de query.

En el siguiente ejemplo de código, el objeto BulkWriteUpdateManyModel<BsonDocument> representa una operación de actualización en la colección sample_restaurants.restaurants. La operación coincide con todos los documentos de la colección donde el valor del campo name es "Starbucks". Luego actualiza el valor del campo cuisine a "Coffee (Chain)".

var updateManyModel = new BulkWriteUpdateManyModel<BsonDocument>(
    "sample_restaurants.restaurants",
    Builders<BsonDocument>.Filter.Eq("name", "Starbucks"),
    Builders<BsonDocument>.Update.Set("cuisine", "Coffee (Chain)")
);

Reemplazar operaciones

Para reemplazar los campos en un documento, cree una instancia de la clase BulkWriteReplaceOneModel<TDocument>. El constructor BulkWriteReplaceOneModel<TDocument> acepta los siguientes parámetros:

En el siguiente ejemplo, los objetos BulkWriteReplaceOneModel<BsonDocument> representan operaciones de reemplazo en las colecciones sample_restaurants.restaurants y sample_mflix.movies.

var restaurantReplacement = new BulkWriteReplaceOneModel<BsonDocument>(
    "sample_restaurants.restaurants",
    Builders<BsonDocument>.Filter.Eq("restaurant_id", "1234"),
    new BsonDocument{
        { "name", "Mongo's Pizza" },
        { "cuisine", "Pizza" },
        { "borough", "Brooklyn" },
        { "restaurant_id", "5678" }
    }
);
var movieReplacement = new BulkWriteReplaceOneModel<BsonDocument>(
    "sample_mflix.movies",
    Builders<BsonDocument>.Filter.Eq("title", "Insomnia"),
    new BsonDocument{
        { "name", "Loving Sylvie" },
        { "year", 1999 }
    }
);

Operaciones de borrar

Para borrar un documento, cree una instancia de la clase BulkWriteDeleteOneModel<TDocument>. El constructor BulkWriteDeleteOneModel<TDocument> acepta los siguientes parámetros:

En el siguiente ejemplo de código, los objetos BulkWriteDeleteOneModel<BsonDocument> representan operaciones de eliminación en las colecciones sample_restaurants.restaurants y sample_mflix.movies.

var restaurantToDelete = new BulkWriteDeleteOneModel<BsonDocument>(
    "sample_restaurants.restaurants",
    Builders<BsonDocument>.Filter.Eq("restaurant_id", "5678")
);
var movieToDelete = new BulkWriteDeleteOneModel<BsonDocument>(
    "sample_mflix.movies",
    Builders<BsonDocument>.Filter.Eq("title", "Mr. Nobody")
);

Para eliminar múltiples documentos, crea una instancia de la clase BulkWriteDeleteManyModel<TDocument> y pasa un filtro de query que especifique el documento que deseas eliminar. La DeleteMany remueve todos los documentos que coinciden con el filtro de query.

En el siguiente ejemplo de código, el objeto BulkWriteDeleteManyModel<BsonDocument> representa una operación de eliminación en la colección sample_restaurants.restaurants. La operación coincide y elimina todos los documentos donde el valor del campo name es "Mongo's Deli".

var deleteManyModel = new BulkWriteDeleteManyModel<BsonDocument>(
    "sample_restaurants.restaurants",
    Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli")
);

Realizar la Operación Masiva

Después de definir una instancia de BulkWriteModel para cada operación que desee realizar, cree una instancia de una clase que implemente la interfaz IReadOnlyList. Agrega tus BulkWriteModel objetos a este IReadOnlyList, luego pasa el IReadOnlyList al método BulkWrite() o BulkWriteAsync(). Por defecto, estos métodos ejecutan las operaciones en el orden en que están definidas en la colección.

Selecciona de las siguientes pestañas para ver cómo utilizar el método sincrónico BulkWrite() y el método asincrónico BulkWriteAsync() para realizar una operación de guardar masivo en múltiples espacios de nombres.

var client = new MongoClient("mongodb://localhost:27017");
var restaurantNamespace = "sample_restaurants.restaurants";
var movieNamespace = "sample_mflix.movies";
var bulkWriteModels = new[]
{
    new BulkWriteInsertOneModel<BsonDocument>(
        restaurantNamespace,
        new BsonDocument{
            { "name", "Mongo's Deli" },
            { "cuisine", "Sandwiches" },
            { "borough", "Manhattan" },
            { "restaurant_id", "1234" }
        }
    ),
    new BulkWriteInsertOneModel<BsonDocument>(
        movieNamespace,
        new BsonDocument{
            { "name", "Sarah's Secret" },
            { "year", 1988 }
        }
    ),
    new BulkWriteUpdateManyModel<BsonDocument>(
        restaurantNamespace,
        Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli"),
        Builders<BsonDocument>.Update.Set("cuisine", "Sandwiches and Salads")
    ),
    new BulkWriteDeleteOneModel<BsonDocument>(
        movieNamespace,
        Builders<BsonDocument>.Filter.Eq("title", "House")
    )
};
var result = client.BulkWrite(bulkWriteModels);
Console.WriteLine(result);

var client = new MongoClient("mongodb://localhost:27017");
var restaurantNamespace = "sample_restaurants.restaurants";
var movieNamespace = "sample_mflix.movies";
var bulkWriteModels = new[]
{
    new BulkWriteInsertOneModel<BsonDocument>(
        restaurantNamespace,
        new BsonDocument{
            { "name", "Mongo's Deli" },
            { "cuisine", "Sandwiches" },
            { "borough", "Manhattan" },
            { "restaurant_id", "1234" }
        }
    ),
    new BulkWriteInsertOneModel<BsonDocument>(
        movieNamespace,
        new BsonDocument{
            { "name", "Sarah's Secret" },
            { "year", 1988 }
        }
    ),
    new BulkWriteUpdateManyModel<BsonDocument>(
        restaurantNamespace,
        Builders<BsonDocument>.Filter.Eq("name", "Mongo's Deli"),
        Builders<BsonDocument>.Update.Set("cuisine", "Sandwiches and Salads")
    ),
    new BulkWriteDeleteOneModel<BsonDocument>(
        movieNamespace,
        Builders<BsonDocument>.Filter.Eq("title", "House")
    )
};
var result = await client.BulkWriteAsync(bulkWriteModels);
Console.WriteLine(result);

Los siguientes ejemplos de código producen la siguiente salida:

BulkWriteResult({'writeErrors': [], 'writeConcernErrors': [], 'nInserted': 2, 'nUpserted': 0, 'nMatched': 2, 'nModified': 2, 'nRemoved': 1, 'upserted': []}, acknowledged=True)

Personalizar guardado masivo

Cuando llamas al método BulkWrite() o BulkWriteAsync(), puedes pasar una instancia de la clase ClientBulkWriteOptions. La clase ClientBulkWriteOptions contiene las siguientes propiedades, que representan opciones que puedes usar para configurar la operación de escritura masiva:

Los siguientes ejemplos de código usan un objeto ClientBulkWriteOptions para personalizar la operación masiva de escritura:

var client = new MongoClient("mongodb://localhost:27017");
var deleteOneModel = new BulkWriteDeleteOneModel<BsonDocument>(
    "sample_restaurants.restaurants",
    Builders<BsonDocument>.Filter.Eq("restaurant_id", "5678")
);
var clientBulkWriteOptions = new ClientBulkWriteOptions
{
    IsOrdered = false,
    WriteConcern = WriteConcern.Unacknowledged,
    VerboseResult = true
};
var result = client.BulkWrite(deleteOneModel, clientBulkWriteOptions);

var client = new MongoClient("mongodb://localhost:27017");
var deleteOneModel = new BulkWriteDeleteOneModel<BsonDocument>(
    "sample_restaurants.restaurants",
    Builders<BsonDocument>.Filter.Eq("restaurant_id", "5678")
);
var clientBulkWriteOptions = new ClientBulkWriteOptions
{
    IsOrdered = false,
    WriteConcern = WriteConcern.Unacknowledged,
    VerboseResult = true
};
var result = await client.BulkWriteAsync(deleteOneModel, clientBulkWriteOptions);

Valor de retorno

Los métodos BulkWrite() y BulkWriteAsync() devuelven un objeto ClientBulkWriteResult que contiene las siguientes propiedades:

Manejo de excepciones

Si alguna de las operaciones en una operación de escritura masiva falla, el driver .NET/C# lanza un ClientBulkWriteException y no realiza ninguna otra operación.

Un objeto ClientBulkWriteException contiene las siguientes propiedades:

Documentación de la API

Para aprender más sobre cualquiera de los métodos o tipos analizados en esta guía, consulta la siguiente documentación de API:

• Guardar masivo de colecciones

  • bulkWrite()

  • BulkWriteAsync()

  • BulkWriteOptions

  • BulkWriteResult

  • InsertOneModel

  • UpdateOneModel

  • UpdateManyModel

  • ReplaceOneModel

  • DeleteOneModel

  • DeleteManyModel

  • BulkWriteError

• Guardado Masivo del Cliente

  • bulkWrite()

  • BulkWriteAsync()

  • ClientBulkWriteOptions

  • ClientBulkWriteResult

  • BulkWriteInsertOneModel

  • BulkWriteUpdateOneModel

  • BulkWriteUpdateManyModel

  • BulkWriteReplaceOneModel

  • Modelo BulkWriteDeleteOne

  • BulkWriteDeleteManyModel

  • BulkWriteInsertOneResult

  • BulkWriteUpdateResult

  • BulkWriteDeleteResult

  • ClientBulkWriteException