ANNOUNCEMENT: Voyage AI joins MongoDB to power more accurate and trustworthy AI applications on Atlas.
Learn more
Docs Menu

setClusterParameter

setClusterParameter

setClusterParameterは、クラスター パラメータの値を変更するための管理コマンドです。 クラスター パラメーターは、レプリカセットまたはシャーディングされたクラスター内のすべてのノードに影響する構成可能なパラメーターです。

また、 adminデータベースに対してsetClusterParameterコマンドを発行する必要があります。

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

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

注意

このコマンドは、すべての MongoDB Atlas クラスターでサポートされています。すべてのコマンドに対する Atlas のサポートについては、「サポートされていないコマンド」を参照してください。

  • MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

  • MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

db.adminCommand(
{
setClusterParameter: { <parameter>: <value> }
}
)

例を含む使用可能なクラスター パラメーターについては、「自己管理型配置のクラスター パラメーター 」を参照してください。

  • setClusterParameteradminデータベースでのみ実行できます。 他のデータベースで コマンドを実行すると、MongoDB はエラーを返します。

  • レプリカセット プライマリまたはシャーディングされたクラスターでのみsetClusterParameterを実行できます。

  • スタンドアロン配置ではsetClusterParameterは実行できません

  • setClusterParameterは一度に 1 つのパラメータのみを受け入れます。

認証が有効になっている場合、 setClusterParametersetClusterParameterアクションへのアクセス権を持つロールを持つユーザーとして認証された場合にのみ機能します。

setClusterParameterを使用して行われたパラメーターの変更は、レプリカセットとシャーディングされたクラスターで永続化されます。 これにより、 setClusterParameterを使用して行われたパラメータの変更が再起動に耐えられるようになります。

Stable API V 1を使用し、 apiStricttrueに設定している場合、 setClusterParameterを使用してクラスター パラメータを変更することはできません。