compact

項目一覧

定義

互換性
構文
コマンドフィールド
compact 必要な特権
動作
例

定義

compact: コレクション内のすべてのデータとインデックスを書き換えてデフラグします。 WiredTiger データベースでは、このコマンドは不要なディスク領域をオペレーティングシステムにリリースします。

互換性

このコマンドは、次の環境でホストされている配置で使用できます。

MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージドサービスです

重要

このコマンドは、M 0 、M 2 、M 5クラスターではサポートされていません。詳細については、「サポートされていないコマンド」を参照してください。

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

このコマンドの構文は、次のとおりです。

db.runCommand(
   {
     compact: <collection name>
   }
)

コマンドフィールド

このコマンドは、次のフィールドを使用します。

フィールド	タイプ	説明
`compact`	string	コレクションの名前。
`force`	flag	任意。指定すると、レプリカセット内のプライマリで `compact` が強制的に実行されます。`compact`は、圧縮中のデータベース上のMongoDB CRUD 操作をブロックしません。
`comment`	any	任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。 `attr.command.cursor.comment` フィールド内のmongod ログメッセージ。 `command.comment` フィールドのデータベースプロファイラー出力。 `command.comment` フィールドの`currentOp`出力。コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。

`compact` 必要な特権

認証を強制するクラスターの場合、対象のコレクションで compact アクションの特権を持つユーザーとして認証を受ける必要があります。dbAdmin ロールは、システム以外のコレクションに対して compact を実行するために必要な権限を提供します。

システムコレクションの場合は、次の操作を行う必要があります。

システムコレクションでの compact アクションを許可するカスタムロールを作成します。
そのロールを新規または既存のユーザーに付与します。
そのユーザーとして認証を受け、compact コマンドを実行します。

例として、以下の操作では、指定されたデータベースとコレクションに対して compact アクションの権限を付与するカスタムロールが作成されます。

use admin
db.createRole(
  {
    role: "myCustomCompactRole",
    privileges: [
      {
        resource: { "db" : "<database>" , "collection" : "<collection>" },
        actions: [ "compact" ]
      }
    ],
    roles: []
  }
)

resourceドキュメントの構成の詳細については、自己管理型配置に関するリソースドキュメントを参照してください。

既存のユーザーに dbAdmin またはカスタムロールを付与するには、 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 を実行するには

セカンダリノードを圧縮します。

セカンダリノードの一つで compact を実行します。compact が終了したら、残りのセカンダリのそれぞれに対して順に操作を繰り返します。

プライマリノードを再度割り当てます。

現在のプライマリノードを解任して選挙をトリガーするには、 rs.stepDown() メソッドを使用します。特定のセカンダリノードを指名するには、ノードの優先順位を調整します。

古いプライマリを圧縮します。

解任後、旧プライマリノードはセカンダリノードになります。旧プライマリ・ノードで compact を実行します。。

セカンダリノードのバージョン固有の考慮事項

セカンダリノードは compact の実行中でも複製できます。
読み取りは許可されています。

compactコマンドの実行中、レプリカセットはSECONDARYステータスのままになります。

レプリカセットのノードの状態の詳細については、レプリカセットノードの状態を参照してください。

レプリカセットのメンテナンスと可用性については、自己管理型レプリカセットメンバーのメンテナンスの実行を参照してください。

シャーディングされたクラスター

compact mongod インスタンスにのみ適用されます。シャーディングされた環境では、メンテナンス操作として各シャードで compact を個別に実行します。

mongos インスタンスに対して compact を発行することはできません。

インデックス構築

compact 操作の後、mongod ですべてのインデックスが並列に再構築されます。

例

次の操作では movies コレクションに対して compact コマンドを実行します。

db.runCommand( { compact: "movies" } )

compact を実行すると、次のような出力が返されます。

{ bytesFreed: 27859, ok: 1 }

戻る

collMod

compactStructuredEncryptionData

定義

互換性

重要

構文