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

Overview

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

コマンドの実行

データベースコマンド を実行するには、コマンドとドキュメントで関連するパラメータを指定し、そのドキュメントをrunCommand() メソッドに渡します。

次のコードは、runCommand() メソッドを使用して explain コマンドを実行する方法を示しています。このコマンドを呼び出すと、find コマンドの実行方法に関する説明が返されます。

val commandToExplain = Document("find", "restaurants")
val explanation = database.runCommand(Document("explain", commandToExplain))

データベースコマンドと対応するパラメータの完全なリストについては、データベースコマンドガイドを参照してください。

コマンド オプション

readPreference パラメータを含めることで、runCommand() メソッドで任意のコマンド動作を指定できます。次の例は、読み込み設定 (read preference)を指定し、それをオプションとして runCommand() メソッドに渡す方法を示しています。

val command = Document("hello", 1)
val commandReadPreference = Document("readPreference", "secondary")
val commandResult = database.runCommand(command, commandReadPreference)

読み込み設定（read preference）オプションの詳細については、サーバー マニュアルの読み込み設定（read preference） を参照してください。

応答

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

例

次の例は、buildInfo コマンドの実行方法と、それによって生成される出力を示しています。

import com.mongodb.MongoException
import com.mongodb.kotlin.client.MongoClient
import org.bson.Document
import org.bson.BsonInt64
import org.bson.json.JsonWriterSettings
fun main() {
    // Replace the placeholder with your MongoDB deployment's connection string
    val uri = "<connection string uri>"
    val mongoClient = MongoClient.create(uri)
    val database = mongoClient.getDatabase("sample_mflix")
    try {
        val command = Document("buildInfo", BsonInt64(1))
        val commandResult = database.runCommand(command)
        println(commandResult.toJson(JsonWriterSettings.builder().indent(true).build()))
    } catch (me: MongoException) {
        System.err.println("An error occurred: $me")
    }
    mongoClient.close()
}

{
  version: '8.0.4',
   ...<other command results>...
  ok: 1,
  '$clusterTime': {
      clusterTime: Timestamp({ ... }),
      signature: {
         ...
      }
  },
  operationTime: Timestamp({ ... })
}

詳細情報

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

• Kotlin Sync API runCommand()

• データベース コマンド

• explain コマンド

• hello コマンド

• buildInfo コマンド