Executar um comando de banco de dados

Visão geral

Neste guia, você pode aprender como executar um comando de banco de dados com o driver do Node.js. 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, inicializando um conjunto de réplicas ou executando um pipeline de agregação.

Executar um comando

Para executar um comando de banco de dados, você deve especificar o comando e qualquer em um documento e, em seguida, passe este documento para um método de execução de comandos. O driver Node.js fornece os seguintes métodos para executar comandos do banco de dados:

• command(), que retorna a resposta do comando como um tipo Document . Você pode usar este método com qualquer reconhecimento de data center de banco de dados.

• runCursorCommand(), que retorna a resposta do comando como um tipo RunCommandCursor iterável. Você pode usar esse método somente se o reconhecimento de data center retornar vários documento de resultados.

O código a seguir mostra como usar o método command() para executar o comando hello , que retorna informações sobre a role do membro atual no conjunto de réplicas, em um reconhecimento de data center:

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

Para obter uma lista completa dos comandos do banco de dados e dos parâmetros correspondentes, consulte a seção Informações adicionais.

Opções de comando

Você pode especificar o comportamento de comando opcional para os métodos command() e runCursorCommand() .

O método command() aceita um objeto RunCommandOptions. Para saber mais sobre o tipo RunCommandOptions, consulte a documentação API.

O runCursorCommand() method aceita um objeto RunCursorCommandOptions. Para saber mais sobre o tipo RunCursorCommandOptions, consulte a documentação API.

A partir da versão 6.0 do driver Node.js, você pode passar apenas as seguintes opções para o método command() :

• comment

• enableUtf8Validation

• raw

• readPreference

• session

Você pode definir mais opções no documento que você passa para o método command() . Para saber mais sobre um comando e as opções que ele aceita, localize o comando e siga o link na seção Comandos do banco de dados do manual do servidor MongoDB.

O seguinte código mostra como especificar um comando grantRolesToUser que é executado com uma referência de escrita majority :

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);

Resposta

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

Exemplo

O código a seguir mostra como você pode usar o método runCursorCommand() para executar o comando checkMetadataConsistency no reconhecimento de data center testDB e iterar através dos resultados:

// 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: ...,
    ...
  }
}

Informações adicionais

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

• db.runCommand()

• Comandos de banco de dados

• olá comando

• Encontre o comando

Para saber como recuperar dados de um cursor, consulte o guia Acessar dados de um cursor.