setClusterParameter
定義
setClusterParameter
setClusterParameter
は、クラスター パラメータの値を変更するための管理コマンドです。 クラスター パラメーターは、レプリカセットまたはシャーディングされたクラスター内のすべてのノードに影響する構成可能なパラメーターです。また、
admin
データベースに対してsetClusterParameter
コマンドを発行する必要があります。setClusterParameter
コマンドは自己管理型インストールでのみ使用できます。setClusterParameter
コマンドはMongoDB Atlas では使用できません。
互換性
このコマンドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
注意
このコマンドは、すべての MongoDB Atlas クラスターでサポートされています。すべてのコマンドに対する Atlas のサポートについては、 「サポートされていないコマンド」を参照してください。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
構文
db.adminCommand( { setClusterParameter: { <parameter>: <value> } } )
例を含む使用可能なクラスター パラメーターについては、「自己管理型配置のクラスター パラメーター 」を参照してください。
動作
setClusterParameter
はadmin
データベースでのみ実行できます。 他のデータベースで コマンドを実行すると、MongoDB はエラーを返します。レプリカセット プライマリまたはシャーディングされたクラスターでのみ
setClusterParameter
を実行できます。スタンドアロン配置では
setClusterParameter
は実行できません。setClusterParameter
は一度に 1 つのパラメーターのみを受け入れます。
アクセス制御
認証が有効になっている場合、 setClusterParameter
はsetClusterParameter
アクションへのアクセス権を持つロールを持つユーザーとして認証された場合にのみ機能します。
永続性
setClusterParameter
を使用して行われたパラメーターの変更は、レプリカセットとシャーディングされたクラスターで永続化されます。 これにより、 setClusterParameter
を使用して行われたパラメータの変更が再起動に耐えられるようになります。
Stable API
Stable API V 1を使用し、 apiStrictをtrue
に設定している場合、 setClusterParameter
を使用してクラスター パラメータを変更することはできません。