コマンドの実行

Overview

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

このガイドには、次のセクションが含まれています。

• Execute a Command describes the syntax and behavior of the run_command() and run_cursor_command() methods

• 応答には、コマンド実行メソッドが返す情報が記述されます

• コマンドの例では、コマンドの例を示し、コマンドの出力を説明します

• 追加情報では、このガイドで言及されている型とメソッドのリソースとAPIドキュメントへのリンクを提供します

コマンドの実行

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

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

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

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

let result = my_db.run_command(doc! { "hello": 1 }, None).await?;

checkMetadataConsistencyコマンドは複数の結果ドキュメントを返します。 次のコードに示すように、 run_cursor_command()メソッドを使用してこのコマンドを実行し、結果を収集できます。

let cursor = my_db
    .run_cursor_command(doc! { "checkMetadataConsistency": 1 }, None)
    .await?;

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

let command_options = SelectionCriteria::ReadPreference(
    ReadPreference::Primary
);
let result = my_db.run_command(command_doc, command_options).await?;

応答

run_command()メソッドは、コマンド実行後のデータベースからの応答を含むDocumentオブジェクトを返します。 run_cursor_command()は、複数の結果ドキュメントを参照するCursorを返します。

各データベースコマンドは異なる機能を実行するため、応答内容は実行されたコマンドによって異なる場合があります。 ただし、すべての応答には次のフィールドを持つドキュメントが含まれます。

コマンドの例

次のコードは、 run_command()メソッドを使用して、 plantsデータベースのflowersコレクションに対してcount操作を行うためのexplainコマンドを実行する方法を示しています。 explainコマンドは"queryPlanner"の冗長モードで実行されます。

let my_db = client.database("plants");
let count_command = doc! { "count": "flowers" };
let explain_command =
    doc! {
    "explain": count_command,
    "verbosity": "queryPlanner"
};
let result = my_db.run_command(explain_command, None).await?;

{
    "$clusterTime": {
        "clusterTime": {
            "T": 1673969525,
            "I": 24
        },
        "signature": {...}
    },
    "command": {
        "$db": "plants",
        "count": "flowers"
    },
    "explainVersion": "1",
    "ok": 1,
    "operationTime": {
        "T": 1673969525,
        "I": 24
    },
    "queryPlanner": {
        "indexFilterSet": false,
        "maxIndexedAndSolutionsReached": false,
        "maxIndexedOrSolutionsReached": false,
        "maxScansToExplodeReached": false,
        "namespace": "plants.flowers",
        "rejectedPlans": [],
        "winningPlan": {
            "stage": "RECORD_STORE_FAST_COUNT"
        }
    },
    "serverInfo": {...},
    "serverParameters": {
        "internalDocumentSourceGroupMaxMemoryBytes": 104857600,
        ...
    }
}

詳細情報

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

• db.runCommand()

• データベース コマンド

• hello コマンド

• explain コマンド