Docs Menu
Docs Home
/
開発
/
データベース コマンド
Docs Home
/
開発
/
データベース コマンド
Docs Home
/
開発
/
データベース コマンド

compact（データベースコマンド）

定義

compact

不要なディスク領域をオペレーティング システムに解放しようとします。

互換性

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

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

重要

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

  • 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の新機能。

有効にすると、 compactコマンドは、対象コレクションから圧縮によって再利用できる領域の推定値（バイト単位）を返します。 dryRunをtrueに設定してcompactを実行すると、MongoDB は推定値のみを返し、圧縮は実行しません。

デフォルト: False

force

ブール値

任意。有効にすると、レプリカセット内のプライマリで compact が強制的に実行されます。

freeSpaceTargetMB

整数

任意。 圧縮を続行するために回復可能な必要があるストレージ領域の最小量をメガバイト単位で指定します。

デフォルト：20

comment

any

任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。

コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。

注意

compact コマンドは、圧縮中のデータベース上のMongoDB CRUD操作をブロックしません。

compact 必要な特権

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

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

  1. システム コレクションでの compact アクションを許可するカスタムロールを作成します。

  2. そのロールを新規または既存のユーザーに付与します。

  3. そのユーザーとして認証を受け、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() を実行します。

操作の終了

compactdb.killOp()メソッドを使用して を終了するか、操作が完了する前にサーバーを再起動すると、compact は終了します。操作では、ディスク領域がオペレーティング システムに解放されない可能性があります。

ディスクスペース

compact コマンドは、廃止されたブロックをオペレーティング システムに解放することで、コレクション内のデータとインデックスのディスク領域を削減します。有効性は、リリース可能なブロックの数と、データファイル内のそのブロックの場所によって異なります。

コレクションのストレージ容量の変化を確認するには、圧縮の前後でcollStats コマンドを実行します。出力メトリクスcollStats.freeStorageSize を使用して、再利用可能なストレージの量を確認できます。

この操作は反復的であり、パスごとにデータファイルのセグメントに対して作業されます。 compact が解放するスペースの量を見積もるには、dryRun フラグを使用します。コレクションで compact を呼び出すと、コレクションとそれに関連するインデックスの両方が圧縮されます。

compact を実行するには追加のディスク領域が必要になる場合があります。

バックアップ

圧縮は定期的にデータベースをチェックポイントしますが、これは同期のオーバーヘッドにつながる場合があります。トラフィックの多いデータベースでは、バックアップの取得などの運用タスクが遅れたり、妨げられたりする可能性があります。予期せぬ混乱を避けるため、バックアップを取る前に圧縮を無効にしてください。

マルチシャードトランザクション

注意

配置でセカンダリ読み取りとマルチシャードトランザクションを使用している場合は、compact の代わりに最初の同期の実行を検討してください。

compact が実行されると、 WiredTiger は圧縮されたワークロードに対応するようにブロックマネージャー戦略を一時的に調整します。調整により、チェックポイント操作が遅くなり、ノードがトランザクションをコミットするのにかかる時間が長くなる可能性があります。トランザクション コミットの遅延が発生すると、大幅な 読み取りレイテンシ、レプリケーションラグ、 運用キューイング が発生する可能性があります。

レプリカセット

レプリカセット内のコレクションとインデックスに対して compact を使用できます。次の点を考慮してください。

  • compact コマンドはプライマリ ノードからセカンダリ ノードに複製されることはありません。

  • 可能な場合は常にセカンダリ ノードで を実行します。セカンダリで を実行できない場合は、 強制compactcompact オプションを参照してください。

  • MongoDB 6.1.0以降 （および6.0.2 ）:

    • セカンダリ ノードは compact の実行中でも複製できます。

    • 読み取りは許可されています。

クラスター上で compact を実行するには:

1

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

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

2

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

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

3

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

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

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

  • セカンダリ ノードは compact の実行中でも複製できます。

  • 読み取りは許可されています。

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

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

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

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

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

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

同時圧縮コマンドは許可されていない

同じコレクションで複数の compact コマンドを同時に実行しようとすると、MongoDB はエラーを返します。

例

注意

次の例には、アクティブなレプリカセットのプライマリに対して compact を実行する場合に必要な force: true が含まれています。force: true なしで compact を実行するには、まずプライマリをステップダウンします。詳細については、「レプリカセット」を参照してください。

コレクションの圧縮

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

db.runCommand( { compact: "movies", force: true } )
{ bytesFreed: "...", ok: 1 }

圧縮の推定

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

db.runCommand( {
   compact: "movies",
   dryRun: true,
   force: true
} )
{ estimatedBytesFreed: "...", ok: 1 }

詳細

戻る

collMod

次へ

compactStructuredEncryptionData

項目一覧