Skip to main content

Querys (Querys)

O módulo Querys permite o cadastro e gerenciamento de consultas SQL reutilizáveis, organizadas por empresa, com foco em análises, integrações e extração estruturada de dados dentro do ecossistema DataBee.

Cada registro representa um conjunto lógico de consultas, podendo conter até duas queries independentes.

Identidade do Modelo​

RecursoIdentificadorFinalidade
MóduloDataBeeDomínio de dados e integrações
GrupoQuerysIdentificação técnica do schema
PrincipalSimDisponível no menu principal

Contrato do Modelo​

Este schema opera sob as seguintes premissas:

  • Cada Query pertence a uma empresa
  • As consultas são armazenadas como SQL puro
  • Não existe execução automática neste módulo (somente cadastro)
  • Pode ser utilizado por outros módulos, rotinas ou integrações
  • Isolamento total entre empresas

Interface & Comportamento (UI)​

Inteligência de Busca​

Campos indexados para localização rápida:

  • Campos indexados: description
  • Descriptor: description

O campo descrição é utilizado como identificador principal em listas, seletores e vínculos.

Estrutura de Campos​

Descrição (description)​

  • Texto livre
  • Obrigatório
  • Define o propósito funcional da query

Query 1 (queryOne)​

  • Texto
  • Tipo código
  • Linguagem: SQL
  • Uso livre (consulta principal)

Query 2 (queryTwo)​

  • Texto
  • Tipo código
  • Linguagem: SQL
  • Uso opcional (consulta complementar, validação ou apoio)

Filial / Empresa (companySiteId)​

  • Relacionamento com CompanySite
  • Preenchido automaticamente
  • Somente leitura
  • Obrigatório

Integração (integracao)​

  • Booleano
  • Valor fixo inicial: false
  • Indica se a query está vinculada a algum fluxo de integração externa

Sincronização (sync)​

  • Booleano
  • Valor fixo inicial: false
  • Uso interno para controle de estado

Regras do Formulário​

Ordem e Governança

A ordem dos campos é controlada pelo schema e segue uma progressão lógica de cadastro.

  1. Descrição
  2. Empresa
  3. Query 1
  4. Query 2

Campos de SQL utilizam editor de código com destaque de sintaxe.

Multitenancy e Segurança​

Com multi_company: true, o sistema garante:

  • Isolamento completo por empresa
  • Queries invisíveis entre empresas
  • Filtro automático em listagens e APIs
  • Segurança contra vazamento de lógica de negócio

Integrações e Uso Estratégico​

Este módulo é normalmente utilizado para:

  • Base de queries para dashboards
  • Fonte para integrações ETL
  • Apoio a relatórios personalizados
  • Consultas reutilizáveis entre sistemas
  • Padronização de extração de dados

Nenhuma query é executada automaticamente sem um módulo consumidor.

Exemplo de Registro​

{
  "description": "Total de produção por unidade",
  "queryOne": "SELECT unidade, SUM(quantidade) FROM producao GROUP BY unidade",
  "queryTwo": "SELECT COUNT(*) FROM producao WHERE status = 'ATIVO'",
  "companySiteId": "64fa9c2e8b1c2a001f3e9a77",
  "integracao": false,
  "sync": false
}