compact
定義
互換性
このコマンドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
重要
このコマンドは、M 0 、M 2 、M 5クラスターではサポートされていません。 詳細については、「サポートされていないコマンド 」を参照してください。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
構文
このコマンドの構文は、次のとおりです。
db.runCommand( { compact: <string>, dryRun: <boolean>, force: <boolean>, // Optional freeSpaceTargetMB: <int>, // Optional comment: <any>, // Optional } )
コマンドフィールド
このコマンドは、次のフィールドを使用します。
フィールド | タイプ | 説明 |
|---|---|---|
compact | string | コレクションの名前。 |
dryRun | ブール値 | バージョン8.0の新機能。 有効にすると、 デフォルト: False |
force | ブール値 | バージョン 4.4 で変更。 オプション。有効にすると、レプリカセット内のプライマリで |
freeSpaceTargetMB | 整数 | 任意。 圧縮を続行するために回復可能な必要があるストレージ領域の最小量をメガバイト単位で指定します。 デフォルト：20 |
comment | any | 任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。
コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。 |
compact 必要な特権
認証を強制するクラスターの場合、対象のコレクションで compact アクションの特権を持つユーザーとして認証を受ける必要があります。dbAdmin ロールと hostManager ロールは、システム以外のコレクションに対して compact を実行するために必要な権限を提供します。
システム コレクションの場合は、次の操作を行う必要があります。
システム コレクションでの
compactアクションを許可するカスタムロールを作成します。そのロールを新規または既存のユーザーに付与します。
そのユーザーとして認証を受け、
compactコマンドを実行します。
例として、以下の操作では、指定されたデータベースとコレクションに対して compact アクションの権限を付与するカスタムロールが作成されます。
use admin db.createRole( { role: "myCustomCompactRole", privileges: [ { resource: { "db" : "<database>" , "collection" : "<collection>" }, actions: [ "compact" ] } ], roles: [] } )
resourceドキュメントの構成の詳細については、 自己管理型配置に関するリソース ドキュメント を参照してください。
既存のユーザーに dbAdmin、hostManager、またはカスタムロールを付与するには、db.grantRolesToUser() または db.updateUser() を使用します。次の操作では、admin データベース上の myCompactUser にカスタムロール compact が付与されます。
use admin db.grantRolesToUser("myCompactUser", [ "dbAdmin" | "myCustomCompactRole" ] )
新規ユーザーに dbAdmin またはカスタムロールを付与するには、ユーザーの作成時に db.createUser() メソッドの roles 配列でロールを指定します。
use admin db.createUser( { user: "myCompactUser", pwd: "myCompactUserPassword", roles: [ { role: "dbAdmin", db: "<database>" } | "myCustomCompactRole" ] } )
動作
進行状況のモニタリング
compact 操作の進行状況を確認するには mongod ログファイルを監視するか、別の shell インスタンスから db.currentOp() を実行します。
操作の終了
db.killOp()メソッドを使用してcompactを終了するか、操作が完了する前にサーバーを再起動すると、 compactは終了し、ディスク領域をオペレーティング システムに解放しようとする際に失敗する可能性があります。
ディスクスペース
コレクションのストレージスペースの変化の推移を確認するには、圧縮の前後に collStats コマンドを実行します。
WiredTiger の compact では、コレクション内のデータとインデックスに必要なストレージ領域を削減し、不要なディスク領域をオペレーティング システムに解放しようと試みますこの操作の有効性はワークロードによって異なります。また、ディスク容量が復元されることはありません。このコマンドは、コレクションから大量のデータを削除し、それを置き換える予定がない場合に便利です。
compact WiredTiger データベースで実行するには追加のディスク領域が必要になる場合があります。
パフォーマンスに関する考慮事項
圧縮は定期的にデータベースをチェックポイントしますが、これは同期のオーバーヘッドにつながる場合があります。トラフィックの多いデータベースでは、バックアップの取得などの運用タスクが遅れたり、妨げられたりする可能性があります。予期せぬ混乱を避けるため、バックアップを取る前に圧縮を無効にしてください。
レプリカセット
レプリカセットに格納されているコレクションとインデックスに対して compact を使用できますが、いくつか重要な考慮事項があります。
compactコマンドはプライマリ ノードからセカンダリ ノードに複製されることはありません。可能な場合は常にセカンダリ ノードで
compactを実行する必要があります。セカンダリでcompactを実行できない場合は、強制オプションを参照してください。MongoDB 6.1.0 以降（および 6.0.2 と 5.0.12 でも同様）
セカンダリ ノードは
compactの実行中でも複製できます。読み取りは許可されています。
クラスター上で compact を実行するには
プライマリノードを再度割り当てます。
現在のプライマリ ノードを解任して選挙をトリガーするには、 rs.stepDown() メソッドを使用します。特定のセカンダリノードを指名するには、ノードの優先順位を調整します。
セカンダリノードのバージョン固有の考慮事項
セカンダリ ノードは
compactの実行中でも複製できます。読み取りは許可されています。
compactコマンドの実行中、レプリカセットはSECONDARYステータスのままになります。
レプリカセットのノードの状態の詳細については、レプリカセット ノードの状態を参照してください。
レプリカセットのメンテナンスと可用性については、 自己管理型レプリカセット メンバー のメンテナンスの実行 を参照してください。
シャーディングされたクラスター
compact mongod インスタンスにのみ適用されます。シャーディングされた環境では、メンテナンス操作として各シャードで compact を個別に実行します。
mongos インスタンスに対して compact を発行することはできません。
インデックス構築
compact 操作の後、mongod ですべてのインデックスが並列に再構築されます。
同時圧縮コマンドは許可されていない
同じコレクションで複数の compact コマンドを同時に実行しようとすると、MongoDB はエラーを返します。
例
コレクションの圧縮
次の操作では movies コレクションに対して compact コマンドを実行します。
db.runCommand( { compact: "movies" } )
{ bytesFreed: 27859, ok: 1 }
圧縮の推定
次の操作は、movies コレクションに対して compact コマンドの dry run を実行します。
db.runCommand( { compact: "movies", dryRun: true } )
{ estimatedBytesFreed: 27859, ok: 1 }