Definição
compactRecompõe e desfragmenta todos os dados e índices em uma collection. Em bancos de dados WiredTiger , este comando liberará espaço em disco desnecessário para o sistema operacional.
Compatibilidade
Esse comando está disponível em implantações hospedadas nos seguintes ambientes:
MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem
Importante
Esse comando não é suportado em clusters M0 e Flex. Para obter mais informações, consulte Comandos não suportados.
MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB
Sintaxe
O comando tem a seguinte sintaxe:
db.runCommand( { compact: <collection name> } )
Campos de comando
O comando utiliza os seguintes campos:
Observação
Começando no MongoDB 4.2
O MongoDB remove o mecanismo storage engine MMAPv1 e as opções específicas de MMAPv1 paddingFactor, paddingBytes, preservePadding para compact.
Campo | Tipo | Descrição |
|---|---|---|
| string | O nome da collection. |
| flag | Opcional. A partir da v,4.4 se especificado, força a A partir de v4.4, |
| any | Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais:
Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc). |
compact Privilégios necessários
Para clusters que impõem autenticação, você deve se autenticar como usuário com a ação de privilégio compact na collection de destino. A função dbAdmin fornece os privilégios necessários para executar compact em collection que não são do sistema.
Para obter mais informações sobre como configurar o documento resource , consulte Documento de recursos sobre implantações autogerenciadas.
Para adicionar o dbAdmin ou o custom role para um usuário existente, utilize db.grantRolesToUser() ou db.updateUser(). A seguinte operação concede o custom compact role para o myCompactUser no banco de dados do admin:
use admin db.grantRolesToUser("myCompactUser", [ "dbAdmin" | "myCustomCompactRole" ] )
Para adicionar o dbAdmin ou o papel personalizado para um novo usuário, especifique o papel para a array roles do método db.createUser() ao criar o usuário.
use admin db.createUser( { user: "myCompactUser", pwd: "myCompactUserPassword", roles: [ { role: "dbAdmin", db: "<database>" } | "myCustomCompactRole" ] } )
Comportamento
Monitoramento do progresso
Para verificar o progresso da operação compact, monitore o arquivo de registro mongod ou execute db.currentOp() em outra instância do shell.
Encerramento da operação
Se você encerrar compact com o método db.killOp() ou reiniciar o servidor antes do término da operação, compact será encerrado e poderá falhar na tentativa de liberar espaço em disco de volta para o sistema operacional.
Espaço em disco
O comando compact tenta reduzir o espaço em disco consumido para dados e índices em uma collection liberando blocos obsoletos de volta para o sistema operacional. A eficácia do compact é relativa a quantos blocos estão disponíveis para serem liberados e onde estão os blocos no arquivo de dados .
Para ver como o espaço de armazenamento muda na collection, execute o collStats comando antes e depois da compactação. Você pode usar a métrica collStats.freeStorageSize de saída para visualizar a quantidade de armazenamento disponível para reutilização.
A operação é iterativa e opera em segmentos do arquivo de dados em cada passagem. Para visualizar uma estimativa de quanto espaço o compact liberará, use a bandeira dryRun. Chamar compact em uma collection compactará a collection e seus índices associados.
compact podem exigir espaço em disco adicional para serem executados.
Conjuntos de réplicas
Você pode usar compact em collections e índices armazenados em um replica set, mas há algumas considerações importantes:
O nó primário não replica o comando
compactpara os secundários.Você deve executar
compactem nós secundários sempre que possível. Se você não puder executarcompactnos secundários, consulte a opção force.Começando no MongoDB 6.1.0 (e 6.0.2):
Um nó secundário pode replicar enquanto
compactestiver em execução.Leituras permitidas.
Para executar compact em um cluster
Reatribuir o nó primário.
Para descer o primário atual e acionar uma eleição, utilize o método rs.stepDown(). Para indicar um nó secundário específico, ajuste a prioridade do membro.
Considerações Específicas de Versão para Nós Secundários
O comportamento de bloqueio em nós secundários é específico da versão.
Versão | Comportamento de bloqueio |
4.4 |
|
Postar 4.4.17, 5.0.12 e 6.0.2 |
|
Enquanto o comando compact estiver em execução, o conjunto de réplicas permanecerá em um status SECONDARY.
Para obter mais informações sobre os estados membros do conjunto de réplicas, consulte Estados membros do conjunto de réplicas.
Para manutenção e disponibilidade do conjunto de réplicas, consulte Executar manutenção em membros do conjunto de réplicas autogerenciadas.
Clusters fragmentados
compact só se aplica a instâncias mongod . Em um ambiente fragmentado, execute compact em cada shard separadamente como uma operação de manutenção.
Você não pode emitir compact em relação a uma instância mongos .
Construção de Índices
mongod reconstrói todos os índices em paralelo após a operação compact .