db.runCommand()（mongoshメソッド）

定義

db.runCommand(command, [options])

指定されたデータベース コマンド を実行するためのヘルパーを提供します。これは、shell とドライバー間の一貫したインターフェースを提供するため、データベース コマンドを発行するための推奨される方法です。

Parameter	タイプ	説明
command	ドキュメントまたは文字列	コマンドを指定するドキュメントまたは文字列。文字列として指定すると、 db.runCommand()文字列をドキュメントに変換します。
options	ドキュメント	mongosh 2.0 以降では、mongosh がコマンドを実行する方法を指定するオプションです。
options.readPreference	読み込み設定 (read preference)	コマンドを実行するための読み取り設定。指定されていない場合は、デフォルトで primary になります。db.runCommand() は、setReadPref() の使用や、接続文字列 での readPreference の指定など、その他の読み取り設定グローバル構成セットを無視します。 mongosh 1.x では、db.runCommand() は options 引数を取りません。読み取り設定を設定するには、Mongo.setReadPref() を使用するか、接続文字列で readPreference を指定します。

ミリ秒単位で時間制限を指定するには、「実行中の操作を終了する」を参照してください。

互換性

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

• MongoDB Atlas はクラウドでの MongoDB 配置のための完全管理サービスです

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

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

動作

db.runCommand()は、現在のデータベースのコンテキストでコマンドを実行します。一部のコマンドはadmin dbデータベースのコンテキストでのみ適用可能であり、これらのコマンドを実行中前に オブジェクトを変更するか、db.adminCommand() を使用する必要があります。

例

次の例は、db.runCommand() を使用してデータベース コマンドを実行する方法を示しています。

db.runCommand( { hello: 1 } )

db.runCommand( { hello: 1 }, { readPreference: "secondaryPreferred" } )

応答

このメソッドは、次のフィールドを含む応答ドキュメントを返します。