Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / /

cluster do Atlas onlineArchives criar

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Exemplos

Crie um Atlas Online Archive para uma collection no cluster especificado.

Você pode criar um arquivo on-line para um cluster M10 ou maior.

Para saber mais sobre arquivos online, consulte https://www.mongodb.com/pt-br/docs/atlas/online-archive/manage-online-archive/.

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 do comando
atlas clusters onlineArchives create [options]
Nome
Tipo
Obrigatório
Descrição
--archiveAfter
int
false

Número de dias após os quais arquivar dados do cluster.

Mutuamente exclusivo com --file.

--clusterName
string
true
--collection
string
false

Nome da collection.

Mutuamente exclusivo com --file.

--dateField
string
false

Nome de um campo de data já indexado dos documentos.

Mutuamente exclusivo com --file.

--dateFormat
string
false

Formato de data para o campo de data. Os valores válidos são "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS" ou "EPOCH_NANOSECONDS".

Mutually exclusive with --file. Este valor é padronizado para "ISODate".

--db
string
false

Nome do banco de dados.

Mutuamente exclusivo com --file.

--expireAfterDays
int
false

Número de dias usados nos critérios de data para indicar documentos para exclusão.

Mutuamente exclusivo com --file.

--file
string
false

Caminho para um arquivo de configuração JSON opcional que define as configurações do Atlas Online Archive . Para saber mais sobre Atlas Online Archive os arquivos de configuração do para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.

Mutuamente exclusivo com --db, --collection, --dateField, --dateFormat, --archiveAfter, --expireAfterDays, --partition.

-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.
--partition
strings
false

Campos a serem usados para dividir os dados. Você pode especificar até dois campos consultados com frequência separados por uma vírgula.

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.
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.
# Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster when the current date is greater than the value of released date plus 2 days:
atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --output json
# Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster using a profile named egAtlasProfile when the current date is greater than the value of the released date plus 2 days. Data is partitioned based on the title field, year field, and released field from the documents in the collection:
atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title,year --output json -P egAtlasProfile

Voltar

OnlineArchives