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 を元のバージョンに戻します。

  重要

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

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

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

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

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

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

Certain background operations may prevent execution of setFeatureCompatibilityVersion. Use currentOp to identify any ongoing operations.

同期の失敗

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

Default Values

べき等性

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

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

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

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

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

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

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

4. Downgrade the feature compatibility version using 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 }
} )