`mongosh` Métodos

Introducción

Esta página contiene mongosh métodos.

Nota

JavaScript en MongoDB

Aunque estos métodos utilizan JavaScript, la mayoría de las interacciones con MongoDB no utilizan JavaScript, sino un driver idiomático en el lenguaje de la aplicación que interactúa.

Métodos nativos

Los métodos enumerados en esta sección son reemplazos funcionales de los métodos nativos disponibles en mongosh el mongo shell anterior. Estos métodos no son reemplazos exactos: los formatos de salida y algunas funciones pueden diferir de los métodos heredados correspondientes.

Además de estos métodos, el fragmento de código de mongocompat proporciona acceso al legado mongo API de shell.

Nota

En la siguiente tabla, <path> y <filename> son cadenas y deben estar entre comillas.

// process.chdir( <path> )
process.chdir( "./data/incoming" )

Nombre del método heredado

Sustitución

cat()

Devuelve el contenido del archivo especificado

fs.readFileSync( <filename>, 'utf8' )

La opción heredada useBinaryMode no es compatible. Emule la opción useBinaryMode = false con:

fs.readFileSync( <filename>, 'utf8' ).replace( /\r\n/g, '\n' )

getHostName()

Devuelve el nombre de host del sistema que mongosh ejecuta.

os.hostname()

getMemInfo()

Devuelve un documento que informa la memoria utilizada por el shell.

process.memoryUsage()

hostname()

Devuelve el nombre de host de la computadora que ejecuta el shell.

os.hostname()

isInteractive()

Devuelve un valor booleano que indica si se está ejecutando en modo interactivo o de mongosh script.

isInteractive()

listFiles()

Devuelve una matriz de documentos que dan el nombre y el tipo de cada objeto en el directorio.

fs.readdirSync( <path>, { withFileTypes: true } )

load()

Carga y ejecuta un archivo de JavaScript en el shell.

load() Está disponible en. Véase mongosh también Diferencias entre require() y load().

ls()

Devuelve una lista de los archivos en el directorio actual.

fs.readdirSync( <path> )

md5sumFile()

Devuelve el hash md5 del archivo especificado.

crypto.createHash( 'md5' ).update( fs.readFileSync( <filename> ) ).digest( 'hex' )

mkdir()

Crea un directorio en la ruta especificada.

fs.mkdirSync( <path>, { recursive: true } )

quit()

Cierra la sesión de Shell actual.

quit()

removeFile()

Elimina el archivo especificado del sistema de archivos local.

fs.unlinkSync( <filename> )

sleep()

Dormir durante el número especificado de milisegundos.

sleep( <number> )

version()

Devuelve la versión actual de la mongosh instancia.

version()

_isWindows()

Devuelve true si el shell se ejecuta en Windows.

process.platform === 'win32'

_rand()

Devuelve un número aleatorio entre 0 y 1.

Math.random()

Índice de Atlas Search

Nuevo en la versión 7.0: (También disponible a partir de la versión 6.0.7)

Los índices de búsqueda de MongoDB le permiten consultar datos en la búsqueda de MongoDB, mientras que los índices de búsqueda vectorial le permiten consultar datos en la búsqueda vectorial. Los índices de búsqueda y de búsqueda vectorial de MongoDB permiten realizar consultas de búsqueda de texto eficientes mediante la asignación de términos de búsqueda a los documentos que contienen esos términos.

Utilice los siguientes métodos para gestionar los índices de búsqueda y de búsqueda vectorial de MongoDB.

Nombre	Descripción
`db.collection.createSearchIndex()`	Crea un índice de búsqueda MongoDB o un índice de búsqueda vectorial en una colección o vista específica.
`db.collection.dropSearchIndex()`	Elimina un índice de búsqueda MongoDB o un índice de búsqueda vectorial existente.
`db.collection.getSearchIndexes()`	Devuelve información sobre los índices de búsqueda MongoDB o los índices de búsqueda vectorial existentes en una colección o vista especificada.
`db.collection.updateSearchIndex()`	Actualiza un índice de búsqueda MongoDB o un índice de búsqueda vectorial existente.

Atlas Stream Processing

Atlas Stream Processors le permiten realizar operaciones de agregación sobre flujos de datos continuos utilizando el mismo modelo de datos y la misma API de query que utiliza con los datos en reposo.

Utilice los siguientes métodos para gestionar los procesadores de flujo:

Importante

Los siguientes métodos solo pueden ejecutarse en implementaciones alojadas en MongoDB Atlas.

