Comandos de base de datos

Toda la documentación de comandos que se describe a continuación describe un comando y sus parámetros disponibles, y proporciona una plantilla o prototipo de documento para cada comando. Algunos documentos de comandos también incluyen la documentación relevante. mongosh ayudantes.

Para ejecutar un comando contra la base de datos actual, utilice db.runCommand():

db.runCommand( { <command> } )

Para ejecutar un comando administrativo en la base de datos admin, utiliza db.adminCommand():

db.adminCommand( { <command> } )

Nota

Para obtener detalles sobre comandos específicos, incluida la sintaxis y los ejemplos, haga clic en el comando específico para ir a su página de referencia.

Sintaxis del comando

Cuando ejecutas un comando de base de datos, especificas el comando como un documento para db.runCommand(). La clave del documento es el comando a ejecutar, y el valor se suele proporcionar como 1. El valor no afecta el resultado del comando, por ejemplo:

db.runCommand( { hello: 1 } )

Comandos de usuario

Comandos de Agregación

Nombre	Descripción	Soporte de MongoDB Atlas
`aggregate`	Realiza tareas de agregación como `$group` mediante un pipeline de agregación.	Soporte limitado para los clústeres Free y Flex.
`count`	Cuenta la cantidad de documentos en una colección o una vista.	Soporte limitado para los clústeres Free y Flex.
`distinct`	Muestra los valores distintos encontrados para una clave especificada en una colección o una vista.	Soporte limitado para los clústeres Free y Flex.
`mapReduce`	Realiza una agregación map-reduce para grandes conjuntos de datos.	No hay soporte para clústeres Free y Flex.

Comandos de operaciones de query y escritura

Nombre	Descripción	Soporte de MongoDB Atlas
`delete`	Borra uno o más documentos.	Sí
`find`	Selecciona documentos en una colección o una vista.	Soporte limitado para los clústeres Free y Flex.
`findAndModify`	Devuelve y modifica un solo documento.	Sí
`insert`	Inserta uno o más documentos.	Sí
`update`	Actualiza uno o más documentos.	Sí

Comandos de caché del plan del query

Nombre	Descripción	Soporte de MongoDB Atlas
`planCacheClear`	Elimina los planes del query almacenados en caché de una colección.	No hay soporte para clústeres Free y Flex.
`planCacheClearFilters`	Elimina los filtros de índice de una colección.	No hay soporte para clústeres Free y Flex.
`planCacheListFilters`	Lista los filtros de índice para una colección.	No hay soporte para clústeres Free y Flex.
`planCacheSetFilter`	Establece un filtro de índice para una colección.	No hay soporte para clústeres Free y Flex.

Operaciones de bases de datos

Comandos de autenticación

Nombre	Descripción	Soporte de MongoDB Atlas
`authenticate`	Inicia una sesión autenticada con un nombre de usuario y una contraseña.	No hay soporte para clústeres Free y Flex.
`logout`	Termina la sesión autenticada actual.	Sí

Comandos de gestión de usuarios

Nombre	Descripción	Soporte de MongoDB Atlas
`createUser`	Crea un nuevo usuario.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`dropAllUsersFromDatabase`	Borra a todos los usuarios asociados con una base de datos.	No hay soporte para clústeres Free y Flex.
`dropUser`	Remueve a un solo usuario.	No hay soporte para clústeres M10.
`grantRolesToUser`	Otorga un rol y sus privilegios a un usuario.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`revokeRolesFromUser`	Remueve un rol de un usuario.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`updateUser`	Actualiza los datos de un usuario.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`usersInfo`	Devuelve información sobre los usuarios especificados.	Soporte limitado para los clústeres Free y Flex.

Comandos de gestión de roles

Nombre	Descripción	Soporte de MongoDB Atlas
`createRole`	Crea un rol y especifica sus privilegios.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`dropRole`	Borra el rol definido por el usuario.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`dropAllRolesFromDatabase`	Borra todos los roles definidos por el usuario de una base de datos.	No hay soporte para clústeres Free y Flex.
`grantPrivilegesToRole`	Asigna privilegios a un rol definido por un usuario.	No hay soporte para clústeres Free y Flex.
`grantRolesToRole`	Especifica los roles de los cuales un rol definido por el usuario hereda privilegios.	No hay soporte para clústeres Free y Flex.
`invalidateUserCache`	Vacía la caché en memoria de la información del usuario, incluidas las credenciales y los roles.	No hay soporte para clústeres Free y Flex.
`revokePrivilegesFromRole`	Remueve los privilegios especificados de un rol definido por el usuario.	No hay soporte para clústeres Free y Flex.
`revokeRolesFromRole`	Elimina los roles heredados especificados de un rol definido por el usuario.	No hay soporte para clústeres Free y Flex.
`rolesInfo`	Devuelve información para el rol o roles especificados.	Sí
`updateRole`	Actualiza un rol definido por un usuario.	No hay soporte para clústeres Flex, Free, y clústeres M10.

