/ /

Driver C#/.NET

Docs Home

Librerías de clientes

Driver C#/.NET

Docs Home

Librerías de clientes

Driver C#/.NET

Actualiza uno

Overview

En esta guía, puede aprender a utilizar el controlador MongoDB .NET/C# para actualizar valores en un solo documento.

El controlador .NET/C# proporciona los siguientes métodos para actualizar valores:

UpdateOne(): Actualiza uno o más campos en un único documento.
UpdateOneAsync(): la versión asíncrona de UpdateOne().

Las siguientes secciones describen estos métodos con más detalle.

Nota

Sobrecargas de métodos

Muchos de los métodos en esta página tienen múltiples sobrecargas. Los ejemplos en esta guía muestran solo una definición de cada método. Para obtener más información sobre las sobrecargas disponibles, consulta la Documentación de la API.

Datos de muestra

Los ejemplos de esta guía utilizan la colección restaurants de la base de datos sample_restaurants. Los documentos de esta colección utilizan las siguientes clases Restaurant, Address y GradeEntry como modelos:

public class Restaurant
{
    public ObjectId Id { get; set; }
    public string Name { get; set; }
    [BsonElement("restaurant_id")]
    public string RestaurantId { get; set; }
    public string Cuisine { get; set; }
    public Address Address { get; set; }
    public string Borough { get; set; }
    public List<GradeEntry> Grades { get; set; }
}

public class Address
{
    public string Building { get; set; }
    [BsonElement("coord")]
    public double[] Coordinates { get; set; }
    public string Street { get; set; }
    [BsonElement("zipcode")]
    public string ZipCode { get; set; }
}

public class GradeEntry
{
    public DateTime Date { get; set; }
    public string Grade { get; set; }
    public float? Score { get; set; }
}

Nota

Los documentos de la colección restaurants utilizan la convención de nomenclatura snake-case. Los ejemplos de esta guía utilizan un ConventionPack para deserializar los campos de la colección en notación Pascal y asignarlos a las propiedades de la clase Restaurant.

Para obtener más información sobre la serialización personalizada, consulta Serialización personalizada.

Esta colección es de los conjuntos de datos de muestra proporcionados por Atlas. Consulte Primeros pasos con el controlador .NET/C# para aprender a crear un clúster gratuito de MongoDB y cargar estos datos de muestra.

Métodos y parámetros

Los métodos UpdateOne() y UpdateOneAsync() aceptan los siguientes parámetros:

Parameter	Descripción
`filter`	Una instancia de la clase `FilterDefinition` que especifica el documento a actualizar. Para aprender a crear un filtro de query, consulta Crear un filtro de query. Tipo de dato: FilterDefinition
`update`	Una instancia de la `UpdateDefinition` clase. Este objeto especifica el tipo de operación de actualización, los campos que se actualizarán y el nuevo valor de cada campo. Para aprender a crear un `UpdateDefinition` objeto, consulte Actualizar campos en un documento y Actualizar matrices en un documento. Tipo de dato: UpdateDefinition<TDocument>
`options`	opcional. Una instancia de la clase `UpdateOptions` que especifica la configuración para la operación de actualización. El valor por defecto es `null`. Para ver una lista de las opciones disponibles, consulta Opciones de configuración. Tipo de dato: UpdateOptions
`cancellationToken`	Opcional. Un token que puedes usar para cancelar la operación. Tipo de dato: `CancellationToken`

Actualice varios valores

Los métodos UpdateOne() y UpdateOneAsync() solo aceptan un objeto UpdateDefinition cada uno. Las siguientes secciones describen cómo actualizar varios valores en una única llamada de método.

Definiciones de actualización combinada

El método Builders.Update.Combine() te permite combinar múltiples objetos UpdateDefinition. Este método acepta el siguiente parámetro:

Parameter	Descripción
`updates`	Un arreglo de definiciones de actualización para combinar. Tipo de dato: `UpdateDefinition<TDocument>[]`

El método Combine() devuelve un único objeto UpdateDefinition que define múltiples operaciones de actualización.

El siguiente ejemplo de código utiliza el método Combine() para combinar una operación $set y una operación $unset:

var filter = Builders<Restaurant>.Filter
    .Eq("name", "Downtown Deli");
var combinedUpdate = Builders<Restaurant>.Update.Combine(
    Builders<Restaurant>.Update.Set("cuisine", "French"),
    Builders<Restaurant>.Update.Unset("borough")
);
_restaurantsCollection.UpdateOne(filter, combinedUpdate);

