menu
languagePortuguês (Brasil)
save_alt Baixar

Column Finder

Encontre colunas em tabelas e views do PostgreSQL, MySQL e MariaDB usando buscas somente leitura no schema.

por Vitor Hugo Plugin da comunidade

Readme

Este texto foi escrito por terceiros e traduzido automaticamente. Leia o original em inglês

CI

Um plugin somente leitura para o Beekeeper Studio que encontra colunas em todas as tabelas e views do banco de dados ativo.

Suporta PostgreSQL, MySQL e MariaDB. Buscas parciais e sem diferenciar maiúsculas/minúsculas mostram schema, tabela/view, coluna e tipo de dado. Um atalho Structure abre as tabelas correspondentes quando estão na lista de entidades carregada pelo Beekeeper. Os resultados são limitados a 500. Sem telemetria, servidor extra ou credenciais de banco de dados.

Importante: o plugin abre em uma aba própria pela seta ao lado do +. O SDK oficial não permite que plugins modifiquem o filtro nativo da barra lateral.

Instalar a partir do artefato de CI (sem precisar de Node)

  1. Abra Actions → CI e baixe o artefato beekeeper-column-finder de uma execução bem-sucedida.
  2. Extraia o manifest.json e o diretório dist/ para uma pasta chamada beekeeper-column-finder no diretório de plugins do Beekeeper:
    • Windows: %APPDATA%\beekeeper-studio\plugins\beekeeper-column-finder
    • Linux: ~/.config/beekeeper-studio/plugins/beekeeper-column-finder
    • macOS: ~/Library/Application Support/beekeeper-studio/plugins/beekeeper-column-finder
    • Windows Portable: {app-directory}\beekeeper-studio-data\plugins\beekeeper-column-finder
  3. Ative os plugins da comunidade (abaixo), reinicie o Beekeeper completamente e abra o Column Finder no menu suspenso ao lado do +.

Estrutura esperada: beekeeper-column-finder/manifest.json e beekeeper-column-finder/dist/index.html, além de dist/assets/.

O CI faz o build no Windows e Ubuntu com Node.js 22, executa os testes unitários e depois envia um pacote do plugin pronto para instalar (disponível por 30 dias; baixar artefatos do GitHub pode exigir login).

Instalar a partir do código-fonte (Windows PowerShell)

Execute estes comandos no PowerShell:

git clone https://github.com/hugoalves-dev/beekeeper-studio-column-finder.git
cd beekeeper-studio-column-finder
npm install
npm test
npm run build

$pluginDirectory = Join-Path $env:APPDATA 'beekeeper-studio\plugins'
New-Item -ItemType Directory -Force -Path $pluginDirectory | Out-Null
$link = Join-Path $pluginDirectory 'beekeeper-column-finder'
if (Test-Path $link) {
    Write-Host "Already exists: $link. Check its target before changing it."
} else {
    New-Item -ItemType Junction -Path $link -Target (Get-Location).Path | Out-Null
}

Se você já vinculou uma versão anterior, não recrie a junction. Baixe o código mais recente, execute npm install, npm test, npm run build e reinicie o Beekeeper.

Ativar plugins da comunidade (Beekeeper 5.7+)

No Windows, abra o arquivo de configurações:

notepad "$env:APPDATA\beekeeper-studio\user.config.ini"

Adicione ou atualize uma seção pluginSystem, preservando suas outras configurações:

[pluginSystem]
disabled = false
communityDisabled = false

Não adicione o ID do Column Finder em allow[]; ali só são aceitos IDs de plugins incluídos no app. Essa configuração também permite outros plugins de terceiros, então instale apenas os que você confia. O system.config.ini de um administrador pode sobrescrever as configurações do usuário.

No Beekeeper, abra Tools → Manage Plugins para confirmar que o Column Finder está ativado. Reinicie se necessário. Depois use o menu suspenso de abas ao lado do +.

Comportamento e limitações

Banco de dados Escopo da busca
PostgreSQL Todos os schemas de usuário acessíveis no banco ativo, exceto pg_catalog, information_schema e pg_toast*
MySQL DATABASE(), o banco de dados selecionado
MariaDB DATABASE(), o banco de dados selecionado

A busca lê apenas information_schema.columns e reflete seus privilégios de metadados. Ela usa entrada UTF-8 codificada em hex, evitando SQL injection e tratando os caracteres de porcentagem/sublinhado literalmente. Nenhuma escrita é executada. São exibidas até 500 correspondências, com um aviso se houver mais.

O atalho Structure depende da lista de tabelas já carregada pelo Beekeeper. Atualize a lista de entidades se uma tabela for encontrada mas a navegação falhar. A navegação no MySQL e MariaDB omite o schema para corresponder à representação interna do host. Alguns schemas do PostgreSQL também podem não estar no cache do host.

Desenvolvimento e testes

npm install
npm test
npm run build
npm run dev
  • O test runner nativo do Node verifica a geração de SQL, a resistência a injection, os dialetos e as opções de navegação entre tabelas (8 testes unitários).
  • O compilador TypeScript verifica os tipos e o Vite faz o build do plugin para produção.
  • O GitHub Actions executa os testes e o build no Windows e Ubuntu e depois envia manifest.json + dist como artefato.
  • Os testes unitários não executam consultas em bancos de dados reais; verifique a integração com MySQL/PostgreSQL/MariaDB manualmente.

Estrutura do projeto: src/sql.ts (SQL), src/navigation.ts (navegação de abas do host), src/main.ts (integração com o SDK), src/style.css e index.html (UI), tests/*.test.mjs (testes unitários) e .github/workflows/ci.yml (automação).

Solução de problemas

  • Plugin ausente/desativado: verifique Tools → Manage Plugins e o user.config.ini.
  • Versão antiga: confira o manifest.json no diretório real do plugin ou no destino da junction.
  • Structure mostra “Table not found”: atualize as entidades; o host só abre tabelas em cache.
  • O build falha após trocar entre Windows/Linux: reinstale as dependências com npm install na sua plataforma.
  • Problemas com o SDK: confira Help → Show Developer Tools no Beekeeper.

Referências e licença

Licença MIT. Projeto independente da comunidade; não endossado pelo Beekeeper Studio.