- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Cree un índice móvil para el clúster especificado para su proyecto.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Para utilizar este comando, debe autenticarse con una cuenta de usuario o una clave API con el rol de administrador de acceso a datos del proyecto.
Sintaxis
atlas clusters indexes create [indexName] [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
indexName | string | false | Nombre del índice. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--clusterName | string | true | Nombre del clúster. Para obtener más información, consulte https://dochub.mongodb.org/core/create-cluster-api. |
--collection | string | false | Nombre de la colección. Mutuamente excluyente con --file. |
--db | string | false | Nombre de la base de datos. Mutuamente excluyente con --file. |
-f, --file | string | false | Ruta a un archivo de configuración JSON opcional que define la configuración del índice. Nota: Los campos no admitidos en el archivo JSON se ignoran. Mutuamente excluyente con --db, --collection, --key. |
-h, --ayuda | false | ayuda para crear | |
--key | cadenas | false | Campo a indexar y el tipo de índice en el siguiente formato: campo:tipo. Mutuamente excluyente con --file. |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
--sparse | false | Marca que crea un índice disperso. Para obtener más información, consulte https://dochub.mongodb.org/core/index-sparse-manual. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
# Create an index named bedrooms_1 on the listings collection of the realestate database: atlas clusters indexes create bedrooms_1 --clusterName Cluster0 --collection listings --db realestate --key bedrooms:1
# Create a compound index named property_room_bedrooms on the listings collection of the realestate database: atlas clusters indexes create property_room_bedrooms --clusterName Cluster0 --collection listings --db realestate --key property_type:1 --key room_type:1 --key bedrooms:1
# Create an index named my_index from a JSON configuration file named myfile.json: atlas clusters indexes create my_index --clusterName Cluster0 --file file.json