var filter = Builders<Restaurant>.Filter
    .Eq("name", "Downtown Deli");
var combinedUpdate = Builders<Restaurant>.Update.Combine(
    Builders<Restaurant>.Update.Set("cuisine", "French"),
    Builders<Restaurant>.Update.Unset("borough")
);
await _restaurantsCollection.UpdateOneAsync(filter, combinedUpdate);

Actualizar pipeline

Puedeunir una secuencia de operaciones de actualización en una única canalización de agregación.

Para crear un pipeline de actualización, llama al método Builders.Update.Pipeline(). Este método acepta el siguiente parámetro:

Parameter	Descripción
`pipeline`	Una instancia de `PipelineDefinition` que representa la pipeline de actualización. Para crear un objeto `PipelineDefinition`, crea un documento BSON para cada operación de actualización que quieras realizar y luego pásalos al método `PipelineDefinition.Create()`. Tipo de dato: `PipelineDefinition<TDocument, TDocument>`

El método Pipeline() devuelve un único objeto UpdateDefinition que define múltiples etapas de agregación.

El siguiente ejemplo de código utiliza el método Pipeline() para combinar una operación $set y una operación $unset:

var filter = Builders<Restaurant>.Filter
    .Eq("name", "Downtown Deli");
var updatePipeline = Builders<Restaurant>.Update.Pipeline(
    PipelineDefinition<Restaurant, Restaurant>.Create(
        new BsonDocument("$set", new BsonDocument("cuisine", "French")),
        new BsonDocument("$unset", "borough")
    )
);
_restaurantsCollection.UpdateOne(filter, updatePipeline);

var filter = Builders<Restaurant>.Filter
    .Eq("name", "Downtown Deli");
var updatePipeline = Builders<Restaurant>.Update.Pipeline(
    PipelineDefinition<Restaurant, Restaurant>.Create(
        new BsonDocument("$set", new BsonDocument("cuisine", "French")),
        new BsonDocument("$unset", "borough")
    )
);
await _restaurantsCollection.UpdateOneAsync(filter, updatePipeline);

Nota

Operaciones no admitidas

Las pipelines de actualización no admiten todas las operaciones de actualización, pero sí admiten ciertas etapas de agregación que no se encuentran en otras definiciones de actualización. Para obtener una lista de las operaciones de actualización admitidas por las pipelines, consulta Actualizaciones con pipeline de agregación en el manual de MongoDB Server.

Opciones de configuración

Los métodos UpdateOne() y UpdateOneAsync() aceptan opcionalmente un objeto UpdateOptions como parámetro. Puede utilizar este argumento para configurar la operación de actualizar.

La clase UpdateOptions contiene las siguientes propiedades:

Propiedad

Descripción

ArrayFilters

Especifica qué elementos del arreglo se deben modificar para una operación de actualización en un campo de arreglo. Para obtener más información, consulta el manual de MongoDB Server.

Tipo de dato: IEnumerable<ArrayFilterDefinition>

BypassDocumentValidation

Especifica si la operación de actualización omite la validación de documentos. Esto te permite actualizar documentos que no cumplen los requisitos de validación del esquema, si existieran. Consulta el manual de MongoDB Server para obtener más información sobre la validación de esquemas.

Tipo de dato: bool?

Collation

Especifica el tipo de intercalación de idioma que se usará al ordenar los resultados. Consulte la sección Intercalación de esta página para obtener más información.

Tipo de dato: Intercalación

Comment

Obtiene o establece el comentario proporcionado por el usuario para la operación. Para obtener más información, consulta el manual de MongoDB Server.

Tipo de dato: BsonValue

Hint

Obtiene o establece el índice que se utilizará para buscar documentos. Para obtener más información, consulta el manual de MongoDB Server.

Tipo de dato: BsonValue

IsUpsert

Especifica si la operación de actualizar realiza una operación de inserción si ningún documento coincide con el filtro de query. Para obtener más información, consulta el manual de MongoDB Server.

Tipo de dato: bool

Sort

Determina qué documento actualiza la operación si la consulta selecciona varios documentos, ya que la operación de actualización actualiza el primer documento en el orden de clasificación especificado. Para configurar esta opción, debe crear una instancia UpdateOptions<T> que utilice un tipo genérico que modele sus datos, como se muestra en el siguiente código:

var options = new UpdateOptions<Restaurant>
{
  Sort = Builders<Restaurant>.Sort.Ascending(r => r.Name)
};