Nombre	Descripción
`sp.createStreamProcessor()`	Crea un procesador de streaming.
`sp.listStreamProcessors()`	Enumera todos los procesadores de streaming existentes en el espacio de trabajo actual de stream processing.
`sp.process()`	Crea un procesador de streaming efímero.
`sp.processor.drop()`	Borra un procesador de streaming existente.
`sp.processor.sample()`	Devuelve un arreglo de resultados de muestra de un procesador de streaming que se está ejecutando actualmente.
`sp.processor.start()`	Inicia un procesador de streaming existente.
`sp.processor.stats()`	Devuelve estadísticas que resumen un procesador de streaming existente.
`sp.processor.stop()`	Detén un procesador de streaming que se está ejecutando actualmente.

Colecciones

Nombre	Descripción
`db.collection.analyzeShardKey()`	Calcula métricas para evaluar una clave de partición.
`db.collection.aggregate()`	Proporciona acceso a la pipeline de agregación.
`db.collection.bulkWrite()`	Proporciona funcionalidad de operación de guardado masivo.
`db.collection.compactStructuredEncryptionData()`	Envuelve `compactStructuredEncryptionData` para devolver un objeto de éxito o de error.
`db.collection.configureQueryAnalyzer()`	Configura el muestreo de query para una colección.
`db.collection.count()`	Envuelve `count` para devolver un recuento del número de documentos en una colección o una vista.
`db.collection.countDocuments()`	Envuelve la `$group` etapa de agregación con una expresión `$sum` para devolver un conteo del número de documentos en una colección o una vista.
`db.collection.createIndex()`	Crea un índice en una colección.
`db.collection.createIndexes()`	Compila uno o más índices en una colección.
`db.collection.dataSize()`	Devuelve el tamaño de la colección. Envuelve el campo `size` en la salida del `collStats`.
`db.collection.deleteOne()`	Borra un único documento en una colección.
`db.collection.deleteMany()`	Elimina varios documentos en una colección.
`db.collection.distinct()`	Devuelve un arreglo de documentos que tienen valores distintos para el campo especificado.
`db.collection.drop()`	Remueve la colección especificada de la base de datos.
`db.collection.dropIndex()`	Elimina un índice especificado de una colección.
`db.collection.dropIndexes()`	Elimina todos los índices de una colección.
`db.collection.estimatedDocumentCount()`	Envuelve `count` para devolver un conteo aproximado de los documentos en una colección o una vista.
`db.collection.explain()`	Devuelve información sobre la ejecución de la query de varios métodos.
`db.collection.find()`	Realiza una query en una colección o una vista y devuelve un objeto cursor.
`db.collection.findAndModify()`	Modifica y devuelve de forma atómica un único documento.
`db.collection.findOne()`	Realiza una query y devuelve un solo documento.
`db.collection.findOneAndDelete()`	Encuentra un único documento y lo borra.
`db.collection.findOneAndReplace()`	Encuentra un único documento y lo sustituye.
`db.collection.findOneAndUpdate()`	Encuentra un único documento y lo actualiza.
`db.collection.getIndexes()`	Devuelve un arreglo de documentos que describen los índices existentes en una colección.
`db.collection.getShardDistribution()`	Para colecciones en clústeres particionados, `db.collection.getShardDistribution()` informa sobre los datos de distribución de fragmentos.
`db.collection.getShardVersion()`	Método de diagnóstico interno para clúster particionado.
`db.collection.hideIndex()`	Oculta un índice del planificador de query.
`db.collection.insert()`	Obsoleto. Para métodos alternativos, consulta Cambios de compatibilidad con el mongo Shell heredado.
`db.collection.insertOne()`	Inserta un documento nuevo en una colección.
`db.collection.insertMany()`	Inserta varios documentos nuevos en una colección.
`db.collection.isCapped()`	Informa si una colección es una colección con tamaño fijo.
`db.collection.latencyStats()`	Devuelve estadísticas de latencia para una colección.
`db.collection.mapReduce()`	Realiza la agregación de datos al estilo de Map-Reduce.
`db.collection.reIndex()`	Reconstruye todos los índices existentes en una colección.
`db.collection.remove()`	Borra documentos de una colección.
`db.collection.renameCollection()`	Cambia el nombre de una colección.
`db.collection.replaceOne()`	Reemplaza un solo documento en una colección.
`db.collection.stats()`	Informes sobre el estado de una colección. Proporciona un contenedor alrededor del`collStats`.
`db.collection.storageSize()`	Informa el tamaño total utilizado por la colección en bytes. Proporciona un contenedor alrededor del campo `storageSize` de la salida `collStats`.
`db.collection.totalIndexSize()`	Informa sobre el tamaño total utilizado por los índices en una colección. Proporciona un contenedor alrededor del campo `totalIndexSize` de la salida `collStats`.
`db.collection.totalSize()`	Informa el tamaño total de una colección, incluidos el tamaño de todos los documentos y todos los índices de una colección.
`db.collection.unhideIndex()`	Muestra un índice del planificador de query.
`db.collection.update()`	Obsoleto. Para métodos alternativos, consulta Cambios de compatibilidad con el mongo Shell heredado.
`db.collection.updateOne()`	Modifica un único documento en una colección.
`db.collection.updateMany()`	Modifica múltiples documentos en una colección.
`db.collection.watch()`	Establece un cambio de transmisión en una colección.
`db.collection.validate()`	Realiza operaciones de diagnóstico en una colección.

