データベースコマンドの実行

Overview

このガイドでは、Node.js ドライバーを使用してデータベースコマンドを実行する方法を学習できます。 データベースコマンドを使用して、サーバー統計の取得、レプリカセットの初期化、集計パイプラインの実行など、さまざまな管理および診断タスクを実行できます。

コマンドの実行

データベースコマンドを実行するには、ドキュメント内でコマンドと関連するパラメータを指定し、このドキュメントを コマンド実行メソッドに渡す必要があります。 Node.js ドライバーは、データベース コマンドを実行するための次のメソッドを提供します。

• command()は、コマンドの応答をDocumentタイプとして返します。 このメソッドは任意のデータベースコマンドで使用できます。

• runCursorCommand()は、コマンド応答を反復可能なRunCommandCursorタイプとして返します。 このメソッドは、データベースコマンドが複数の結果ドキュメントを返す場合にのみ使用できます。

次のコードは、 command()メソッドを使用してデータベース上でレプリカセット内の現在のノードのロールに関する情報を返すhelloコマンドを実行する方法を示しています。

const result = await myDB.command({ hello: 1 });

データベースコマンドと対応するパラメータの完全なリストについては、「追加情報 」セクションを参照してください。

コマンド オプション

command()runCursorCommand()メソッドと メソッドで任意のコマンド動作を指定できます。

command() メソッドは RunCommandOptionsオブジェクトを受け入れます。RunCommandOptions 型の詳細については、APIドキュメントを参照してください。

runCursorCommand() method は RunCursorCommandOptionsオブジェクトを受け入れます。RunCursorCommandOptions 型の詳細については、APIドキュメントを参照してください。

Node.js ドライバーのバージョン 6.0 以降では、次のオプションのみをcommand()メソッドに渡すことができます。

• comment

• enableUtf8Validation

• raw

• readPreference

• session

command()メソッドに渡すドキュメントで、さらにオプションを設定できます。 コマンドと、それが受け入れるオプションの詳細については、コマンドを見つけ、サーバー マニュアルの「データベースコマンド」セクションのリンクに従ってください。

次のコードは、 majority書込み保証（write concern）で実行されるgrantRolesToUserコマンドを指定する方法を示しています。

const commandDoc = {
    grantRolesToUser: "user011",
    roles: [ "readWrite" ],
    writeConcern: { w: "majority" }
};
const result = await myDB.command(commandDoc);

const commandOptions = { readPreference: "nearest" };
const result = await myDB.command(commandDoc, commandOptions);

応答

各メソッドは、コマンドの実行後にデータベースからの応答を含むDocumentオブジェクトまたはカーソルを返します。 各データベースコマンドは異なる機能を実行するため、応答内容はコマンド間で異なる可能性があります。 ただし、すべての応答には次のフィールドを持つドキュメントが含まれます。

例

次のコードは、 runCursorCommand()メソッドを使用してtestDBデータベースでcheckMetadataConsistencyコマンドを実行し、結果を反復処理する方法を示しています。

// Connect to the "testDB" database
const db = client.db("testDB");
// Run a cursor command to check metadata consistency within the database
const cursor = await db.runCursorCommand({
    checkMetadataConsistency: 1,
});
// Iterate through the cursor's results and print the contents
for await (const doc of cursor) {
  console.log(doc);
}

{
  type: ...,
  description: ...,
  details: {
    namespace: ...,
    info: ...
  }
}
{
  type: ...,
  description: ...,
  details: {
    namespace: ...,
    collectionUUID: ...,
    maxKeyObj: ...,
    ...
  }
}

コマンドの実行例：フルファイル

次のサンプルコードでは、dbStats コマンドを送信して、sample_mflixデータベースから統計をリクエスト。

1
/* Run a database command */
2
3
import { MongoClient } from "mongodb";
4
5
// Replace the uri string with your MongoDB deployment's connection string
6
const uri = "<connection string uri>";
7
8
const client = new MongoClient(uri);
9
10
async function run() {
11
  try {
12
    // Get the "sample_mflix" database
13
    const db = client.db("sample_mflix");
14
15
    // Find and print the storage statistics for the "sample_mflix" database using the 'dbStats' command
16
    const result = await db.command({
17
      dbStats: 1,
18
    });
19
    console.log(result);
20
  } finally {
21
    // Close the database connection on completion or error
22
    await client.close();
23
  }
24
}
25
run().catch(console.dir);

上記のコマンドを実行すると、次の出力が生成されます。

{
  db: 'sample_mflix',
  collections: 6,
  views: 0,
  objects: 75620,
  ..

詳細情報

このガイドの概念の詳細については、次のドキュメントを参照してください。

• db.runCommand()

• データベース コマンド

• hello コマンド

• find コマンド

カーソルからデータを検索する方法については、「 カーソルからデータにアクセスする」の基礎ページを参照してください。