Listar todos os índice de pesquisa do Atlas Search para um cluster.
Para usar este comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Leitura/Gravação de Acesso a Dados do projeto.
Sintaxe
atlas clusters search indexes list [options]
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. |
--collection | string | true | Nome da collection. |
--db | string | true | Nome do banco de dados. |
-h, --help | false | ajuda para lista | |
-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.
ID NAME DATABASE COLLECTION TYPE <IndexID> <Name> <Database> <CollectionName> <Type>
Exemplos
# Return the JSON-formatted list of Atlas search indexes on the sample_mflix.movies database in the cluster named myCluster: atlas clusters search indexes list --clusterName myCluster --db sample_mflix --collection movies --output json