定義
setFeatureCompatibilityVersionEnables or disables the features that persist data incompatible with earlier versions of MongoDB. You can only issue the
setFeatureCompatibilityVersionagainst theadmindatabase.
To learn what the feature compatibility version is and how it supports downgrades, see MongoDB Versions and Upgrade Paths.
警告
下位互換性のないこうした機能を有効にすると、ダウングレード前に保持されていた下位互換性のない機能をすべて削除する必要があるため、ダウングレード プロセスが複雑になる場合があります。
ダウングレードの可能性を最小限に抑えるには、アップグレード後、バーンイン期間中にこれらの下位互換性のない機能を有効にせずに配置を運用することをお勧めします。ダウングレードの可能性を最小限に抑えられたと確信できたら、これらの機能を有効にします。
互換性
このコマンドは、次の環境でホストされている配置で使用できます。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
構文
バージョン7.0で変更。
このコマンドの構文は、次のとおりです。
db.adminCommand( { setFeatureCompatibilityVersion: <version>, confirm: true, writeConcern: { wtimeout: <timeout> } } )
コマンドフィールド
setFeatureCompatibilityVersion コマンドは、次のフィールドがあります。
setFeatureCompatibilityVersion
必須
version に指定できる値は次のとおりです。
バージョン | 説明 |
|---|---|
| MongoDB 7.0 配置で利用可能 |
| MongoDB 6.0 および 7.0 配置で利用可能 MongoDB 5.0と互換性のないデータを永続化する6.0機能を有効にします。 |
| MongoDB 5.0 および 6.0 の配置で利用可能 MongoDB 4.4と互換性のないデータを永続化する5.0機能を有効にします。 |
confirm
必須
バージョン7.0の新機能。
機能の互換性の変更を確認し、操作を続行できるようにするには、true に設定します。
confirm パラメーターを省略するか、confirm を true 以外の値に設定すると、コマンドは失敗し、機能の互換性バージョンの変更に関する警告が返されます。警告には、クラスターの fCV をアップグレードまたはダウングレードした後は、バイナリ バージョンをダウングレードするには、サポートによる支援が必要であることが記載されています。
writeConcern
任意
writeConcern は書込み保証 (write concern) の wtimeout の値をミリ秒単位で指定します。
プライマリが大多数のレプリカセット ノードからの確認を待機する時間です。時間内に確認応答が受信されない場合、操作は失敗します。
動作
下位互換性のないデータによるダウングレード
ダウンロードしたバージョンに互換性のないデータが含まれているクラスターの fCV をダウングレードしようとすると、CannotDowngrade エラーを受領します。このエラーが発生すると、クラスターは過渡的な downgrading 状態のままになります。
クラスターを downgrading 状態から移動するには、次のいずれかを実行します。
クラスターデータを変更して下位互換性のない機能を削除し、ダウングレードされたバージョンで
setFeatureCompatibilityVersionコマンドを再実行して、fCV をダウングレードされたバージョンに設定します。元のアップグレード バージョンで
setFeatureCompatibilityVersionコマンドを実行し、fCV を元のバージョンに戻します。重要
Setting the FCV to the original version stops the downgrade procedure and changes the FCV back to the upgraded version. This procedure does not reset the cluster back to the state before the FCV downgrade began.
失敗した fCV ダウングレードの内部メタデータがクリーンアップされない場合、次回の fCV のアップグレードの試行はエラーメッセージと共に失敗します。fCV のアップグレードを試す前に、fCV のダウングレードを完了する必要があります。
MongoDB 7.0 でのダウングレード ポリシーの変更
MongoDB 7.0 以降では、デプロイでの FCV を MongoDB の Rapid Release バージョンにダウングレードしたり、Rapid Release バージョンから任意のバージョンにダウングレードしたりすることはできません。
配置の FCv をアップグレードまたはダウングレードする場合、サポートの支援なしに配置のバイナリ バージョンをダウングレードすることはできません。
詳しくは、「7.0 から 6.0 へのダウングレード」を参照してください。
バックグラウンド操作との競合
Certain background operations may prevent execution of setFeatureCompatibilityVersion. Use currentOp to identify any ongoing operations.
同期の失敗
If you trigger a setFeatureCompatibilityVersion change during an initial sync, the sync may fail with an OplogOperationUnsupported error message when replaying entries on the oplog application phase. The sync following this attempt succeeds because the operation phase no longer replays the operation.
Default Values
配置 | featureCompatibilityVersion |
|---|---|
新しい 7.0 配置の場合 |
|
6.0からアップグレードされた 7.0 配置の場合 |
|
新しい 6.0 配置の場合 |
|
5.0 からアップグレードされた 6.0 配置の場合 |
|
べき等性
このコマンドは、内部システム コレクションへの書込みを実行する必要があります。何らかの理由でコマンドが正常に完了しない場合は、操作がべき等であるため、安全にコマンドを再試行できます。
Cluster-to-Cluster Sync とユーザー書込み (write) ブロック
MongoDB 6.0 以降では、機能の互換性バージョンをダウングレードする必要がある場合は、クラスター間のレプリケーションとユーザー書込みブロックを無効にしてください。
クラスター間のレプリケーションを有効にしている場合は無効にします。
ユーザーに書込みブロックを有効にしている場合は、無効にします。
db.runCommand( { setUserWriteBlockMode: 1, global: false } ) 前のコマンドが完了するまで待機します。
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 }) }
注意
mongos インスタンスでは操作が未定義です。
アクセス制御が有効になっているシャーディングされたクラスターでは、コマンドを実行するためにシャード ローカル ユーザーとしてシャードに接続する必要があります。
MongoDB 7.0 配置で機能の互換性バージョンを設定する
7.0 の下位互換性のない機能を有効にする
MongoDB 6.0 と互換性のないデータを保持する 7.0 の機能を有効にするには、MongoDB 7.0 配置で機能の互換性を "7.0" に設定します。
注意
Run the setFeatureCompatibilityVersion command against the admin database.
db.adminCommand( { setFeatureCompatibilityVersion: "7.0", confirm: true } )
7.0 の下位互換性のない機能を無効にする
MongoDB 6.0 と互換性のないデータを保持する 7.0 の機能を無効にするには、MongoDB 7.0 配置で機能の互換性を "6.0" に設定します。
注意
Run the setFeatureCompatibilityVersion command against the admin database.
スタンドアロンの場合は、スタンドアロンの
mongodインスタンスでコマンドを実行します。レプリカセットの場合は、プライマリでコマンドを実行します。データを保持するノードの過半数が利用可能である必要があります。
シャーディングされたクラスターの場合は、
mongosインスタンスでコマンドを実行します。
"6.0"featureCompatibilityVersion は、MongoDB 6.0 および MongoDB 7.0 の配置でのみサポートされます。
db.adminCommand( { setFeatureCompatibilityVersion: "6.0", confirm: true } )
MongoDB 7.0 から MongoDB 6.0 へのダウングレード プロセスの一部として実行する場合には、6.0 と互換性のないすべての永続機能も削除する必要があります。適切なダウングレード手順を参照してください。
MongoDB 6.0 配置で機能の互換性バージョンを設定する
6.0 の下位互換性のない機能を有効にする
MongoDB 5.0 と互換性のないデータを保持する 6.0 機能を有効にするには、 MongoDB 6.0 配置で機能の互換性を "6.0" に設定します。
注意
Run the setFeatureCompatibilityVersion command against the admin database.
db.adminCommand( { setFeatureCompatibilityVersion: "6.0" } )
6.0 の下位互換性のない機能を無効にする
MongoDB 5.0 と互換性のないデータを保持する 6.0 機能を無効にするには、 MongoDB 6.0 配置で機能の互換性を "5.0" に設定します。
注意
Run the setFeatureCompatibilityVersion command against the admin database.
スタンドアロンの場合は、スタンドアロンの
mongodインスタンスでコマンドを実行します。レプリカセットの場合は、プライマリでコマンドを実行します。データを保持するノードの過半数が利用可能である必要があります。
シャーディングされたクラスターの場合は、
mongosインスタンスでコマンドを実行します。
"5.0"featureCompatibilityVersion は、MongoDB 5.0 および MongoDB 6.0 の配置でのみサポートされます。
db.adminCommand( { setFeatureCompatibilityVersion: "5.0" } )
MongoDB 6.0 からMongoDB 5.0 へのダウングレード プロセスの一部として実行する場合には、5.0 と 互換性のない すべての永続機能も削除する必要があります。適切なダウングレード手順を参照してください。
書込み保証 (write concern) タイムアウトの設定
次の例では、任意の書込み保証 (write concern) の wtimeout フィールドを 5000(5 秒)に設定しています。
注意
Run the setFeatureCompatibilityVersion command against the admin database.
db.adminCommand( { setFeatureCompatibilityVersion: "5.0", writeConcern: { wtimeout: 5000 } } )
トラブルシューティング
If you experience startup issues after setting your feature compatibility version, contact MongoDB Support for assistance.