Comandos de replicación

Nombre	Descripción	Soporte de MongoDB Atlas
`appendOplogNote`	Guarda una entrada no operativa en el oplog.	No hay soporte para clústeres Free y Flex.
`applyOps`	Comando interno que aplica entradas de oplog al conjunto de datos actual.	Sí
`hello`	Muestra información sobre el rol de este nodo en el set de réplicas, incluido si es el primario.	Sí
`replSetAbortPrimaryCatchUp`	Obliga al primario elegido a anular la sincronización (ponerse al día) y completar la transición al primario.	Sí
`replSetFreeze`	Impide que el nodo actual busque la elección como primario por un período.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`replSetGetConfig`	Devuelve el objeto de configuración del set de réplicas.	No hay soporte para clústeres Free y Flex.
`replSetGetStatus`	Devuelve un documento que informa sobre el estado del set de réplicas.	No hay soporte para clústeres Free y Flex.
`replSetInitiate`	Inicializa un nuevo set de réplicas.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`replSetMaintenance`	Activa o desactiva un modo de mantenimiento, que coloca un nodo secundario en un estado `RECOVERING`.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`replSetReconfig`	Aplica una nueva configuración a un set de réplicas existente.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`replSetResizeOplog`	Redimensiona dinámicamente el oplog para un nodo del set de réplicas. Disponible solo para el motor de almacenamiento WiredTiger.	No hay soporte para clústeres M10.
`replSetStepDown`	Hace que el primario actual descienda y se convierta en secundario, y genera una elección a la fuerza.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`replSetSyncFrom`	Anular explícitamente la lógica por defecto para seleccionar un nodo desde el cual replicar.	No hay soporte para clústeres Flex, Free, y clústeres M10.

Tip

Replicación para obtener más información sobre la replicación.

Comandos de particionado