Tipo de dato: SortDefinition<T>

Let

Obtiene o establece el documento let. Para obtener más información, consulta el manual de MongoDB Server.

Tipo de dato: Documento Bson

Intercalación

Para configurar la intercalación para tu operación, crea una instancia de la clase intercalación.

La siguiente tabla describe los parámetros que acepta el constructor Collation. También enumera la propiedad de clase correspondiente que se puede usar para leer el valor de cada configuración.

Parameter	Descripción	Propiedad de clase
`locale`	Specifies the International Components for Unicode (ICU) locale. For a list of supported locales, see Collation Locales and Default Parameters in the MongoDB Server Manual. If you want to use simple binary comparison, use the `Collation.Simple` static property to return a `Collation` object with the `locale` set to `"simple"`. Data Type: `string`	`Locale`
`caseLevel`	(Optional) Specifies whether to include case comparison. When this argument is `true`, the driver's behavior depends on the value of the `strength` argument: - If `strength` is `CollationStrength.Primary`, the driver compares base characters and case. - If `strength` is `CollationStrength.Secondary`, the driver compares base characters, diacritics, other secondary differences, and case. - If `strength` is any other value, this argument is ignored. When this argument is `false`, the driver doesn't include case comparison at strength level `Primary` or `Secondary`. Data Type: `boolean` Default: `false`	`CaseLevel`
`caseFirst`	(Optional) Specifies the sort order of case differences during tertiary level comparisons. Data Type: CollationCaseFirst Default: `CollationCaseFirst.Off`	`CaseFirst`
`strength`	(Optional) Specifies the level of comparison to perform, as defined in the ICU documentation. Data Type: CollationStrength Default: `CollationStrength.Tertiary`	`Strength`
`numericOrdering`	(Optional) Specifies whether the driver compares numeric strings as numbers. If this argument is `true`, the driver compares numeric strings as numbers. For example, when comparing the strings "10" and "2", the driver treats the values as 10 and 2, and finds 10 to be greater. If this argument is `false` or excluded, the driver compares numeric strings as strings. For example, when comparing the strings "10" and "2", the driver compares one character at a time. Because "1" is less than "2", the driver finds "10" to be less than "2". For more information, see Collation Restrictions in the MongoDB Server manual. Data Type: `boolean` Default: `false`	`NumericOrdering`
`alternate`	(Optional) Specifies whether the driver considers whitespace and punctuation as base characters for purposes of comparison. Data Type: CollationAlternate Default: `CollationAlternate.NonIgnorable` (spaces and punctuation are considered base characters)	`Alternate`
`maxVariable`	(Optional) Specifies which characters the driver considers ignorable when the `alternate` argument is `CollationAlternate.Shifted`. Data Type: CollationMaxVariable Default: `CollationMaxVariable.Punctuation` (the driver ignores punctuation and spaces)	`MaxVariable`
`normalization`	(Optional) Specifies whether the driver normalizes text as needed. Most text doesn't require normalization. For more information about normalization, see the ICU documentation. Data Type: `boolean` Default: `false`	`Normalization`
`backwards`	(Optional) Specifies whether strings containing diacritics sort from the back of the string to the front. Data Type: `boolean` Default: `false`	`Backwards`

Más información sobre la intercalación en la página Intercalación en el manual de MongoDB Server.

Valor de retorno

El método UpdateOne() devuelve un UpdateResult, y el método UpdateOneAsync() devuelve un objeto Task<UpdateResult>. La clase UpdateResult contiene las siguientes propiedades:

Propiedad	Descripción
`IsAcknowledged`	Indica si la operación de actualización fue reconocida por MongoDB. Tipo de dato: `bool`
`IsModifiedCountAvailable`	Indica si puede leer la cantidad de registros de actualización en el `UpdateResult`. Tipo de dato: `bool`
`MatchedCount`	La cantidad de documentos que coincidieron con el filtro de query, independientemente de si uno fue actualizado. Tipo de dato: `long`
`ModifiedCount`	El número de documentos actualizados por la operación de actualización. Tipo de dato: `long`
`UpsertedId`	El ID del documento que se insertó en la base de datos, si el controlador realizó una inserción. Tipo de dato: BsonValue

Información Adicional

Para ejemplos ejecutables de las operaciones de actualización, consulta los siguientes ejemplos de uso:

Para obtener más información sobre cómo crear filtros de query, consulta la guía Crear un filtro de query.

Documentación de la API

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

Volver

Acceder a datos desde un cursor

Campos