Cursors

Estos métodos modifican la forma en que se ejecuta la query subyacente.

Nombre	Descripción
`cursor.addOption()`	Añade indicadores especiales de protocolo de conexión que modifican el comportamiento de la query.
`cursor.allowDiskUse()`	Permite a MongoDB utilizar archivos temporales en disco para almacenar datos que superan el límite de memoria del sistema de 100 megabytes mientras se está procesando una operación de clasificación en memoria.
`cursor.batchSize()`	Controla el número de documentos que MongoDB devolverá al cliente en un único mensaje de red.
`cursor.close()`	Cierra un cursor y libera los recursos del servidor asociados.
`cursor.collation()`	Especifica la intercalación para el cursor devuelto por el `db.collection.find()`.
`cursor.comment()`	Adjunta un comentario a la query para permitir la trazabilidad en los registros y en la colección system.profile.
`cursor.count()`	Modifica el cursor para devolver el número de documentos en el conjunto de resultados en lugar de los documentos mismos.
`cursor.disableBlockWarnings()`	Silencia las advertencias que `mongosh` imprime cuando ejecuta llamadas de bloqueo en los cursores, como `.next()` o `.hasNext()` en cursores rastreables.
`cursor.explain()`	Informes sobre el plan de ejecución de la query para un cursor.
`cursor.forEach()`	Aplica una función de JavaScript para cada documento en un cursor.
`cursor.hasNext()`	Muestra verdadero si el cursor tiene documentos y puede ser iterado.
`cursor.hint()`	Obliga a MongoDB a usar un índice específico para una query.
`cursor.isClosed()`	Devuelve `true` si el cursor está cerrado.
`cursor.isExhausted()`	Muestra `true` si el cursor está cerrado y no quedan objetos en la agrupación.
`cursor.itcount()`	Calcula el número total de documentos del lado del cliente del cursor al obtener e iterar el conjunto de resultados.
`cursor.limit()`	Limita el tamaño del conjunto de resultados de un cursor.
`cursor.map()`	Aplica una función a cada documento en un cursor y recopila los valores de retorno en un arreglo.
`cursor.max()`	Especifica un límite superior exclusivo de los límites del índice para un cursor. Para su uso con `cursor.hint()`
`cursor.maxAwaitTimeMS()`	Se especifica un límite en milisegundos para esperar la siguiente actualización del resultado de la query.
`cursor.maxTimeMS()`	Especifica un límite de tiempo acumulativo en milisegundos para las operaciones de procesamiento en un cursor.
`cursor.min()`	Especifica un límite inferior inclusivo de los límites del índice para un cursor. Para su uso con `cursor.hint()`
`cursor.next()`	Devuelve el siguiente documento en un cursor.
`cursor.noCursorTimeout()`	Instruye al servidor para que evite cerrar automáticamente un cursor después de un período de inactividad.
`cursor.objsLeftInBatch()`	Devuelve el número de documentos restantes en la agrupación actual del cursor.
`cursor.pretty()`	Configura el cursor para mostrar los resultados en un formato de fácil lectura.
`cursor.readConcern()`	Especifica un nivel de consistencia de lectura para una operación de `find()`.
`cursor.readPref()`	Especifica una preferencia de lectura para un cursor para controlar cómo el cliente dirige las consultas a un set de réplicas.
`cursor.returnKey()`	Modifica el cursor para devolver las claves del índice en lugar de los documentos.
`cursor.showRecordId()`	Añade un campo de ID interno del motor de almacenamiento a cada documento devuelto por el cursor.
`cursor.size()`	Devuelve un recuento de los documentos en el cursor tras aplicar los métodos `skip()` y `limit()`.
`cursor.skip()`	Devuelve un cursor que comienza a devolver resultados solo después de pasar o saltar un número de documentos.
`cursor.sort()`	Devuelve los resultados ordenados conforme a una especificación de clasificación.
`cursor.tailable()`	Marca el cursor como con seguimiento. Solo válido para cursores sobre colecciones con tamaño fijo.
`cursor.toArray()`	Devuelve un arreglo que contiene todos los documentos devueltos por el cursor.
`cursor.tryNext()`	Se devuelve el siguiente elemento en la iteración si está disponible o, de lo contrario, nulo.

Databases

