borrar (comando de base de datos)

Definición

delete

La El comando delete remueve documentos de una colección. Un solo comando delete puede contener varias especificaciones de eliminación. Los métodos de eliminación proporcionados por los controladores de MongoDB utilizan este comando internamente.

Modificado en la versión 5.0.

Tip

En mongosh, este comando también se puede ejecutar a través del deleteOne()deleteMany() findOneAndDelete() Métodos auxiliares, y.

Los métodos asistente son convenientes para usuarios de mongosh, pero es posible que no proporcionen el mismo nivel de información que los comandos de base de datos. En los casos en que no se necesite la conveniencia o se requieran campos de retorno adicionales, utiliza el comando de base de datos.

Devuelve:	Un documento que contiene el estado de la operación. Consulta Salida para obtener más detalles.

Compatibilidad

Este comando 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.

Sintaxis

El comando tiene la siguiente sintaxis:

 db.runCommand(
    {
      delete: <collection>,
      deletes: [
         {
           q : <query>,
           limit : <integer>,
           collation: <document>,
           hint: <document|string>
         },
         ...
      ],
      comment: <any>,
      let: <document>, // Added in MongoDB 5.0
      ordered: <boolean>,
      writeConcern: { <write concern> },
      maxTimeMS: <integer>
   }
)

Campos de comandos

El comando toma los siguientes campos:

{
  <variable_name_1>: <expression_1>,
  ...,
  <variable_name_n>: <expression_n>
}

Cada elemento del arreglo deletes contiene los siguientes campos:

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

Comportamiento

Ejemplos

db.runCommand(
   {
      delete: "orders",
      deletes: [ { q: { status: "D" }, limit: 1 } ]
   }
)

{ "ok" : 1, "n" : 1 }

db.runCommand(
   {
      delete: "orders",
      deletes: [ { q: { status: "D" }, limit: 0 } ],
      writeConcern: { w: "majority", wtimeout: 5000 }
   }
)

{ "ok" : 1, "n" : 13 }

db.runCommand(
   {
      delete: "orders",
      deletes: [ { q: { }, limit: 0 } ],
      writeConcern: { w: "majority", wtimeout: 5000 }
   }
)

{ "ok" : 1, "n" : 35 }

db.runCommand(
   {
      delete: "orders",
      deletes: [
         { q: { status: "D" }, limit: 0 },
         { q: { cust_num: 99999, item: "abc123", status: "A" }, limit: 1 }
      ],
      ordered: false,
      writeConcern: { w: 1, j: true }
   }
)

{ "ok" : 1, "n" : 21 }

{ _id: 1, category: "café", status: "A" }
{ _id: 2, category: "cafe", status: "a" }
{ _id: 3, category: "cafE", status: "a" }

db.runCommand({
   delete: "myColl",
   deletes: [
     { q: { category: "cafe", status: "a" }, limit: 0, collation: { locale: "fr", strength: 1 } }
   ]
})

db.members.insertMany([
   { "_id" : 1, "member" : "abc123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 2, "member" : "xyz123", "status" : "A", "points" : 60,  "misc1" : "reminder: ping me at 100pts", "misc2" : "Some random comment" },
   { "_id" : 3, "member" : "lmn123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 4, "member" : "pqr123", "status" : "D", "points" : 20,  "misc1" : "Deactivated", "misc2" : null },
   { "_id" : 5, "member" : "ijk123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 6, "member" : "cde123", "status" : "A", "points" : 86,  "misc1" : "reminder: ping me at 100pts", "misc2" : "Some random comment" }
])

db.members.createIndex( { status: 1 } )
db.members.createIndex( { points: 1 } )

db.runCommand({
   delete: "members",
   deletes: [
     { q: { "points": { $lte: 20 }, "status": "P" }, limit: 0, hint: { status: 1 } }
   ]
})

db.runCommand(
   {
     explain: {
       delete: "members",
       deletes: [
         { q: { "points": { $lte: 20 }, "status": "P" }, limit: 0, hint: { status: 1 } }
       ]
     },
     verbosity: "queryPlanner"
   }
)

db.cakeFlavors.insertMany( [
   { _id: 1, flavor: "chocolate" },
   { _id: 2, flavor: "strawberry" },
   { _id: 3, flavor: "cherry" }
] )

db.runCommand( {
   delete: db.cakeFlavors.getName(),
   deletes: [ {
      q: { $expr: { $eq: [ "$flavor", "$$targetFlavor" ] } },
      limit: 1
   } ],
   let : { targetFlavor: "strawberry" }
} )

Salida

El documento devuelto contiene un subconjunto de los siguientes campos:

delete.ok

El estado del comando.

delete.n

El número de documentos borrados.

delete.writeErrors

Un arreglo de documentos que contiene información sobre cualquier error encontrado durante la operación de eliminación. El arreglo writeErrors contiene un documento de error para cada instrucción de eliminación que cause errores.

Cada documento de error contiene la siguiente información:

delete.writeErrors.index

Un número entero que identifica la instrucción de borrar en el arreglo deletes, que utiliza un índice basado en cero.

delete.writeErrors.code

Valor entero que identifica el error.

delete.writeErrors.errmsg

Una descripción del error.

delete.writeConcernError

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

Cambiado en la versión 7.0.6: (también disponible en 6.0.14 y 5.0.30): Cuando delete se ejecuta en mongos, siempre se informa de los errores de nivel de confirmación de escritura (write concern), incluso cuando se produce uno o más errores de escritura. En versiones anteriores, la aparición de errores de guardado podía hacer que delete no informara de los errores del nivel de confirmación de escritura (write concern).

Los documentos writeConcernError contienen los siguientes campos:

delete.writeConcernError.code

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

delete.writeConcernError.errmsg

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

delete.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):

delete.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).

El siguiente es un documento de ejemplo devuelto para un comando exitoso delete:

{ ok: 1, n: 1 }

El siguiente es un ejemplo de documento devuelto para un comando delete que encontró un error porque especificó un índice inexistente en el campo hint:

{
  n: 0,
  writeErrors: [
    {
      index: 0,
      code: 2,
      errmsg: 'error processing query: ns=test.products: hat $eq "bowler"\n' +
        'Sort: {}\n' +
        'Proj: {}\n' +
        ' planner returned error :: caused by :: hint provided does not correspond to an existing index'
    }
  ],
  ok: 1
}