> For the complete documentation index, see [llms.txt](https://docs.floui.io/guia/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.floui.io/guia/conectores/categorias/servicos-do-floui/floui-database/consultar-por-campo.md).

# Consultar por campo

{% tabs %}
{% tab title="Parâmetros" %}

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXd0TyYQqTgtvO0niBuIMeQ3PgvHWApT4X2i3eEDeSCoYzEOfFTAYSV2CyCY6r_BllZgswNBLrxU4D_b7F_B3wWWo9ER6MJpKDGYkDGXG5k2u7XQ7wHlmNolrbBCs3jVfMPWjfgaVg?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Parâmetros de configuração</p></figcaption></figure>

| Campo                         | Tipo           | Descrição                                                                                                                                                                                                                                                                                                               |
| ----------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Descrição                     | Campo de texto | Descrição visual do conector na construção do fluxo.                                                                                                                                                                                                                                                                    |
| Tabela de dados               | Seletor        | Permite selecionar a tabela de dados em que o registro será consultado.                                                                                                                                                                                                                                                 |
| Selecionar campo na tabela    | Seletor        | <p>Define a forma de seleção do campo da tabela. </p><p></p><p>Caso optado em <strong>Sim</strong>, irá disponibilizar um campo do tipo seletor que irá listar todos os campos da tabela. </p><p></p><p>Caso optado por <strong>Não</strong>, irá disponibilizar um campo de texto para digitar o campo da tabela. </p> |
| Nome do campo                 | Campo de texto | <p>Campo disponível quando <strong>Selecionar campo na tabela</strong> estiver com opção <strong>Não</strong>. </p><p></p><p>Permite digitar o nome do campo a ser consultado, possibilitando a inserção do nome do campo dinamicamente pela notação Mustache {{msg}}.</p>                                              |
| Campo na tabela para consulta | Seletor        | <p>Campo disponível quando <strong>Selecionar campo na tabela</strong> estiver com opção <strong>Sim</strong> e foi selecionada uma <strong>Tabela de dados</strong>. </p><p></p><p>Permite selecionar o campo através de uma lista contendo todos os campos da tabela.</p>                                             |
| Valor do campo                | Campo de texto | Define o valor, preferencialmente único em toda a tabela, a ser usado como parâmetro de consulta.                                                                                                                                                                                                                       |
| Output Path                   | Campo de texto | Refere-se ao caminho de saída onde o resultado da consulta será disponibilizado no contexto de execução do conector.                                                                                                                                                                                                    |
| {% endtab %}                  |                |                                                                                                                                                                                                                                                                                                                         |

{% tab title="Payload" %}

## Sucesso

O conector Consultar por Campo é voltado para capturar um registro através de um campo com valor único em relação a todos os outros registros presentes na Floui Database, como um identificador daquele registro. Logo a saída deste conector será limitada a apenas um registro. Caso haja mais de um registro correspondente ao filtro aplicado nas configurações do conector, somente o primeiro será retornado.

Em caso de sucesso na captura do registro único, serão retornadas as seguintes informações do registro.

* payload: Refere-se a carga de dados retornada pelo conector, contendo os dados da consulta.
* \_id: Identificador único do registro no banco de dados NoSQL.
* table: Identificador único da tabela no banco de dados NoSQL.
* data: Objeto com os dados e campos do registro consultado.
* updated\_at: Data de atualização do registro no formato ISO 8601.
* created\_at: Data de criação do registro no formato ISO 8601.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdRCKsETdILeUljyv8wlX3qaIud2TRTpGe29cI27dtxQcfIOVhBVZfVPppHw2BpUVNa66wywd7poQ5qT7efZpfsoeXp53ujVWsAclLgZRtIxaU_mMb68ExMqQAUvE-ItsJLac_07w?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Sucesso na consulta de registro</p></figcaption></figure>

## Erro

Em casos de erro na captura do registro, será retornado um valor `null` na saída do conector, significado que o registro não existe, ou, houve erro durante a parametrização do conector.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXf-Pr73uO_-lwROUTMHtjmJ5tDF_RK0hP9JN1C7mg6JzYvnB--bXWwzINYdwxOO6tZSOUbgc_VpRsxFgDXhVEBByx0PHDCOSmrNYu-YLAmik_Yep-Ps1ne-u7yrgbRpTYods4Q94A?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Erro na consulta de registro</p></figcaption></figure>
{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.floui.io/guia/conectores/categorias/servicos-do-floui/floui-database/consultar-por-campo.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
