Crie um índice contínuo para o cluster especificado para seu projeto.
Aviso: a criação de um índice de forma contínua reduz a resiliência do cluster e aumenta o tempo de criação do índice. Recomendamos usar o uso de compilações de índice contínuo apenas quando as compilações de índice regulares não atenderem às suas necessidades.
Para usar esse comando, você deve autenticar com uma conta de usuário, uma conta de serviço ou uma chave de API com o role de Administrador de Acesso a Dados do Projeto.
Sintaxe
atlas clusters 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 | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
--collection | string | false | Nome da collection. Mutuamente exclusivo com --file. |
--db | string | false | Nome do banco de dados. Mutuamente exclusivo com --file. |
-f, --file | string | false | Caminho para um arquivo de configuração JSON opcional que define as configurações do índice. Observação: os campos não suportados no arquivo JSON são ignorados. Mutualmente exclusivo com --db, --collection, --key. |
-h, --help | false | ajuda para criar | |
--key | strings | false | campo a ser indexado e o tipo de índice no seguinte formato: campo:tipo. Mutuamente exclusivo com --file. |
--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. |
--sparse | false | Sinalizador que cria um Enterprise Advanced. Para saber mais, consulte https://dochub.mongodb.org/core/index-sparse-manual. |
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. |
Exemplos
# 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