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

setFeatureCompatibilityVersion

必須

version に指定できる値は次のとおりです。

confirm

必須

機能の互換性の変更を確認し、操作を続行できるようにするには、true に設定します。

confirm パラメーターを省略するか、confirm を true 以外の値に設定すると、コマンドは失敗し、機能の互換性バージョンの変更に関する警告が返されます。

writeConcern

任意

writeConcern は書込み保証 (write concern) の wtimeout の値をミリ秒単位で指定します。

• プライマリが大多数のレプリカセット ノードからの確認を待機する時間です。時間内に確認応答が受信されない場合、操作は失敗します。

• デフォルトは 60000 ミリ秒です。レプリカセットのセカンダリ ノードの遅延が wtimeout のデフォルトを超える場合は、時間を長くします。

ryRun

任意

true に設定すると、 MongoDB は機能の互換性バージョンのアップグレードまたはダウングレードをシミュレートします。クラスターに互換性のないデータが含まれている場合、操作はエラーで失敗します。

上位互換性のないデータによるアップグレード

アップグレード バージョンに上位互換性のないデータが含まれているクラスターの 機能の互換性バージョン をアップグレードしようとすると、CannotUpgrade エラーを受領します。順方向互換性のないデータとは、ターゲット バージョンで削除された機能に依存しているクラスター内の任意のデータを指します。

このエラーが発生すると、 によって次のいずれかが実行されます。

• クラスター データを変更して上位互換性のない機能を削除し、アップグレード バージョンで setFeatureCompatibilityVersion コマンドを再実行して、機能の互換性バージョン をアップグレード バージョンに設定します。

• 元のダウングレード バージョンで setFeatureCompatibilityVersion コマンドを実行し、機能の互換性バージョン を元のバージョンに戻します。

  重要

  機能の互換性バージョン を元のバージョンに設定すると、アップグレード手順が停止し、機能の互換性バージョン がダウングレードされたバージョンに戻ります。クラスターは、機能の互換性バージョン のアップグレードが開始される前の状態に戻りません。

  機能の互換性バージョン アップグレードで、前方に互換性のないデータがないことが確認されたが、それ以外で停止または失敗した場合、その後の機能の互換性バージョンのダウングレードの試行もエラー メッセージで失敗します。機能の互換性バージョンをダウングレードする前に、機能の互換性バージョンのアップグレードを完了する必要があります。

下位互換性のないデータによるダウングレード

ダウングレード バージョンに下位互換性のないデータが含まれているクラスターの 機能の互換性バージョン をダウングレードしようとすると、CannotDowngrade エラーを受領します。下位互換性のないデータとは、ターゲット バージョンで利用できない機能に依存しているクラスター内の任意のデータを指します。

このエラーが発生すると、 によって次のいずれかが実行されます。

• クラスターデータを変更して下位互換性のない機能を削除し、ダウングレードされたバージョンで setFeatureCompatibilityVersion コマンドを再実行して、fCV をダウングレードされたバージョンに設定します。

• 元のアップグレード バージョンで setFeatureCompatibilityVersion コマンドを実行し、fCV を元のバージョンに戻します。

  重要

  Setting the 機能の互換性バージョン to the original version stops the downgrade procedure and reverts the 機能の互換性バージョン to the upgraded version. クラスターは、機能の互換性バージョン のダウングレードが開始される前の状態に戻りません。

  If the 機能の互換性バージョン ダウングレードで下位互換性のないデータがないことが確認されたにもかかわらず停止または失敗した場合、その後の 機能の互換性バージョン アップグレードの試行もエラーメッセージとともに失敗します。機能の互換性バージョンをアップグレードする前に、機能の互換性バージョンのダウングレードを完了する必要があります。

MongoDB 8.3 のダウングレード ポリシー

8.3 以降では、配置の 機能の互換性バージョン を直前のマイナー バージョンにダウングレードできます。

詳しくは、「 8.3から8.2へのダウングレード 」を参照してください。

バックグラウンド操作との競合

特定のバックグラウンド操作により、setFeatureCompatibilityVersion の実行が妨げられる可能性があります。実行中の操作を識別するには、currentOp を使用します。

同期の失敗

最初の同期中に 機能の互換性バージョン を変更した場合、oplog アプリケーション フェーズでエントリを繰り返すと、同期が失敗し、OplogOperationUnsupported エラーが表示される場合があります。操作フェーズで操作が繰り返されなくなるため、次の同期は成功します。

Default Values

べき等性

このコマンドは、内部システム コレクションへの書き込みを実行する必要があります。コマンドが正常に完了しない場合は、安全に再試行できます。操作は冪等です。

Cluster-to-Cluster Sync とユーザー書込み (write) ブロック

MongoDB 6.0 以降では、機能の互換性バージョンをダウングレードする必要がある場合は、クラスター間のレプリケーションとユーザー書込みブロックを無効にしてください。

1. クラスター間のレプリケーションを有効にしている場合は無効にします。

2. ユーザーに書込みブロックを有効にしている場合は、無効にします。

   db.runCommand( { setUserWriteBlockMode: 1, global: false } )

3. 前のコマンドが完了するまで待機します。

4. setFeatureCompatibilityVersion を使用して機能の互換性バージョンをダウングレードします。

MongoDB Cluster-to-Cluster Sync の詳細については、ドキュメントを参照してください。

アービタの機能互換性

アービタは admin.system.version コレクションを複製しません。このため、レプリカセットの fCV 値に関係なく、アービタは常にバイナリのダウングレード バージョンと同じ機能の互換性バージョンを使用します。

例、 MongoDB 5.0 クラスターのアービタの FCV 値は 4.4 です。

FeatureCompatibilityVersion の取得

mongod インスタンスの featureCompatibilityVersion を表示するには、mongod インスタンスで getParameter コマンドを実行します。

db.adminCommand(
   {
      getParameter: 1,
      featureCompatibilityVersion: 1
   }
 )

出力は次のようになります。

{
  featureCompatibilityVersion: { version: '5.0' },
  ok: 1,
  '$clusterTime': {
    clusterTime: Timestamp({ t: 1660318752, i: 5 }),
    signature: {
      hash: Binary(Buffer.from("ce0cff3621e9b089fa6d8e9a1e1efc1a1ff15dab", "hex"), 0),
      keyId: Long("7129893797260951557")
    }
  },
  operationTime: Timestamp({ t: 1660318752, i: 5 })
}

MongoDB 8.0 で機能の互換性バージョンを設定する配置

db.adminCommand(
   {
      setFeatureCompatibilityVersion: "8.0",
      confirm: true
   }
)

db.adminCommand(
   {
      setFeatureCompatibilityVersion: "7.0",
      confirm: true
   }
)

MongoDB 7.0 配置で機能の互換性バージョンを設定する

db.adminCommand(
   {
      setFeatureCompatibilityVersion: "7.0",
      confirm: true
   }
)

db.adminCommand(
   {
      setFeatureCompatibilityVersion: "6.0",
      confirm: true
   }
)

書込み保証 (write concern) タイムアウトの設定

次の例では、任意の書込み保証 (write concern) の wtimeout フィールドを 5000（5 秒）に設定しています。

db.adminCommand( {
   setFeatureCompatibilityVersion: "5.0",
   writeConcern: { wtimeout: 5000 }
} )