Executar um comando de banco de dados

Visão geral

Neste guia, você pode aprender como executar um comando de banco de dados usando o driver Kotlin . Você pode usar comandos de banco de dados para executar uma variedade de tarefas administrativas e de diagnóstico, como buscar estatísticas do servidor , inicializar um conjunto de réplicas ou executar um pipeline de agregação .

Executar um comando

Para executar um comando de banco de dados, especifique o comando e quaisquer parâmetros relevantes em um documento e, em seguida, passe o documento para o método runCommand().

O seguinte código mostra como você pode utilizar o método runCommand() para executar o comando dbStats, que retorna estatísticas de um banco de dados MongoDB especificado:

import com.mongodb.MongoException
import com.mongodb.kotlin.client.coroutine.MongoClient
import kotlinx.coroutines.runBlocking
import org.bson.BsonDocument
import org.bson.BsonInt64
import org.bson.json.JsonWriterSettings
fun main() = runBlocking {
    // Replace the uri string 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 = BsonDocument("dbStats", 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()
}

{
  "db": "sample_mflix",
  "collections": 5,
  "views": 0,
  "objects": 75595,
  "avgObjSize": 692.1003770090614,
  "dataSize": 52319328,
  "storageSize": 29831168,
  "numExtents": 0,
  "indexes": 9,
  "indexSize": 14430208,
  "fileSize": 0,
  "nsSizeMB": 0,
  "ok": 1
}

Para obter uma lista completa de comandos de banco de dados e os parâmetros correspondentes, consulte o guia Comandos de banco de dados.

Opções de comando

Você pode especificar o comportamento de comando opcional para o método runCommand() incluindo um parâmetro readPreference. O exemplo a seguir mostra como especificar uma preferência de leitura e passá-la como uma opção para o método runCommand():

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

Para obter mais informações sobre as opções de read preference, consulte Read preference no manual do servidor MongoDB.

Resposta

O método runCommand() retorna um objeto Document que contém a resposta do banco de dados após a execução do comando. Cada comando de banco de dados executa uma função diferente, portanto, o conteúdo da resposta pode variar entre comandos. No entanto, cada resposta contém documentos com os seguintes campos:

Informações adicionais

Para obter mais informações sobre os conceitos deste guia, consulte a seguinte documentação:

• RunCommand()

• Comandos de banco de dados

• dbStats