Métodos

El siguiente documento enumera los métodos disponibles en MongoDB Shell. Haga clic en un método para ver su documentación en el Manual de MongoDB, incluida sintaxis y ejemplos.

Importante

Los métodos que restablecen la conexión del shell al servidor activan una terminación de todas las sesiones abiertas del servidor. Cuando una sesión termina, todas las operaciones en curso se terminan también, y el cliente debe volver a autenticarse si la autenticación está activada.

Los siguientes métodos restablecen la conexión del shell:

db.auth
Mongo.setReadPref
Mongo.setReadConcern

Métodos de Administración

Método	Descripción
`db.adminCommand()`	Ejecuta un comando en la base de datos `admin`.
`db.currentOp()`	Informa sobre las operaciones en curso.
`db.killOp()`	Finaliza una operación específica.
`db.shutdownServer()`	Cierra el proceso actual de `mongod` o `mongos` de forma limpia y segura.
`db.fsyncLock()`	Sincroniza las escrituras en el disco y bloquea la base de datos para evitar operaciones de escritura y facilitar las operaciones de copia de seguridad.
`db.fsyncUnlock()`	Permite que las escrituras continúen en una base de datos bloqueada con `db.fsyncLock()`.

Métodos del índice de Atlas Search

Los índices de Atlas Search te permiten consultar datos en Atlas Search. Los índices de Atlas Search permiten consultas de búsqueda de texto eficientes al mapear los 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 de Atlas.

Importante

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

Nombre	Descripción
db.collection.createSearchIndex()	Crea uno o más índices de Atlas Search en una colección especificada.
db.collection.dropSearchIndex()	Borra un índice existente de Atlas Search.
db.collection.getSearchIndexes()	Devuelve información sobre los índices de Atlas Search existentes en una colección específica.
db.collection.updateSearchIndex()	Actualiza un índice de búsqueda de Atlas existente.

Métodos de operaciones masivas

Método	Descripción
`db.collection.initializeOrderedBulkOp()`	Inicializa y devuelve un nuevo desarrollador de operaciones `Bulk()` para una colección. El desarrollador crea una lista ordenada de operaciones de escritura que MongoDB ejecuta de forma masiva.
`db.collection.initializeUnorderedBulkOp()`	Inicializa y devuelve un nuevo desarrollador de operaciones `Bulk()` para una colección. El desarrollador crea una lista desordenada de operaciones de escritura que MongoDB ejecuta en bloque.
`Bulk()`	Crea un generador de operaciones masivas que se utiliza para elaborar una lista de operaciones de escritura que se deben realizar de forma masiva para una sola colección. Para instanciar el desarrollador, utiliza el método `db.collection.initializeOrderedBulkOp()` o el método `db.collection.initializeUnorderedBulkOp()`.
`Bulk.execute()`	Ejecuta la lista de operaciones compiladas por el desarrollador de operaciones `Bulk()`.
`Bulk.find()`	Especifica una condición del query para una operación de actualización o remoción.
`Bulk.find.hint()`	Establece la opción de sugerencia que especifica el índice para brindar soporte a la operación masiva.
`Bulk.find.remove()`	Agrega una operación de remoción a una lista de operaciones masivas.
`Bulk.find.removeOne()`	Agrega una operación de remoción de un solo documento a una lista de operaciones masivas.
`Bulk.find.replaceOne()`	Agrega una operación de reemplazo de un único documento a una lista de operaciones masivas.
`Bulk.find.updateOne()`	Agrega una sola operación de actualización de documento a una lista de operaciones masivas.
`Bulk.find.update()`	Agrega una operación de actualización múltiple a una lista de operaciones masivas. El método actualiza campos específicos en documentos existentes.
`Bulk.find.upsert()`	Establece la opción inserción en `true` para una operación de actualización o de reemplazo.
`Bulk.getOperations()`	Devuelve un arreglo de operaciones de escritura ejecutadas a través de `Bulk.execute()`.
`Bulk.insert()`	Agrega una operación de inserción a una lista de operaciones masivas.
`Bulk.toJSON()`	Devuelve un documento JSON que contiene el número de operaciones y agrupaciones en el objeto `Bulk()`.
`Bulk.toString()`	Devuelve como un string un documento JSON que contiene el número de operaciones y agrupaciones en el objeto `Bulk()`.