Nombre	Descripción
`db.adminCommand()`	Ejecuta un comando en la base de datos `admin`.
`db.aggregate()`	Ejecuta una pipeline de administración/diagnóstico que no requiere una colección subyacente.
`db.commandHelp()`	Devuelve información de ayuda para un comando de base de datos.
`db.createCollection()`	Crea una nueva colección o una vista. Se usa comúnmente para crear una colección con tamaño fijo.
`db.createView()`	Crea una vista.
`db.currentOp()`	Informa sobre las operaciones en curso.
`db.dropDatabase()`	Remueve la base de datos actual.
`db.fsyncLock()`	Sincroniza las escrituras en el disco y bloquea la base de datos para evitar operaciones de guardado y facilitar las operaciones de copia de seguridad. Envuelve `fsync`.
`db.fsyncUnlock()`	Permite que los guardados continúen en una base de datos bloqueada con `db.fsyncLock()`.
`db.getCollection()`	Devuelve una colección o un objeto de vista. Se utiliza para acceder a colecciones cuyos nombres no son válidos en `mongosh`.
`db.getCollectionInfos()`	Devuelve la información de las colecciones y vistas en la base de datos actual.
`db.getCollectionNames()`	Enumera todas las colecciones y vistas en la base de datos actual.
`db.getLogComponents()`	Devuelve los niveles de verbosidad de los mensajes de registro.
`db.getMongo()`	Devuelve el objeto de conexión `Mongo()` para la conexión actual.
`db.getName()`	Devuelve el nombre de la base de datos actual.
`db.getProfilingStatus()`	Devuelve un documento que refleja el nivel actual de perfilado y el umbral de perfilado.
`db.getReplicationInfo()`	Devuelve un documento con estadísticas de replicación.
`db.getSiblingDB()`	Proporciona acceso a la base de datos especificada.
`db.hello()`	Devuelve un documento que informa sobre el estado del set de réplicas.
`db.help()`	Muestra descripciones de métodos comunes de `db` objetos.
`db.hostInfo()`	Devuelve un documento con información sobre el sistema en el que se ejecuta MongoDB. Envuelve `hostInfo`
`db.killOp()`	Finaliza una operación específica.
`db.listCommands()`	Muestra una lista de comandos de bases de datos comunes.
`db.logout()`	Obsoleto. Finaliza una sesión autenticada.
`db.printCollectionStats()`	Imprime estadísticas de cada colección. Envuelve `db.collection.stats()`.
`db.printReplicationInfo()`	Imprime un informe del estado del set de réplicas desde la perspectiva del primario.
`db.printSecondaryReplicationInfo()`	Imprime el estado del set de réplicas desde la perspectiva de los secundarios.
`db.printShardingStatus()`	Imprime un informe de la configuración de particionado y los rangos de los fragmentos.
`db.rotateCertificates()`	Realiza la rotación en linea de certificados TLS. Envuelve `rotateCertificates`.
`db.runCommand()`	Ejecuta un comando de base de datos.
`db.serverBuildInfo()`	Devuelve un documento que muestra los parámetros de compilación para la instancia `mongod`. Envuelve `buildInfo`.
`db.serverCmdLineOpts()`	Devuelve un documento con información sobre el entorno de ejecución utilizado para iniciar la instancia de MongoDB. Envuelve `getCmdLineOpts`.
`db.serverStatus()`	Devuelve un documento que proporciona una visión general del estado del proceso de la base de datos.
`db.setLogLevel()`	Establece un único nivel de verbosidad para los mensajes de registro.
`db.setProfilingLevel()`	Modifica el nivel actual de perfilado de la base de datos.
`db.shutdownServer()`	Apaga el proceso actual `mongod` o `mongos` de manera limpia y segura.
`db.stats()`	Devuelve un documento que informa sobre el estado de la base de datos actual.
`db.version()`	Devuelve la versión de la instancia `mongod`.
`db.watch()`	Abre un cursor de streaming de cambios para una base de datos que informe sobre todas sus colecciones no `system`. No se puede abrir en las bases de datos `admin`, `local` o `config`.

Cachés de planes del query

Los métodos de PlanCache solo son accesibles desde el objeto de caché de planes de una colección. Para recuperarlo, utilice el db.collection.getPlanCache() método.

Nombre	Descripción
`db.collection.getPlanCache()`	Devuelve una interfaz para acceder al objeto de caché del plan del query y a los métodos asociados de PlanCache para una colección.
`PlanCache.clear()`	Elimina todos los planes del query almacenados en caché de una colección. Accesible a través del objeto de caché del plan de una colección específica, es decir, `db.collection.getPlanCache().clear()`.
`PlanCache.clearPlansByQuery()`	Limpia los planes del query en caché para la forma del query del caché de planes especificada. Accesible a través del objeto de caché de plan de una colección específica, es decir, `db.collection.getPlanCache().clearPlansByQuery()`
`PlanCache.help()`	Muestra los métodos disponibles para la caché del plan del query de una colección. Accesible a través del objeto de caché del plan de una colección específica, es decir, `db.collection.getPlanCache().help()`.
`PlanCache.list()`	Devuelve la información de la caché del plan para una colección. Accesible a través del objeto de caché del plan de una colección específica, es decir, `db.collection.getPlanCache().list()`.