Nombre	Descripción	Soporte de MongoDB Atlas
`addShard`	Agrega una partición a un clúster particionado.	Sí
`addShardToZone`	Asocia un fragmento con una zona. Admite la configuración de zonas en clústeres particionados.	Sí
`analyzeShardKey`	Calcula métricas para evaluar una clave de partición. Nuevo en la versión 7.0.	Sí
`balancerCollectionStatus`	Devuelve información sobre si los fragmentos de una colección particionada están equilibrados.	Sí
`balancerStart`	Inicia un hilo del balanceador.	Sí
`balancerStatus`	Devuelve información sobre el estado del balanceador.	Sí
`balancerStop`	Detiene el hilo del balanceador.	Sí
`checkMetadataConsistency`	Realiza una serie de verificaciones de coherencia en los metadatos particionados. Nuevo en la versión 7.0.	Sí
`clearJumboFlag`	Desactiva la bandera `jumbo` para un fragmento.	Sí
`cleanupOrphaned`	Elimina datos huérfanos con valores de clave de fragmento fuera de los rangos de los fragmentos que posee un fragmento.	No hay soporte para clústeres M,0 M2 y M.5
`cleanupReshardCollection`	Limpia una operación de redistribución fallida.	Sí
`commitReshardCollection`	Ejecuta una operación de repartición a la fuerza para bloquear escrituras y completarse.	Sí
`configureCollectionBalancing`	Configura los ajustes del balanceador en una colección particionada.	Sí
`configureQueryAnalyzer`	Configura el muestreo de query para una colección. Nuevo en la versión 7.0.	Sí
`enableSharding`	Crea una base de datos.	Sí
`flushRouterConfig`	Obliga a una instancia de `mongod` / `mongos` a actualizar sus metadatos de enrutamiento en caché.	Sí
`getShardMap`	Comando interno que informa sobre el estado de un clúster particionado.	No hay soporte para clústeres Free y Flex.
`isdbgrid`	Verifique que un proceso sea un `mongos`.	Sí
`listShards`	Devuelve una lista de particiones configuradas.	Sí
`moveChunk`	Comando interno que migra fragmentos entre particiones.	Sí
`movePrimary`	Reasigna el Fragmento primario al remover un fragmento de un clúster.	Sí
`moveRange`	Mueve rangos entre particiones.	Sí
`mergeAllChunksOnShard`	Fusiona todos los fragmentos fusionables que una partición posee para una colección determinada.	Sí
`mergeChunks`	Ofrece la capacidad de combinar fragmentos en una única partición.	Sí
`refineCollectionShardKey`	Refina la clave de fragmentación de una colección añadiendo un sufijo a la clave existente.	No hay soporte para clústeres M10.
`removeShard`	Inicia el proceso de remover una partición de un clúster.	No hay soporte para clústeres M10.
`removeShardFromZone`	Remueve la asociación entre una partición y una zona. Admite la configuración de zonas en clústeres particionados.	Sí
`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.	Sí
`setAllowMigrations`	Impide nuevas migraciones automáticas en una colección.	Sí
`shardCollection`	Habilita la funcionalidad de fragmentación para una colección, permitiendo que la colección sea fragmentada.	Sí
`shardingState`	Informa si el `mongod` es miembro de un clúster particionado.	Sí
`split`	Crea un nuevo fragmento.	Sí
`unsetSharding`	Eliminado en MongoDB 5.0. Comando interno que afecta las conexiones entre instancias en una implementación de MongoDB.	Sí
`updateZoneKeyRange`	Agrega o remueve la asociación entre un rango de datos particionados y una zona. Admite la configuración de zonas en clústeres particionados.	Sí

Tip

Elige Particionado para obtener más información sobre la funcionalidad de particionado de MongoDB.

Comandos de sesión

Comando	Descripción	Soporte de Atlas
`abortTransaction`	Abortar la transacción.	Sí
`commitTransaction`	Confirmación de la transacción.	Sí
`endSessions`	Finalice las sesiones antes del período de tiempo de espera de las sesiones.	Sí
`killAllSessions`	Elimine todas las sesiones.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`killAllSessionsByPattern`	Elimine todas las sesiones que coincidan con el patrón especificado	No hay soporte para clústeres Free y Flex.
`killSessions`	Eliminar las sesiones especificadas.	No hay soporte para clústeres Free y Flex.
`refreshSessions`	Actualizar las sesiones inactivas.	Sí
`startSession`	Empieza una sesión nueva.	Sí

Comandos de administración

Nombre	Descripción	Soporte de MongoDB Atlas
`cloneCollectionAsCapped`	Copia una colección no limitada como una nueva colección con tamaño fijo.	No hay soporte para clústeres Free y Flex.
`collMod`	Agrega opciones a una colección o modifica una definición de vista.	Sí
`compact`	Desfragmenta una colección y reconstruye los índices.	No hay soporte para clústeres Free y Flex.
`compactStructuredEncryptionData`	Compacta los documentos especificados en las colecciones estatales y borra los documentos redundantes.	Sí
`convertToCapped`	Convierte una colección no limitada en una colección con tamaño fijo.	Sí
`create`	Crea una colección o una vista.	Sí
`createIndexes`	Compila uno o más índices para una colección.	Sí
`currentOp`	Devuelve un documento que contiene información sobre las operaciones en curso para la instancia de base de datos.	Sí
`drop`	Remueve la colección especificada de la base de datos.	Sí
`dropDatabase`	Remueve la base de datos actual.	Sí
`dropConnections`	Descarta las conexiones salientes a la lista especificada de hosts.	Sí
`dropIndexes`	Borra índices de una colección.	Sí
`filemd5`	Obsoleto. Devuelve el hash md5 para los archivos almacenados mediante GridFS.	Sí
`fsync`	Vacía las escrituras pendientes en la capa de almacenamiento y bloquea la base de datos para permitir las copias de seguridad.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`fsyncUnlock`	Desbloquea un bloqueo de fsync.	No hay soporte para clústeres Free y Flex.
`getDefaultRWConcern`	Recupera las opciones globales de lectura y el nivel de confirmación de escritura por defecto para la implementación.	Sí
`getClusterParameter`	Recupera los valores de los parámetros del clúster de todos los nodos en un clúster. Novedades en la versión 6.0.	Sí
`getParameter`	Retrieves configuration options.	Soporte limitado para los clústeres Free y Flex.
`killCursors`	Elimina los cursores especificados de una colección.	Sí
`killOp`	Finaliza una operación según lo especificado por el ID de la operación.	Soporte limitado para Free, M10, y clústeres Flex.
`listCollections`	Devuelve una lista de colecciones en la base de datos actual.	Sí
`listDatabases`	Devuelve un documento que enumera todas las bases de datos y proporciona estadísticas básicas de las bases de datos.	Sí
`listIndexes`	Enumera todos los índices de una colección.	Sí
`logRotate`	Rota los registros de MongoDB para evitar que un único archivo ocupe demasiado espacio.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`reIndex`	Reconstruye todos los índices de una colección.	No hay soporte para clústeres Free y Flex.
`renameCollection`	Cambia el nombre de una colección existente.	Sí
`rotateCertificates`	Realiza la rotación en linea de certificados TLS.	Sí
`setFeatureCompatibilityVersion`	Habilita o deshabilita las características que persisten en los datos que son incompatibles con versiones anteriores.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`setIndexCommitQuorum`	Cambia el número mínimo de miembros que contienen datos (es decir, el quórum de confirmación), incluido el primario, que deben votar para confirmar una creación de índices en curso antes de que el primario marque esos índices como listos.	Sí
`setClusterParameter`	Modifica las opciones de configuración para todos los nodos en un set de réplicas o clúster particionado. Novedades en la versión 6.0.	Sí
`setParameter`	Modifica las opciones de configuración.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`setUserWriteBlockMode`	Bloquea y desbloquea las operaciones de guardado en todo el clúster.	No
`setDefaultRWConcern`	Establece las opciones globales de lectura y el nivel de confirmación de escritura por defecto para la implementación.	Sí
`shutdown`	Apaga el proceso `mongod` o `mongos`.	No hay soporte para clústeres Flex, Free, y clústeres M10.
`validateDBMetadata`	Verifica si los metadatos almacenados de una base de datos o una colección son válidos en una versión específica de la API.	Sí

Comandos de diagnóstico

Nombre	Descripción	Soporte de MongoDB Atlas
`buildInfo`	Muestra estadísticas sobre la compilación de MongoDB.	Sí
`collStats`	Informa sobre las estadísticas de utilización de almacenamiento para una colección especificada.	Sí
`connPoolStats`	Informa estadísticas sobre las conexiones salientes desde esta instancia de MongoDB a otras instancias de MongoDB en la implementación.	Sí
`connectionStatus`	Informa sobre el estado de autenticación de la conexión actual.	Sí
`dataSize`	Devuelve el tamaño de los datos para un rango de datos. Para uso interno.	No hay soporte para clústeres Free y Flex.
`dbHash`	Devuelve el valor hash de una base de datos y sus colecciones.	No hay soporte para clústeres Free y Flex.
`dbStats`	Informa sobre las estadísticas de utilización del almacenamiento para la base de datos especificada.	Soporte limitado para los clústeres Free y Flex.
`explain`	Devuelve información sobre la ejecución de varias operaciones.	Sí
`getCmdLineOpts`	Devuelve un documento con los argumentos de tiempo de ejecución a la instancia de MongoDB y sus opciones analizadas.	Sí
`getLog`	Devuelve los mensajes de registro recientes.	Sí
`hostInfo`	Devuelve datos que reflejan el sistema subyacente del host.	No hay soporte para clústeres Free y Flex.
`listCommands`	Enumera todos los comandos de base de datos proporcionados por la instancia actual de `mongod`.	Sí
`lockInfo`	Comando interno que devuelve información sobre bloqueos que están actualmente en retención o pendientes. Solo está disponible para instancias de `mongod`.	No hay soporte para clústeres Free y Flex.
`ping`	Comando interno que comprueba la conectividad entre implementaciones.	Sí
`profile`	Interfaz para el perfilador de base de datos.	Sí
`serverStatus`	Devuelve una colección de métricas sobre la utilización y el estado de los recursos a nivel de instancia.	Sí
`shardConnPoolStats`	Eliminado en MongoDB 5.0. Utilice `connPoolStats` en lugar de.	Sí
`top`	Devuelve estadísticas de uso sin procesar para cada base de datos en la instancia de `mongod`.	Sí
`validate`	Comando interno que escanea los datos e índices de una colección para verificar su corrección.	No hay soporte para clústeres Free y Flex.
`whatsmyuri`	Comando interno que devuelve información sobre el cliente actual.	Sí

Comandos de auditoría

Nombre	Descripción	Soporte de MongoDB Atlas
`getAuditConfig`	Recupera configuraciones de auditar de las instancias de `mongod` y `mongos`.	No
`logApplicationMessage`	Publica un mensaje personalizado en el registro de auditoría.	Sí
`setAuditConfig`	Establece configuraciones de auditoría para las instancias `mongod` y `mongos` en tiempo de ejecución.	No

Comandos de búsqueda de Atlas

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

Nombre	Descripción
`createSearchIndexes`	Crea uno o más índices de búsqueda Atlas en una colección específica.
`dropSearchIndex`	Elimina un índice de búsqueda de Atlas existente.
`updateSearchIndex`	Actualiza un índice de Atlas Search existente.

Volver

Ejemplos

Caché del plan del query