Métodos de colección

Método	Descripción
`db.collection.aggregate()`	Proporciona acceso al pipeline de agregación.
`db.collection.bulkWrite()`	Proporciona funcionalidad de operación de guardado masivo.
`db.collection.count()`	Obsoleto en `mongosh` 1.0.6. Utilice `db.collection.countDocuments()` o en su `db.collection.estimatedDocumentCount()` lugar.
`db.collection.countDocuments()`	Devuelve un recuento de la cantidad de documentos en una colección o una vista. Envuelve la etapa de agregación `$group` con una expresión `$sum`.
`db.collection.estimatedDocumentCount()`	Devuelve un conteo aproximado de los 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.ensureIndex()`	Obsoleto. Utiliza `db.collection.createIndex()`.
`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()`	Imprime las estadísticas de distribución de datos para una colección fragmentada.
`db.collection.getShardVersion()`	Devuelve información sobre el estado de los datos en un clúster particionado.
`db.collection.insertOne()`	Inserta un nuevo documento 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.mapReduce()`	Ejecuta operaciones de agregación map-reduce en una colección.
`db.collection.reIndex()`	Reconstruye todos los índices existentes en 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 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.updateOne()`	Modifica un único documento en una colección.
`db.collection.updateMany()`	Modifica múltiples documentos en una colección.
`db.collection.validate()`	Valida una colección.
`db.collection.watch()`	Abre un cursor de flujo de cambios en la colección.

Métodos de conexión

Método

Descripción

Mongo()

Constructor de JavaScript para instanciar una conexión a una base de datos desde el shell de mongo o desde un archivo de JavaScript.

El método Mongo() tiene los siguientes parámetros:

Parameter	Tipo	Descripción
`host`	string	Opcional La cadena de conexión para la conexión a la base de datos de destino. Si se omite, `Mongo()` establece una conexión con la interfaz localhost en el puerto por defecto `27017`.
`autoEncryptionOpts`	Documento	Opcional Nuevo en la versión 4.2. Parámetros de configuración para activar el cifrado a nivel de campo del lado del cliente. `autoEncryptionOpts` anula la configuración existente de cifrado a nivel de campo del lado del cliente de la conexión a la base de datos. Si se omite, `Mongo()` hereda la configuración de cifrado a nivel de campo del lado del cliente de la conexión a la base de datos actual. Para obtener documentación sobre el uso y la sintaxis, consulta AutoEncryptionOpts.

Mongo.getDB()

Devuelve un objeto de base de datos.

Mongo.setReadPref()

Establece la preferencia de lectura para la conexión de MongoDB.

Mongo.watch()

Abre un cursor de flujo de cambios para un set de réplicas o un clúster para informar sobre todas sus colecciones no pertenecientes al sistema en sus bases de datos, con la excepción de las bases de datos admin, local y config.

Métodos del cursor

Método

Descripción

cursor.addOption()

Agrega indicadores especiales de protocolo de conexión que modifican el comportamiento del query.

cursor.batchSize()

Especifica el número máximo de documentos que MongoDB puede devolver al cliente dentro de cada grupo devuelto en un resultado del query. Por defecto, el tamaño inicial del grupo es el menor de 101 documentos o 16 mebibytes (MiB) en documentos. Los grupos subsiguientes tienen un tamaño máximo de 16 MiB. Esta opción puede aplicar un límite menor que 16 MiB, pero no uno mayor. Cuando se establece, batchSize es el menor de batchSize documentos o 16 MiB de documentos.

Un batchSize de 0 significa que el cursor está establecido, pero no se devuelven documentos en el primer agrupamiento.

El siguiente query de ejemplo devuelve resultados en grupos de 100:

db.myCollection.find().batchSize(100)

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

Devuelve true 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.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.readConcern()

Especifica un nivel de consistencia de lectura para una operación de db.collection.find().

cursor.readPref()

Especifica una preferencia de lectura a un cursor para controlar cómo el cliente dirige el query 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 conteo de los documentos en el cursor después de 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.

Métodos de bases de datos

Método	Descripción
`db.aggregate()`	Ejecuta una pipeline de administración/diagnóstico que no requiere una colección subyacente.
`db.createCollection()`	Crea una nueva colección o vista.
`db.createView()`	Crea una vista como resultado de aplicar el pipeline de agregación especificado a la colección o vista de origen.
`db.commandHelp()`	Muestra el texto de ayuda para el comando de base de datos especificado.
`db.dropDatabase()`	Remueve la base de datos actual.
`db.getCollection()`	Devuelve una colección o un objeto de vista. Se utiliza para acceder a colecciones con nombres que no son válidos en el shell de `mongo`.
`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.getMongo()`	Devuelve la conexión actual de la base de datos.
`db.getLogComponents()`	Devuelve la configuración actual del nivel de verbosidad del registro.
`db.getName()`	Devuelve el nombre de la base de datos actual.
`db.getProfilingStatus()`	Devuelve el nivel del perfil actual, la configuración de slowOpThresholdMs y la configuración de slowOpSampleRate.
`db.getSiblingDB()`	Proporciona acceso a la base de datos especificada.
`db.listCommands()`	Proporciona una lista de todos los comandos de base de datos.
`db.logout()`	Finaliza una sesión autenticada.
`db.printShardingStatus()`	Imprime un informe formateado de la configuración de particionado y la información sobre los fragmentos existentes en un clúster particionado.
`db.runCommand()`	Ejecuta un comando de base de datos.
`db.setLogLevel()`	Establece un único nivel de verbosidad para los mensajes de registro.
`db.setProfilingLevel()`	Configura el nivel del perfilador de la base de datos, slowms y sampleRate.
`db.watch()`	Abre un cursor de flujo de cambios para que una base de datos informe sobre todas sus colecciones que no forman parte del sistema.

Métodos de encriptación en uso

Nota

Limitaciones

El cifrado automático solo está disponible cuando mongosh está conectado a un clúster de Atlas o a un servidor MongoDB Enterprise. Para obtener más detalles, consulta Cifrado automático. Los métodos enumerados en esta sección se utilizan para el cifrado manual y son compatibles con servidores que no son de tipo empresarial.
El cifrado automático no está disponible con la instalación de Homebrew de mongosh.
El cifrado a nivel de campo solo está disponible en el binario mongosh y no está disponible en el shell integrado de Compass.

Método	Descripción
ClientEncryption.createEncryptedCollection()	Crea una colección con campos cifrados.
`ClientEncryption.decrypt()`	Descifra el `encryptedValue` especificado si la conexión actual a la base de datos se configuró con acceso al Key Management Service (KMS) y al almacén de claves utilizado para cifrar `encryptedValue`.
`ClientEncryption.encrypt()`	Cifra el valor especificado utilizando el `encryptionKeyId` y el `encryptionAlgorithm` especificados.
`getClientEncryption()`	Devuelve el objeto `ClientEncryption` para la colección actual de la base de datos.
`getKeyVault()`	Devuelve el objeto `KeyVault` para la conexión actual de la base de datos.
`KeyVault.addKeyAlternateName()`	Agrega el `keyAltName` al arreglo `keyAltNames` de la llave de cifrado de datos con el UUID especificado.
`KeyVault.createKey()`	Agrega una llave de cifrado de datos al almacén de claves asociado a la conexión de la base de datos.
`KeyVault.deleteKey()`	Borra una llave de cifrado de datos con el UUID especificado del almacén de claves asociado a la conexión de la base de datos.
`KeyVault.getKey()`	Obtiene una llave de cifrado de datos con el UUID especificado. La llave de cifrado de datos debe existir en el almacén de claves asociado a la conexión de la base de datos.
`KeyVault.getKeyByAltName()`	Obtiene todas las claves de cifrado de datos con el `keyAltName` especificado.
`KeyVault.getKeys()`	Devuelve todas las llaves de cifrado de datos almacenadas en el almacén de claves asociado a la conexión de la base de datos.
`KeyVault.removeKeyAlternateName()`	Remueve el `keyAltName` especificado de la llave de cifrado de datos con el UUID especificado. La llave de cifrado de datos debe existir en el almacén de claves asociado a la conexión de la base de datos.

Métodos nativos

Método

Descripción

buildInfo()

Devuelve el siguiente documento en formato JSON que describe la información de compilación y dependencias de drivers mongosh:

{
  version: '1.10.1',
  distributionKind: 'packaged',
  buildArch: 'x64',
  buildPlatform: 'linux',
  buildTarget: 'unknown',
  buildTime: '2023-06-21T09:49:37.225Z',
  gitVersion: '05ad91b4dd40382a13f27abe1ae8c3f9f52a38f7',
  nodeVersion: 'v16.20.1',
  opensslVersion: '3.1.1',
  sharedOpenssl: true,
  runtimeArch: 'x64',
  runtimePlatform: 'darwin',
  deps: {
     nodeDriverVersion: '5.6.0',
     libmongocryptVersion: undefined,
     libmongocryptNodeBindingsVersion: undefined
   }
}

isInteractive()

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

load()

Carga y ejecuta un archivo de JavaScript en el shell.

En mongosh, los scripts cargados con el método load() admiten las variables __filename y __dirname de Nodo.js. Estas variables devuelven el nombre del archivo y el directorio del script cargado, respectivamente. Los valores devueltos son siempre rutas absolutas.

El shell mongo heredado no puede acceder al nombre de archivo ni al directorio de un script en el método load().

print()

Imprime el texto o la variable especificados. print() y printjson() reciben el alias de console.log().

> print("hello world")
hello world
> x = "example text"
> print(x)
example text

quit()

Cierra la sesión de Shell actual.

sleep()

Suspende el shell mongo durante un período de tiempo determinado.

version()

Devuelve la versión actual de la instancia mongosh.

Métodos de caché del plan del query

Método	Descripción
`db.collection.getPlanCache()`	Devuelve una interfaz para acceder al objeto de caché del plan del query y a los métodos `PlanCache` asociados para una colección.
`PlanCache.clear()`	Remueve todos los planes del query almacenados en caché para una colección.
`PlanCache.clearPlansByQuery()`	Elimina los planes del query almacenados en caché para la forma del query.
`PlanCache.help()`	Enumera los métodos disponibles para ver y modificar la caché del plan del query de una colección.
`PlanCache.list()`	Devuelve un arreglo de entradas de caché de planes para una colección.

Métodos de replicación

Método

Descripción

rs.add()

Agrega un nodo al set de réplicas. Debes conectarte al primario del set de réplicas para ejecutar este método.

rs.addArb()

Agrega un árbitro a un set de réplicas existente.

rs.config()

Devuelve un documento que contiene la configuración actual del set de réplicas.

rs.freeze()

Hace que el set de réplicas al que mongosh está conectado sea inelegible para convertirse en primario durante el período especificado. Debes especificar la duración en segundos.

db.getReplicationInfo()

Devuelve el estado del set de réplicas a partir de los datos del oplog.

rs.initiate()

Inicializa un nuevo set de réplicas.

db.printReplicationInfo()

Devuelve el oplog del set de réplicas al que mongosh está conectado.

rs.printReplicationInfo()

Devuelve el oplog del set de réplicas al que mongosh está conectado.

db.printSecondaryReplicationInfo

Devuelve el estado de los secundarios del set de réplicas.

Esto es idéntico al método rs.printSecondaryReplicationInfo().

A continuación se muestra un ejemplo de salida del método rs.printSecondaryReplicationInfo() emitido en un set de réplicas con dos nodos secundarios:

source: rs2.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020  09:37:28 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}
---
source: rs3.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020  09:37:28 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}

rs.printSecondaryReplicationInfo

Devuelve el estado de los secundarios del set de réplicas.

Esto es idéntico al método db.printSecondaryReplicationInfo().

A continuación se muestra un ejemplo de salida del método rs.printSecondaryReplicationInfo() emitido en un set de réplicas con dos nodos secundarios:

source: rs2.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020 09:42:18 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}
---
source: rs3.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020 09:42:18 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}

rs.reconfig()

Modifica la configuración de un set de réplicas existente.

rs.remove()

Elimina el nodo especificado por nombre de host del set de réplicas.

rs.status()

Devuelve el estado del set de réplicas al que mongosh está conectado.

rs.stepDown()

Convierte al primario del set de réplicas en un secundario. Debes estar conectado al primario para ejecutar este método.

rs.syncFrom()

Restablece el objetivo de sincronización en el set de réplicas especificado por el nombre de host para el set de réplicas al que mongosh está conectado.

Métodos de gestión de roles

Método	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.

Métodos del objeto de sesión

Método	Descripción
`Mongo.startSession()`	Inicia una sesión para la conexión.
Sesión.advanceOperationTime()	Actualiza el tiempo de la operación.
Session.endSession()	Finaliza la sesión.
Sesión.getClusterTime()	Devuelve el tiempo de clúster más reciente según lo visto por la sesión.
Session.getDatabase()	Acceda a la base de datos especificada desde la sesión en el shell.
Sesión.getOperationTime()	Devuelve la marca de tiempo de la última operación confirmada para la sesión.
Session.getOptions()	Devuelve las opciones para la sesión.
Session.hasEnded()	Devuelve un valor booleano que especifica si la sesión ha finalizado.
`SessionOptions()`	Las opciones para una sesión en el Shell. Para acceder al objeto `SessionOptions()`, utilice `Session.getOptions()`.

Métodos de estado del servidor

Método	Descripción
`db.hello()`	Devuelve un documento que describa el rol de la instancia de `mongod`. Si el `mongod` es un nodo de un set de réplicas, entonces los campos `isWritablePrimary` y `secondary` informan si la instancia es el primario o si es un secundario del set de réplicas.
`db.hostInfo()`	Devuelve un documento con información sobre el sistema que ejecuta la instancia de MongoDB.
`db.collection.latencyStats()`	Devuelve estadísticas de latencia para una colección especificada.
`db.printCollectionStats()`	Devuelve estadísticas de cada colección.
`db.serverBuildInfo()`	Devuelve un documento que muestra los parámetros de compilación para la instancia de `mongod`.
`db.serverCmdLineOpts()`	Devuelve un documento con información sobre las opciones de ejecución utilizadas para iniciar la instancia de MongoDB.
`db.serverStatus()`	Devuelve un documento que ofrece una visión general del proceso de la base de datos.
`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 de `mongod`.

