WriteResult() (método mongosh)

Definición

WriteResult()

Un contenedor que contiene el estado del resultado de los métodos de guardar mongosh.

Tip

Consulte:

• db.collection.insert()

• db.collection.update()

• db.collection.remove()

Nota

db.collection.insert() y db.collection.update() están obsoletos.

Los resultados devueltos por los métodos de reemplazo tienen un formato diferente. Para obtener una salida similar a WriteResult(), considera usar db.collection.bulkWrite().

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Propiedades

El WriteResult() tiene las siguientes propiedades:

WriteResult.nInserted

Número de documentos insertados, excluyendo upserted documentos. Consulte para conocer el número de documentos insertados mediante WriteResult.nUpserted upsert.

WriteResult.nMatched

El número de documentos seleccionados para actualizar. Si la operación de actualización no da lugar a ningún cambio en el documento, por ejemplo, La expresión $set actualiza el valor al valor actual, nMatched puede ser mayor que nModified.

WriteResult.nModified

El número de documentos existentes actualizados. Si la operación de actualización/reemplazo no produce ningún cambio en el documento, como establecer el valor del campo en su valor actual, nModified puede ser inferior a nMatched.

WriteResult.nUpserted

El número de documentos insertados por una inserción.

WriteResult._id

El _id del documento insertado por un upsert. Se devuelve solo si un upsert resulta en una inserción.

WriteResult.nRemoved

El número de documentos eliminados.

WriteResult.writeError

Un documento que contiene información sobre cualquier error, excluidos los errores de escritura, encontrados durante la operación de escritura.

WriteResult.writeError.code

Valor entero que identifica el error.

WriteResult.writeError.errmsg

Una descripción del error.

WriteResult.writeConcernError

Documento que describe los errores relacionados con el nivel de confirmación de escritura (write concern).

Cambiado en la versión 6.0.14: (también disponible en 5.0.30): Cuando se recibe WriteResult() de mongos, siempre se notifican los errores de nivel de confirmación de escritura (write concern), incluso si se producen uno o más errores de escritura. En versiones anteriores, la ocurrencia de errores de escritura podía hacer que el WriteResult() no informara sobre errores de nivel de confirmación de escritura (write concern).

Cada documento de error contiene los siguientes campos:

WriteResult.writeConcernError.code

Valor entero que identifica la causa del error del nivel de confirmación de escritura (write concern).

WriteResult.writeConcernError.errmsg

Una descripción de la causa del error de nivel de confirmación de escritura (write concern).

WriteResult.writeConcernError.errInfo.writeConcern

El objeto del nivel de confirmación de escritura (write concern) usado para la operación correspondiente. Para obtener información sobre los campos del objeto de nivel de confirmación de escritura (write concern), se puede consultar Especificación de nivel de confirmación de escritura (write concern).

El objeto del nivel de confirmación de escritura (write concern) también puede contener el siguiente campo, que indica el origen del nivel de confirmación de escritura (write concern):

WriteResult.writeConcernError.errInfo.writeConcern.provenance

Un valor de string que indica dónde se originó el nivel de confirmación de escritura (write concern) (conocido como nivel de confirmación de escritura (write concern) provenance). La siguiente tabla muestra los valores posibles para este campo y su significado:

Origen	Descripción
clientSupplied	El nivel de confirmación de escritura se especificó en la aplicación.
customDefault	El nivel de confirmación de escritura se originó a partir de un valor por defecto personalizado. Vea setDefaultRWConcern.
getLastErrorDefaults	El nivel de confirmación de escritura se originó en el campo settings.getLastErrorDefaults del set de réplicas.
implicitDefault	El nivel de confirmación de escritura (write concern) se originó en el servidor en ausencia de todas las demás especificaciones de nivel de confirmación de escritura (write concern).