Operaciones masivas

Tip

MongoDB también proporciona el método Mongo.bulkWrite() para realizar operaciones de guardar masiva.

Nombre	Descripción
`db.collection.initializeOrderedBulkOp()`	Inicializa un desarrollador de operaciones `Bulk()` para una lista ordenada de operaciones.
`db.collection.initializeUnorderedBulkOp()`	Inicializa un desarrollador de operaciones `Bulk()` para una lista desordenada de operaciones.
`Mongo.bulkWrite()`	Ejecute operaciones de guardado masivo en varios namespaces.
`Bulk()`	Desarrollador de operaciones masivas.
`Bulk.execute()`	Ejecuta una lista de operaciones masivas.
`Bulk.find()`	Especifica la condición del query para una operación de actualización o eliminación.
`Bulk.find.arrayFilters()`	Especifica los filtros que determinan qué elementos de un arreglo se deben actualizar para una operación `update` o `updateOne`.
`Bulk.find.collation()`	Especifica la intercalación para la condición de query.
`Bulk.find.delete()`	Añade una operación de borrado de múltiples documentos a una lista de operaciones.
`Bulk.find.deleteOne()`	Añade una operación de borrado de un solo documento a una lista de operaciones.
`Bulk.find.hint()`	Especifique el índice que se utilizará para la operación de actualizar/reemplazar.
`Bulk.find.remove()`	Un alias para `Bulk.find.delete()`.
`Bulk.find.removeOne()`	Un alias para `Bulk.find.deleteOne()`.
`Bulk.find.replaceOne()`	Añade una única operación de reemplazo de documento a una lista de operaciones.
`Bulk.find.updateOne()`	Añade una única operación para actualizar un documento a una lista de operaciones.
`Bulk.find.update()`	Añade una operación de actualización de `multi` a una lista de operaciones.
`Bulk.find.upsert()`	Especifica `upsert: true` para una operación de actualización.
`Bulk.getOperations()`	Devuelve un arreglo de operaciones de guardado ejecutadas en el objeto de operaciones `Bulk()`.
`Bulk.insert()`	Añade una operación de inserción a una lista de operaciones.
`Bulk.toJSON()`	Devuelve un documento JSON que contiene el número de operaciones y agrupaciones en el objeto de operaciones `Bulk()`.
`Bulk.toString()`	Devuelve los resultados `Bulk.toJSON()` como un string.

Gestión de usuarios

Nombre	Descripción
`db.auth()`	Autentica a un usuario en una base de datos.
`db.changeUserPassword()`	Cambia la contraseña de un usuario existente.
`db.createUser()`	Crea un nuevo usuario.
`db.dropUser()`	Remueve a un solo usuario.
`db.dropAllUsers()`	Borra a todos los usuarios asociados con una base de datos.
`db.getUser()`	Devuelve información sobre el usuario especificado.
`db.getUsers()`	Devuelve información sobre todos los usuarios asociados con una base de datos.
`db.grantRolesToUser()`	Otorga un rol y sus privilegios a un usuario.
`db.removeUser()`	Obsoleto Remueve a un usuario de una base de datos.
`db.revokeRolesFromUser()`	Remueve un rol de un usuario.
`db.updateUser()`	Actualiza los datos del usuario.
`passwordPrompt()`	Solicita la contraseña como alternativa para la especificación de contraseñas directamente en varios métodos de autenticación/gestión de usuarios `mongosh`.

Gestión de Roles

Nombre	Descripción
`db.createRole()`	Crea un rol y especifica sus privilegios.
`db.dropRole()`	Borra un rol definido por el usuario.
`db.dropAllRoles()`	Borra todos los roles definidos por el usuario asociados con una base de datos.
`db.getRole()`	Devuelve información para el rol especificado.
`db.getRoles()`	Devuelve información sobre todos los roles definidos por el usuario en una base de datos.
`db.grantPrivilegesToRole()`	Asigna privilegios a un rol definido por un usuario.
`db.revokePrivilegesFromRole()`	Remueve los privilegios especificados de un rol definido por el usuario.
`db.grantRolesToRole()`	Especifica los roles de los cuales un rol definido por el usuario hereda privilegios.
`db.revokeRolesFromRole()`	Remueve los roles heredados de un rol.
`db.updateRole()`	Actualiza un rol definido por un usuario.

Replicación

