A função Consultar é usada para buscar registros dentro de uma coleção. Ela é uma das funções mais importantes e mais utilizadas no MongoDB.


Figura 1 - Bloco Consultar


Este bloco faz parte do plugin Plugin MongoDB. Para visualizá-lo, é necessário instalar o plugin.

Compatibilidade

  • Bloco servidor: cronapp.framework.mongodb.Operations.find()

Retorno

Retorna um cursor, objeto que representa os resultados de uma consulta.

Parâmetros

String de conexão

É a URL que permite conectar seu aplicativo ao banco de dados MongoDB. Essa string contém informações como o nome de usuário, senha, endereço do cluster e banco de destino.

  • Posição: 1
  • Inglês: Connection String
  • Tipo: Texto / String
  • Exemplo: "mongodb+srv://<db_userName>:<db_password>@meucluster.trzwoga.mongodb.net/?retryWrites=true&w=majority&appName=MeuCluster"

Banco de dados

Nome do banco dentro do cluster onde os dados serão inseridos.

  • Posição: 2
  • Inglês: Database
  • Tipo: Texto / String

  • Exemplo: "sample_mflix"

Coleção

No MongoDB, coleções são estruturas que armazenam os documentos (dados) dentro de um banco de dados. Elas funcionam de maneira semelhante às tabelas em bancos de dados relacionais, mas com algumas diferenças importantes por causa da natureza NoSQL do MongoDB.

  • Posição: 3
  • Inglês: Collection
  • Tipo: Texto / String

  • Exemplo: "movies"

Filtro

O conteúdo a ser consultado no banco, no formato JSON. É possível utilizar vários operadores de agregação para enriquecer e detalhar a consulta, acesse a documentação oficial para mais detalhes.

  • Posição: 4
  • Inglês: Filter
  • Tipo: Texto / String

  • Exemplo: "{'title': 'Matrix'}"

Exemplo

A função da imagem abaixo apresenta um exemplo de uso do bloco Consultar. Antes de utilizá-lo, certifique-se de que o cluster MongoDB já esteja devidamente configurado. Para mais detalhes sobre essa configuração, consulte a documentação do Plugin MongoDB.

Inicialmente, a variável "connectionString" é utilizada para armazenar a string de conexão com o banco de dados. Em seguida, essa variável é passada como primeiro parâmetro do bloco Consultar. No segundo parâmetro, é especificado o nome do banco de dados de destino, que neste exemplo é o "sample_mflix", um banco fornecido pelo MongoDB para testes e aprendizado. No parâmetro "Coleção", é informado "movies", uma coleção existente nesse banco. Por fim, no último parâmetro do bloco, são inseridos os dados em formato JSON, contendo o título do filme no seguinte formato: {"title": "nome_do_filme"}.

Vinculamos o arquivo de bloco de programação a um formulário de referência, com o objetivo de retornar o resultado da consulta em uma componente visual Área de Texto. Para isso, utilizamos o bloco de programação Alterar valor do campo, em conjunto com o bloco Converter para texto.


Figura 2 - Exemplo de uso do bloco Consultar


O resultado pode ser conferido na figura abaixo. Ao executar a função, retornamos o id e o título do filme cadastrados. 


Figura 2.1 - Registro retornado do banco de dados após a execução da função da Figura 2

Nesta página