> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Adicionar uma Fonte de Dados

> Configure uma conexão de banco de dados externa quando o Reporter precisar de uma fonte de dados que ainda não está disponível no Console da Lerian para a geração de relatórios.

Use esta página para criar uma Fonte de Dados quando o Reporter precisar ler de um banco de dados externo ou de uma conexão que ainda não está configurada. Se o relatório usa dados internos de produtos Lerian, como o Midaz ou o CRM, a Fonte de Dados pode já existir.

## Objetivo

***

Configure uma conexão externa que Templates e Relatórios podem usar.

Por exemplo, crie uma Fonte de Dados chamada `production-postgres` que aponta para um banco de dados de relatórios externo, ou `compliance-readonly` para um usuário de banco de dados somente leitura usado pelos operadores de relatórios.

## Quando usar

***

Use esta tarefa quando:

* a Fonte de Dados necessária ainda não está disponível no Reporter
* um novo banco de dados deve alimentar relatórios
* um processo de relatório existente precisa de uma conexão somente leitura separada
* os operadores precisam de esquemas e campos disponíveis no Template Builder ou em filtros de relatório

Antes de adicionar uma, verifique se a Fonte de Dados interna necessária já existe. Criar uma conexão externa duplicada é desnecessário quando o Reporter já tem a fonte configurada.

Não use esta tarefa para corrigir uma conexão existente. Use [Editar uma Fonte de Dados](https://docs.lerian.studio/pt/products/reporter/console/editing-a-data-source.md) e [Testar a conexão de uma Fonte de Dados](https://docs.lerian.studio/pt/products/reporter/console/testing-a-data-source.md).

## Antes de começar

***

Tenha estes detalhes prontos:

* host, porta e nome do banco de dados
* usuário e senha
* nomes de esquema, quando o banco de dados usa esquemas
* o modo SSL que o seu banco de dados exige
* um nome de conexão claro, como `production-postgres` ou `compliance-readonly`

> [!WARNING]
>
> Use credenciais destinadas ao acesso de relatórios. Uma Fonte de Dados dá ao Reporter acesso para ler dados usados em Templates e Relatórios.

## Passo a passo

***

**1. Abrir Fontes de Dados**

Acesse **Data Sources** e clique em **Adicionar Data Source**.

**2. Preencher os detalhes da conexão**

Em **Adicionar Data Source**, informe **Nome da Conexão**, **Tipo de Banco de Dados**, **Host**, **Porta**, **Nome do Banco de Dados**, **Usuário** e **Senha**.

**3. Configurar esquemas quando necessário**

Para PostgreSQL, adicione os esquemas que o Reporter deveria inspecionar. Digite um nome de esquema e clique em **Adicionar**, ou pressione **Enter**. Sem esquemas, o Reporter usa `public`.

**4. Selecionar o modo SSL**

Selecione **Modo SSL**. O formulário começa em **Obrigatório**.

**5. Adicionar metadados quando útil**

Expanda **Metadados** para adicionar campos de chave-valor que ajudam os operadores a classificar a conexão.

**6. Criar a Fonte de Dados**

Clique em **Criar**. O Console salva a Fonte de Dados e testa a conexão dela.

**7. Ler o resultado do teste**

Quando o teste é bem-sucedido, o diálogo fecha e uma mensagem mostra a latência. Quando falha, a Fonte de Dados continua salva e o diálogo mostra o motivo. Clique em **Editar conexão** para corrigi-la, ou em **Manter mesmo assim**. Quando o teste não pode ser executado, o diálogo fecha e uma mensagem informa que a conexão não pôde ser verificada.

## Guia de campos

***

| Campo | O que inserir | Exemplo |
| - | - | - |
| **Nome da Conexão** | Nome obrigatório voltado ao operador. Campo técnico: `configName`. Até 100 caracteres: letras, números, `_` e `-`. Você não pode usar o nome de uma Fonte de Dados que a plataforma fornece. | `production-postgres` |
| **Tipo de Banco de Dados** | Motor de banco de dados obrigatório: **PostgreSQL** ou **MongoDB**. Ele preenche a porta padrão. Campo técnico: `type`. | **PostgreSQL** |
| **Host** | Endereço obrigatório do servidor de banco de dados, não a URL de uma aplicação. Campo técnico: `host`. | `db.example.com` |
| **Porta** | Porta obrigatória do banco de dados. Campo técnico: `port`; o intervalo válido é de 1 a 65535. | `5432` |
| **Nome do Banco de Dados** | Nome obrigatório do banco de dados que o Reporter vai consultar. Campo técnico: `databaseName`. | `ledger` |
| **Usuário** | Usuário obrigatório do banco de dados. Campo técnico: `username`. | `reporter_readonly` |
| **Senha** | Segredo obrigatório ao criar uma Fonte de Dados. Campo técnico: `password`. | Armazenada pelo formulário |
| **Esquemas** | Lista opcional de esquemas para PostgreSQL. As entradas são aparadas, convertidas para minúsculas e deduplicadas. | `public`, `pix`, `transactions` |
| **Modo SSL** | Obrigatório. Use **Desativado**, **Obrigatório**, **Verificar CA** ou **Verificação Completa**. Campo técnico: `sslMode`. | **Verificar CA** |
| **Opções de Conexão** | Opções opcionais da URI do MongoDB, em **Avançado**. Campo técnico: `options`. | `authSource=admin` |
| Campos de chave/valor de **Metadados** | Dados opcionais de classificação do operador. Cada linha precisa de uma chave, e uma chave não pode se repetir. Campo técnico: `metadata`. | `environment = production` |

## Resultado esperado

***

A nova Fonte de Dados externa aparece na página **Data Sources** com o resultado do teste de conexão. Depois de um teste bem-sucedido, os operadores podem usar os campos dela em Templates e Relatórios.

## Erros comuns e pontos de atenção

***

> [accordion] Usar uma URL de aplicação como Host
>
> **Host** deveria ser o endereço do servidor de banco de dados, como `db.example.com`, não a URL de uma aplicação ou painel administrativo.

> [accordion] Pular esquemas
>
> Se o banco de dados usa esquemas e o esquema necessário não está listado, os operadores podem não ver as tabelas e campos esperados.

> [accordion] Ignorar requisitos de SSL
>
> Se o banco de dados exige SSL, a conexão pode falhar até que **Modo SSL** corresponda a esse requisito.

> [accordion] Usar nomes pouco claros
>
> Nomes como `db1` são difíceis de usar com segurança. Prefira nomes que mostrem o ambiente e o propósito, como `production-compliance-readonly`.

## Próximos passos

***

* Use [Testar a conexão de uma Fonte de Dados](https://docs.lerian.studio/pt/products/reporter/console/testing-a-data-source.md) para testar a conexão de novo mais tarde.
* Use o [Template Builder](https://docs.lerian.studio/pt/products/reporter/console/template-builder.md) para usar campos da Fonte de Dados em um Template.
* Use [Gerar um Relatório](https://docs.lerian.studio/pt/products/reporter/console/generating-a-report.md) depois que o Template e a Fonte de Dados estiverem prontos.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.