Nombre	Descripción
`rs.add()`	Agrega un nodo a un set de réplicas.
`rs.addArb()`	Añade un árbitro a un set de réplicas.
`rs.conf()`	Devuelve el documento de configuración del set de réplicas.
`rs.freeze()`	Impide que el nodo actual busque la elección como primario por un período de tiempo.
`rs.help()`	Devuelve texto de ayuda básico para las funciones del set de réplicas.
`rs.initiate()`	Inicializa un nuevo set de réplicas.
`rs.printReplicationInfo()`	Imprime un informe formateado del estado del set de réplicas desde la perspectiva del primario.
`rs.printSecondaryReplicationInfo()`	Imprime un informe formateado del estado del set de réplicas desde la perspectiva de los secundarios.
`rs.reconfig()`	Reconfigura un set de réplicas al aplicar un nuevo objeto de configuración de set de réplicas.
`rs.reconfigForPSASet()`	Realizar con seguridad algunos cambios de reconfiguración en un set de réplicas primario-secundario-árbitro (PSA) o en un set de réplicas que está cambiando a una arquitectura PSA.
`rs.remove()`	Remover un nodo de un set de réplicas.
`rs.status()`	Devuelve un documento con información sobre el estado del set de réplicas.
`rs.stepDown()`	Hace que el primario actual se convierta en un secundario, lo que obliga a una elección.
`rs.syncFrom()`	Establece el nodo a partir del cual se sincronizará el nodo del set de réplicas, anulando la lógica de selección del objetivo de sincronización por defecto.

particionado

