Arquivo de configuração do Atlas Online Archive

Nesta página

Configurações do Online Archive

Exemplo de Atlas Online Archive para criar arquivo de configuração
Exemplo de arquivo de configuração de atualização do Atlas Online Archive
Exemplo de comando de criação do Atlas Online Archive
Exemplo de comando de atualização do Atlas Online Archive

Você pode utilizar um arquivo de configuração para especificar as configurações necessárias para criar e atualizar um Atlas Online Archive utilizando o Atlas CLI. O Atlas CLI aceita arquivos de configuração do Atlas Online Archive .json .

Use os seguintes recursos para:

Aprenda asconfigurações necessárias do que você pode especificar no Atlas Online Archive
Visualize e copie arquivos de configuração de exemplo.

Configurações do Online Archive

Você pode especificar as seguintes configurações para criar ou atualizar um Atlas Online Archive no arquivo de configuração ou como sinalizadores no comando:

Campo	Tipo	Descrição
`groupId`	string	Identificador único do seu projeto. Seu `groupId` é o mesmo que seu `projectId`. Para grupos existentes, seu `groupId` e `projectId` permanecem os mesmos. O recurso e os endpoints correspondentes usam o termo grupos.
`archiveID`	string	String única de 24 dígitos hexadecimais que identifica o arquivo online que será atualizado.
`clusterName`	string	Etiqueta legível para humanos que identifica o cluster que contém a collection para a qual você deseja criar ou atualizar um Atlas Online Archive.
`collName`	string	O nome da sua collection.
`criteria`	objeto	Regras pelas quais o MongoDB Cloud arquiva dados.
`dbName`	string	Etiqueta legível por humanos do banco de dados que contém a collection que contém o arquivo online.

Para obter descrições detalhadas e uma lista completa das configurações disponíveis, consulte o esquema do corpo da solicitação na especificação da API:

Exemplo de Atlas Online Archive para criar arquivo de configuração

{
    "name":"myCluster",
    "groupId": "32y6e74b3g91947azb20e3b8",
    "collName": "myCollection",
    "collectionType": "TIMESERIES",
    "criteria": {
      "type": "DATE"
    },
    "dataExpirationRule": {
      "expireAfterDays": 7
    },
    "dataProcessRegion": {
      "cloudProvider": "AWS",
      "region": "US_EAST_1"
    },
    "dbName": "myDB",
    "partitionFields": [
      {
        "fieldName": "exampleField",
        "order": 0
      }
    ],
    
    "paused": true,
    "schedule": {
      "type": "DEFAULT"
    }
  }

Exemplo de arquivo de configuração de atualização do Atlas Online Archive

{
    "name":"myCluster",
    "groupId": "32y6e74b3g91947azb20e3b8",
    "archiveId":"32y6e74b3g32y6e74b3gyb45",
    "criteria": {
      "type": "DATE"
    },
    "dataExpirationRule": {
      "expireAfterDays": 7
    },
    "paused": true,
    "schedule": {
      "type": "DEFAULT"
    }
  }

Exemplo de comando de criação do Atlas Online Archive

Para criar uma configuração de Atlas Online Archive, especifique a opção --file e o caminho para o arquivo. O exemplo a seguir cria um Atlas Online Archive usando um arquivo de configuração chamado online-archive-create-config.json:

atlas clusters onlineArchive create --file online-archive-create-config.json --output json

Exemplo de comando de atualização do Atlas Online Archive

Para atualizar uma configuração do Atlas Online Archive, especifique a opção --file e o caminho para o arquivo. O exemplo a seguir atualiza um Atlas Online Archive usando um arquivo de configuração chamado online-archive-update-config.json:

atlas clusters onlineArchive update --file online-archive-update-config.json --output json

Voltar

Nós de pesquisa

Alerta