Crie um índice de pesquisa para um cluster.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a função de "administrador de acesso a dados do projeto".
Sintaxe
atlas clusters search indexes create [indexName] [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
indexName | string | false | Nome do índice. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. |
-f, --file | string | false | Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. |
-h, --help | false | ajuda para criar | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Index <Name> created.
Exemplos
# 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