Crea un índice de búsqueda para un clúster.
Para usar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave de API con el rol de Administrador de acceso a los datos del Proyecto.
Sintaxis
atlas clusters search 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 aprender más, consulta https://dochub.mongodb.org/core/create-cluster-api. |
-f, --file | string | false | Nombre del archivo de configuración del índice JSON a utilizar. Para aprender sobre el archivo de configuración del índice de Atlas Search y Atlas búsqueda vectorial, consulta https://dochub.mongodb.org/core/search-index-config-file-atlascli. Para obtener información sobre la sintaxis e índices de búsqueda de Atlas que puede definir en su archivo de configuración, consulte https://dochub.mongodb.org/core/index-definitions-fts. Para aprender sobre la sintaxis y las opciones del índice Atlas búsqueda vectorial que puedes definir en tu archivo de configuración, consulta https://dochub.mongodb.org/core/index-definition-avs. |
-h, --help | false | ayuda para crear | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, usa la opción -o json. |
--projectId | string | false | string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.
Index <Name> created.
Ejemplos
# Create a search index for the cluster named myCluster using a JSON index configuration file named search-config.json: atlas clusters search indexes create --clusterName myCluster --file search-config.json --output json