Nombre	Descripción
`convertShardKeyToHashed()`	Devuelve el valor encriptado de la entrada.
`db.checkMetadataConsistency()`	Verifique el clúster o la base de datos en busca de metadatos de fragmentación que sean inconsistentes. Nuevo en la versión 7.0.
`db.collection.checkMetadataConsistency()`	Compruebe la colección para detectar metadatos de fragmentación que sean inconsistentes.
`db.collection.getShardLocation()`	Devuelve un documento que contiene los fragmentos donde se encuentra la colección y si la colección está fragmentada. Nuevo en la versión 8.1.
`sh.abortMoveCollection()`	Detiene una operación en curso de `moveCollection`. Nuevo en la versión 8.0.
`sh.abortReshardCollection()`	Anula una operación de repartición. Nuevo en la versión 5.0.
`sh.abortUnshardCollection()`	Interrumpe una operación de desfragmentación que está en curso.
`sh.addShard()`	Añade una partición a un clúster particionado.
`sh.addShardTag()`	Este método se le asigna el alias `sh.addShardToZone()`.
`sh.addShardToZone()`	Asocia una partición a una zona. Admite la configuración de zonas en clústeres particionados.
`sh.addTagRange()`	Este método se le asigna el alias `sh.updateZoneKeyRange()`.
`sh.balancerCollectionStatus()`	Devuelve información sobre si los fragmentos de una colección particionada están equilibrados.
`sh.checkMetadataConsistency()`	Verifique el clúster en busca de metadatos de fragmentación que sean inconsistentes. Nuevo en la versión 7.0.
`sh.commitReshardCollection()`	Ejecuta una operación de repartición a la fuerza para bloquear escrituras y completarse. Nuevo en la versión 5.0.
`sh.disableAutoMerger()`	Desactiva las fusiones automáticas de fragmentos para un namespace. Nuevo en la versión 7.0.
`sh.disableAutoSplit()`	Desactiva la división automática para el clúster particionado. A partir de MongoDB 6.0.3, no se realiza la división automática de fragmentos. Esto se debe a las mejoras en la política de balanceo. Los comandos de división automática aún existen, pero no ejecutan ninguna operación.
`sh.disableBalancing()`	Desactiva el balanceo en una sola colección dentro de una base de datos particionada. No afecta el equilibrio de otras colecciones en un clúster.
`sh.disableMigrations()`	Desactive las migraciones de fragmentos para una colección específica en un clúster fragmentado.
`sh.enableAutoMerger()`	Activa la fusión automática de fragmentos para un namespace. Nuevo en la versión 7.0.
`sh.enableAutoSplit()`	Activa la división automática para el clúster particionado. A partir de MongoDB 6.0.3, no se realiza la división automática de fragmentos. Esto se debe a las mejoras en la política de balanceo. Los comandos de división automática aún existen, pero no ejecutan ninguna operación.
`sh.enableBalancing()`	Activa el proceso del balanceador de la colección particionada si se desactivó anteriormente mediante `sh.disableBalancing()`.
`sh.enableMigrations()`	Activa las migraciones de fragmentos para una colección específica en un clúster particionado que anteriormente estaban desactivadas mediante `sh.disableMigrations()`.
`sh.enableSharding()`	Crea una base de datos.
`sh.getBalancerState()`	Devuelve un valor booleano para informar si el balanceador está activado actualmente.
`sh.getShardedDataDistribution()`	Devuelve información sobre la distribución de datos para colecciones particionadas. `sh.getShardedDataDistribution()` es un método del asistente de shell para la etapa `$shardedDataDistribution` de pipeline de agregación.
`sh.help()`	Devuelve el texto de ayuda para los métodos `sh`.
`sh.isBalancerRunning()`	Devuelve un documento que describe el estado del balanceador.
`sh.isConfigShardEnabled()`	Devuelve si un clúster tiene un fragmento de configuración. Si es así, `sh.isConfigShardEnabled()` también devuelve información del host y de las etiquetas.
`sh.listShards()`	Devuelve un arreglo de documentos que describen los fragmentos en un clúster.
`sh.moveChunk()`	Migra un fragmento en un clúster particionado.
`sh.moveCollection()`	Traslada una única colección no particionada a una partición diferente.
`sh.moveRange()`	Mueve rangos entre fragmentos.
`sh.removeRangeFromZone()`	Remueve una asociación entre un rango de claves de partición y una zona. Admite la configuración de zonas en clústeres particionados.
`sh.removeShardTag()`	Este método se le asigna el alias `sh.removeShardFromZone()`.
`sh.removeShardFromZone()`	Remueve la asociación entre una partición y una zona. Utiliza para gestionar el particionado de zonas.
`sh.removeTagRange()`	Este método se le asigna el alias `sh.removeRangeFromZone()`.
`sh.reshardCollection()`	Inicia una operación de repartición para cambiar la clave de partición de una colección y modificar la distribución de los datos. Nuevo en la versión 5.0.
`sh.setBalancerState()`	Activa o desactiva el balanceador que migra fragmentos entre particiones.
`sh.shardAndDistributeCollection()`	Fragmente una colección y redistribuya inmediatamente los datos usando la clave de fragmentación proporcionada. Nuevo en la versión 8.0.
`sh.shardCollection()`	Activa el particionado para una colección.
`sh.splitAt()`	Divide un fragmento existente en dos fragmentos utilizando un valor específico de la clave de fragmentación como punto de división.
`sh.splitFind()`	Divide un fragmento existente que contiene un documento que coincide con una query en dos fragmentos aproximadamente iguales.
`sh.startAutoMerger()`	Activa el AutoMerger. Nuevo en la versión 7.0.
`sh.startBalancer()`	Activa el balanceador y espera a que el balanceo comience.
`sh.status()`	Informa sobre el estado de un clúster particionado, como `db.printShardingStatus()`.
`sh.stopAutoMerger()`	Desactiva el AutoMerger. Nuevo en la versión 7.0.
`sh.stopBalancer()`	Desactiva el balanceador y espera a que se completen las rondas de balanceo en curso.
`sh.unshardCollection()`	Anula la partición de una colección particionada existente y mueve los datos de la colección a una única partición. Cuando se anula la partición de una colección, esta no puede particionarse en varias particiones y se elimina la clave de partición. Nuevo en la versión 8.0.
`sh.updateZoneKeyRange()`	Asocia un rango de claves de partición a una zona. Admite la configuración de zonas en clústeres particionados.
`sh.waitForBalancer()`	Interno. Espera a que el estado del balanceador cambie.
`sh.waitForBalancerOff()`	Interno. Espera hasta que el balanceador deje de ejecutarse.
`sh.waitForPingChange()`	Interno. Espera un cambio en el estado de ping de uno de los `mongos` en el clúster particionado.

Constructores de objetos

Nombre	Descripción
`Binary.createFromBase64()`	Crea un objeto binario a partir de un valor base64.
`Binary.createFromHexString()`	Crea un objeto binario a partir de un valor hexadecimal.
`BinData()`	Devuelve un objeto de datos binarios.
`BSONRegExp()`	Crea `BSONRegExp()` un.
`BulkWriteResult()`	Contenedor para el conjunto de resultados de`Bulk.execute()`.
`Date()`	Crea un objeto de fecha. Por defecto, crea un objeto de fecha que incluye la fecha actual.
`HexData()`	Devuelve un objeto de datos binarios.
`ObjectId()`	Devuelve un ObjectId.
`ObjectId.createFromBase64()`	Crea un ObjectId a partir de un valor base64.
`ObjectId.createFromHexString()`	Crea un ObjectId a partir de un valor hexadecimal.
`ObjectId.getTimestamp()`	Devuelve la porción de la marca de tiempo de un ObjectId.
`ObjectId.toString()`	Muestra la representación en cadena de un ObjectId.
UUID() (método mongosh)	Convierte un string hexadecimal de 32 bytes al subtipo BSON de UUID.
`WriteResult()`	Contenedor alrededor del conjunto de resultados de los métodos de guardado.

Conexiones

