db metadata¶
fonte
inspeciona a estrutura de um banco de dados — schemas, tabelas, colunas, constraints e índices — sem extrair os dados propriamente ditos. pensado para a fase de descoberta, antes de desenhar o pipeline de extração definitivo.
quando usar¶
- explorar um banco desconhecido (sistema legado, banco de um cliente/parceiro) antes de decidir quais tabelas extrair
- documentar rapidamente chaves primárias, chaves estrangeiras e índices de uma tabela candidata a fonte
- validar, antes de construir o pipeline completo, se uma tabela tem os campos e o volume esperado (com amostra de dados)
configuração¶
| campo | tipo | obrigatório | descrição |
|---|---|---|---|
credential_id |
uuid | sim | conexão criada em configurações → conexões |
db_type |
enum | sim | postgresql, sqlserver, mysql, oracle ou mongodb |
schema |
string | não | schema a inspecionar · vazio = todos os schemas acessíveis |
table |
string | não | tabela específica · vazio = todas as tabelas do schema |
include_constraints |
bool | não | inclui chaves primárias, estrangeiras e unique · padrão: true |
include_indexes |
bool | não | inclui índices da(s) tabela(s) · padrão: true |
include_sample |
bool | não | inclui uma amostra de linhas de cada tabela · padrão: true |
sample_limit |
number | não | linhas de amostra por tabela quando include_sample=true · padrão: 5 |
exemplos¶
descoberta completa de um schema¶
{
"credential_id": "uuid-da-conexao",
"db_type": "postgresql",
"schema": "vendas",
"include_constraints": true,
"include_indexes": true,
"include_sample": true,
"sample_limit": 5
}
retorna todas as tabelas do schema vendas, com colunas, tipos, chaves e uma amostra de 5 linhas por tabela.
inspeção de uma única tabela¶
{
"credential_id": "uuid-da-conexao",
"db_type": "oracle",
"schema": "ERP",
"table": "PEDIDOS",
"include_sample": false
}
útil quando você já sabe qual tabela quer extrair e só precisa confirmar nomes de coluna e tipos antes de escrever a query do conector postgresql / sql server / mysql / oracle.
quando usar em vez do conector de extração direta¶
| objetivo | nó recomendado |
|---|---|
| descobrir o que existe no banco | db metadata |
| confirmar estrutura de uma tabela específica antes de extrair | db metadata |
| efetivamente trazer os dados da tabela para o pipeline | postgresql / sql server / mysql / oracle ou mongodb |
primeiro passo em integrações novas
ao conectar um banco novo pela primeira vez, comece com um nó db metadata isolado (sem conectar nada depois dele) para confirmar schema e nomenclatura — só então monte a query de extração definitiva.