validar (comando de base de datos)

Definición

validate

El comando verifica que los datos y los índices de una colección sean correctos y devuelve los validate resultados.

Tip

mongoshEn, este comando también se puede ejecutar a través del validate() método auxiliar.

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.

Modificado en la versión 5.0.

A partir de la 5.0 versión, el comando también puede encontrar inconsistencias en la colección y solucionarlas si es validate posible.

Las inconsistencias del índice incluyen:

• Un índice es multiclave pero no hay campos multiclave.

• Un índice tiene rutas multikeyPath que cubren campos que no son multikey.

• Un índice no tiene multikeyPaths pero hay documentos multikey (para índices creados antes 3.4 de).

Si el comando detecta alguna db.collection.validate() inconsistencia, se devuelve una advertencia y el indicador de reparación en el índice se establece true en.

db.collection.validate() también valida cualquier documento que viole las reglas de validación del esquema de la colección.

Nota

El comando validate no admite vistas y genera un error cuando se ejecuta en una vista.

El db.collection.validate() método en proporciona una envoltura mongosh alrededor validate de.

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(
   {
     validate: <string>,          // Collection name
     full: <boolean>,             // Optional
     repair: <boolean>,           // Optional, added in MongoDB 5.0
     metadata: <boolean>          // Optional, added in MongoDB 5.0.4
   }
)

Campos de comandos

El comando toma los siguientes campos:

db.runCommand( { collMod: <collectionName> } )

Comportamiento

Ejemplos

• Para validar una colección myCollection utilizando la configuración de validación predeterminada (específicamente, full: false):

  db.runCommand( { validate: "myCollection" } )

• Para realizar una validación completa de la colección,myCollection especifique full: true:

  db.runCommand( { validate: "myCollection", full: true } )

• Para myCollection reparar la colección, especifique repair: true:

  db.runCommand( { validate: "myCollection", repair: true } )

• Para validar los metadatos en la myCollection colección, especifique metadata: true:

  db.runCommand( { validate: "myCollection", metadata: true } )

Validar salida

Especifique completo: verdadero para obtener una salida más detallada.

validate.nInvalidDocuments

Número de documentos inválidos en la colección. Los documentos inválidos son aquellos que no se pueden leer, lo que significa que el documento BSON está dañado y presenta un error o un tamaño incompatible.

validate.nNonCompliantDocuments

Número de documentos que no se ajustan al esquema de la colección. Los documentos no conformes no se consideran inválidos nInvalidDocuments en.

validate.nrecords

El número de documentos en la colección.

validate.nIndexes

El número de índices de la colección que fueron validados.

validate.keysPerIndex

Un documento que contiene el nombre y el número de entradas de índice para cada índice de la colección.

"keysPerIndex" : {
   "_id_" : <num>,
   "<index2_name>" : <num>,
   ...
}

keysPerIndex identifica el índice solo por su nombre.

validate.indexDetails

Un documento que contiene el estado de la validación del índice para cada índice.

"indexDetails" : {
   "_id_" : {
      "valid" : <boolean>
   },
   "<index2_name>" : {
      "valid" : <boolean>
   },
   ...
}

• indexDetails Identifica el índice (o índices) específico(s) que no es válido. Las versiones anteriores de MongoDB marcaban todos los índices como no válidos si alguno lo era.

• indexDetails identifica el índice únicamente por su nombre. Las versiones anteriores de MongoDB mostraban el espacio de nombres completo del índice; es<db>.<collection>.$<index_name> decir,.

validate.ns

El nombre completo del espacio de nombres de la colección. Los espacios de nombres incluyen el nombre de la base de datos y el nombre de la colección en el formato database.collection.

validate.valid

Un valor booleano que es true si determina que todos los aspectos de la colección son válidos.validate Si false es, consulte el campo para obtener más errors información.

validate.repaired

Un valor booleano que es true si reparó la validate colección.

validate.warnings

Un arreglo que contiene mensajes de advertencia, si los hay, respecto a la propia operación de validación. Los mensajes de advertencia no indican que la colección sea en sí misma inválida. Por ejemplo:

"warnings" : [
   "Could not complete validation of table:collection-28-6471619540207520785. This is a transient issue as the collection was actively in use by other operations."
],

validate.errors

Si la colección no es válida (es decir, valid es falso), este campo contendrá un mensaje que describe el error de validación.

validate.extraIndexEntries

Una matriz que contiene información para cada entrada de índice que apunta a un documento que no existe en la colección.

"extraIndexEntries" : [
   {
      "indexName" : <string>,
      "recordId" : <NumberLong>,  // for the non-existent document
      "indexKey" : {
         "<key1>" : <value>,
         ...
      }
   }
   ...
]

Nota

Para la matriz, la suma de los tamaños de extraIndexEntries los indexKey campos tiene un límite de 1MB, donde los tamaños incluyen tanto las claves como los valores indexKey de. Si la suma supera este tamaño, el campo de advertencia muestra un mensaje.

validate.missingIndexEntries

Una matriz que contiene información para cada documento al que le falta la entrada de índice correspondiente.

"missingIndexEntries" : [
   {
      "indexName" : <string>,
      "recordId" : <NumberLong>,
      "idKey" : <_id key value>,     // The _id value of the document. Only present if an ``_id`` index exists.
      "indexKey" : {                 // The missing index entry
         "<key1>" : <value>,
         ...
      }
   }
   ...
 ]

Nota

Para el arreglo missingIndexEntries, la suma del tamaño del campo idKey y todos sus tamaños de campo indexKey tiene un límite de 1MB, donde los tamaños de los campos incluyen tanto las claves como los valores para idKey y indexKey. Si la suma supera este tamaño, el campo de advertencia muestra un mensaje.

validate.corruptRecords

Una matriz de valores RecordId para documentos ilegibles, posiblemente porque los datos están dañados. Estos documentos se reportan como corruptos durante la validación. Un RecordId es una clave interna entera de 64bits que identifica de forma única un documento en una colección.

"corruptRecords" : [
   Long(1),  // RecordId 1
   Long(2)   // RecordId 2
]

Nuevo en la versión 5.0.

validate.ok

Un entero con el valor 1 cuando el comando se ejecuta correctamente. Si el comando falla, el campo tiene ok el 0 valor.