atualização do índice de pesquisa do cluster do Atlas
Modificar um índice de pesquisa para um cluster.
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
Sintaxe do comando
atlas clusters search indexes update <indexId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
indexId | string | true | ID do índice. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
-f, --file | string | false | Nome do arquivo de configuração do índice JSON a ser usado. Para saber mais sobre o arquivo de configuração do índice Atlas Search e Atlas Vector Search, consulte https://dochub.mongodb.org/core/search-index-config-file-atlascli. Para saber mais sobre a sintaxe e as opções do índice do Atlas Search que você pode definir no arquivo de configuração, consulte https://dochub.mongodb.org/core/index-definitions-fts. Para saber mais sobre a sintaxe e as opções do índice do Atlas Vector Search que você pode definir em seu arquivo de configuração, consulte https://dochub.mongodb.org/core/index-definition-avs. |
-h, --help | false | ajuda para atualização | |
-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> updated.
Exemplos
# Modify the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster: atlas clusters search indexes update 5f2099cd683fc55fbb30bef6 --clusterName myCluster --output json