Nombre	Descripción
`connect()`	Se conecta a una instancia de MongoDB y a una base de datos especificada en esa instancia.
`Mongo()`	Crea un nuevo objeto de conexión.
`Mongo.getDB()`	Devuelve un objeto de base de datos.
`Mongo.getDBNames()`	Devuelve una lista de bases de datos.
`Mongo.getDBs()`	Devuelve un documento con una lista de bases de datos y metadatos.
`Mongo.getURI()`	Devuelve la cadena de conexión para la conexión activa actual.
`Mongo.getWriteConcern()`	Devuelve la preocupación de escritura para el objeto de conexión.
`Mongo.getReadPrefMode()`	Devuelve el modo de preferencia de lectura actual para la conexión de MongoDB.
`Mongo.getReadPrefTagSet()`	Devuelve el conjunto de etiquetas de preferencia de lectura para la conexión de MongoDB.
`Mongo.setCausalConsistency()`	Activa o desactiva la coherencia causal en el objeto de conexión.
`Mongo.setReadPref()`	Establece la preferencia de lectura para la conexión de MongoDB.
`Mongo.setWriteConcern()`	Establece la preocupación de escritura para el objeto de conexión.
`Mongo.startSession()`	Inicia una sesión en el objeto de conexión.
`Mongo.watch()`	Abre un cursor de flujo de cambios para una implementación que informe sobre todas sus colecciones no `system` en todas sus bases de datos, excluyendo las bases de datos internas `admin`, `local` y `config`.
`Session()`	El objeto de la sesión.
`SessionOptions()`	El objeto de opciones para la sesión.

Encriptación en uso

MongoDB admite dos enfoques para la encriptación en uso, el cifrado a nivel de campo del lado del cliente (CSFLE) y Queryable Encryption (QE). ClientEncryption es una abstracción utilizada en todos los controladores y mongosh que encapsula operaciones tanto para CSFLE como para QE. Sin embargo, algunos métodos son específicos de una característica.

Nota

Los métodos mongosh ClientEncryption requieren una conexión a la base de datos con la encriptación en uso activada. Si la conexión actual a la base de datos no se inició con la encriptación en uso activada, entonces:

Utilice el constructor Mongo() de mongosh para establecer una conexión con las opciones de encriptación en uso requeridas. El método Mongo() es compatible con los siguientes proveedores de Key Management Service (KMS) para la gestión de llaves maestras de cliente:
or
Utilice las opciones de línea de comandos mongosh para establecer una conexión con las opciones requeridas. Las opciones de la línea de comandos solo admiten el proveedor Amazon Web Services KMS para la gestión de la llave maestra de cliente.

Los comandos con alias se agrupan juntos.

Nombre	CSFLE	QE	Descripción
`getKeyVault()`	✓	✓	Devuelve el objeto del almacén de claves para la conexión actual de MongoDB.
`KeyVault.createKey()` `KeyVault.createDataKey()`	✓	✓	Crea una llave de cifrado de datos para usarla con el cifrado a nivel de campo del lado del cliente.
`KeyVault.deleteKey()`	✓	✓	Borra la llave de cifrado de datos especificada del almacén de claves.
`KeyVault.getKey()`	✓	✓	Recupera la llave de cifrado de datos especificada del almacén de claves.
`KeyVault.getKeys()`	✓	✓	Recupera todas las claves en el almacén de claves.
`KeyVault.addKeyAlternateName()` `KeyVault.addKeyAltName()`	✓	✓	Asocie un nombre alternativo de clave a la llave de cifrado de datos especificada.
`KeyVault.removeKeyAlternateName()` `KeyVault.removeKeyAltName()`	✓	✓	Elimine un nombre alternativo de clave de la llave de cifrado de datos especificada.
`KeyVault.getKeyByAltName()`	✓	✓	Recupera las claves con el nombre alternativo de clave especificado.
`KeyVault.rewrapManyDataKey()`	✓	✓	Descifre múltiples claves de datos y las vuelve a cifrar con una nueva clave maestra.
`getClientEncryption()`	✓	✓	Devuelve el objeto de cifrado del cliente para admitir el cifrado/descifrado explícito de campos.
`ClientEncryption.createEncryptedCollection()`	✓	✓	Crea una colección con campos cifrados.
`ClientEncryption.encrypt()`	✓	✓	Cifra un campo utilizando una llave de cifrado de datos y un algoritmo de cifrado especificado.
`ClientEncryption.encryptExpression()`		✓	Cifra una expresión de query con una llave de cifrado de datos y opciones de cifrado especificadas.
`ClientEncryption.decrypt()`	✓	✓	Desencripta un campo utilizando la llave de cifrado de datos asociada y el algoritmo de cifrado.

Volver

Códigos de operación heredados

db.colección.createSearchIndex