Métodos de particionado

Método	Descripción
`db.collection.getShardLocation()`	Devuelve un documento que contiene los fragmentos donde se encuentra la colección y si la colección está fragmentada.
`sh.addShard()`	Agrega una partición a un clúster particionado.
`sh.addShardTag()`	Se le asigna el alias de `sh.addShardToZone()`.
`sh.addShardToZone()`	Asocia una partición con una zona. Admite la configuración de zonas en clústeres particionados.
`sh.addTagRange()`	Se le asigna el alias de `sh.updateZoneKeyRange()`.
`sh.balancerCollectionStatus()`	Devuelve información sobre si los fragmentos de una colección particionada están equilibrados. Nuevo en la versión 4.4.
`sh.disableAutoMerger()`	Desactiva la combinación automática 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.
`sh.disableBalancing()`	Desactiva el equilibrio en una sola colección en una base de datos particionada. No afecta el equilibrio de otras colecciones en un clúster.
`sh.disableMigrations()`	Desactiva las migraciones de fragmentos para una colección específica en un clúster particionado. Internamente ejecuta el comando `setAllowMigrations`.
`sh.enableAutoMerger()`	Permite la combinació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.
`sh.enableBalancing()`	Activa el proceso del balanceador de colecciones particionadas si se ha desactivado previamente mediante `sh.disableBalancing()`.
`sh.enableMigrations()`	Activa las migraciones de fragmentos para una colección específica en un clúster particionado previamente desactivadas mediante `sh.disableMigrations()`. Internamente ejecuta al comando `setAllowMigrations`.
`sh.enableSharding()`	Permite el particionado en una base de datos específica.
`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 asistente de shell para la etapa del pipeline de agregación `$shardedDataDistribution`.
`sh.isBalancerRunning()`	Devuelve un valor booleano para informar si el proceso de balanceador está migrando fragmentos actualmente.
sh.isConfigShardEnabled()	Devuelve si un clúster tiene una partición de configuración. Si es así, `sh.isConfigShardEnabled()` también devuelve información de host y de etiqueta.
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.removeRangeFromZone()`	Remueve la asociación entre un rango de valores de la clave de partición y una zona..
`sh.removeShardFromZone()`	Elimina la asociación entre un fragmento y una zona.
`sh.removeShardTag()`	Remueve la asociación entre una etiqueta y una partición.
`sh.removeTagRange()`	Remueve un rango de valores de la clave de partición a una etiqueta de partición creada mediante el método `sh.addShardTag()`. A este método se le asigna el alias de `sh.removeRangeFromZone()` en MongoDB 3.4.
`sh.setBalancerState()`	Activa o desactiva el balanceador que migra fragmentos entre particiones.
`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 partición como punto de división.
`sh.splitFind()`	Divide un fragmento existente que contiene un documento que coincide con un query en dos fragmentos aproximadamente iguales.
sh.startAutoMerger()	Activa el AutoMerger. Nuevo en la versión 7.0.
`sh.startBalancer()`	Permite el balanceador.
`sh.status()`	Informes sobre el estado de un clúster particionado.
sh.stopAutoMerger()	Desactiva el AutoMerger. Nuevo en la versión 7.0.
`sh.stopBalancer()`	Desactiva el balanceador. Esta operación no espera a que el balanceador complete alguna operación en progreso y puede finalizar las operaciones en curso.
`sh.updateZoneKeyRange()`	Asocia un rango de claves de fragmentación con una zona. Admite la configuración de zonas en clústeres fragmentados.

Métodos de telemetría

Estos métodos configuran si mongosh rastrea datos anónimos de telemetría. La telemetría está activada por defecto.

Para obtener más información sobre los datos que mongosh rastrea con la telemetría, consulta Configurar las opciones de telemetría.

Método	Descripción
`disableTelemetry()`	Desactiva la telemetría para `mongosh`.
`enableTelemetry()`	Activa la telemetría para `mongosh`.

Métodos de transacciones

Método	Descripción
`Session.abortTransaction()`	Termina una transacción multi-documento y revierte cualquier cambio de datos realizado por las operaciones dentro de la transacción.
`Session.commitTransaction()`	Guarda los cambios realizados por las operaciones en una transacción multi-documento y finaliza la transacción.
`Session.startTransaction()`	Inicia una transacción multi-documento asociada a la sesión.

Métodos de gestión de usuarios

Importante

El método passwordPrompt() actualmente no es compatible en mongosh. Como resultado, al utilizar los siguientes métodos, debe especificar la contraseña como un parámetro:

Método	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.dropAllUsers()`	Borra a todos los usuarios asociados con una base de datos.
`db.dropUser()`	Elimina un único usuario.
`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.updateUser()`	Actualiza los datos de un usuario especificado.
`db.grantRolesToUser()`	Otorga un rol y sus privilegios a un usuario.
`db.revokeRolesFromUser()`	Remueve un rol de un usuario.

Volver

Tipos de datos

EJSON