Ein schreibgeschütztes Beekeeper Studio Plugin, mit dem du Spalten in allen Tabellen und Views der aktiven Datenbank findest.
Unterstützt PostgreSQL, MySQL und MariaDB. Teilsuchen ohne Beachtung der Groß-/Kleinschreibung zeigen Schema, Tabelle/View, Spalte und Datentyp. Ein Structure-Shortcut öffnet passende Tabellen, sofern sie in Beekeepers geladener Entitätsliste vorhanden sind. Ergebnisse sind auf 500 begrenzt. Keine Telemetrie, kein zusätzlicher Server, keine Datenbank-Zugangsdaten.
Wichtig: Das Plugin öffnet sich in einem eigenen Tab über den Pfeil neben +. Das offizielle SDK erlaubt Plugins nicht, den nativen Sidebar-Filter zu ändern.
Installation über CI-Artefakt (kein Node nötig)
- Öffne Actions → CI und lade das Artefakt beekeeper-column-finder aus einem erfolgreichen Durchlauf herunter.
- Entpacke dessen manifest.json und dist/ -Verzeichnis in einen Ordner namens beekeeper-column-finder im Beekeeper-Plugin-Verzeichnis:
- 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
- Aktiviere Community-Plugins (siehe unten), starte Beekeeper komplett neu und öffne dann Column Finder über das Dropdown neben +.
Erwartete Struktur: beekeeper-column-finder/manifest.json und beekeeper-column-finder/dist/index.html plus dist/assets/.
CI baut auf Windows und Ubuntu mit Node.js 22, führt Unit-Tests aus und lädt dann ein installierbares Plugin-Bundle hoch (30 Tage verfügbar; für den Download von GitHub-Artefakten musst du dich ggf. anmelden).
Installation aus dem Quellcode (Windows PowerShell)
Führe diese Befehle in PowerShell aus:
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
}
Wenn du bereits eine ältere Version verlinkt hast, erstelle die Junction nicht neu. Hol dir den neuesten Quellcode, führe npm install, npm test, npm run build aus und starte Beekeeper neu.
Community-Plugins aktivieren (Beekeeper 5.7+)
Öffne unter Windows die Einstellungsdatei:
notepad "$env:APPDATA\beekeeper-studio\user.config.ini"
Füge einen pluginSystem-Abschnitt hinzu oder aktualisiere ihn, ohne deine übrigen Einstellungen zu verändern:
[pluginSystem]
disabled = false
communityDisabled = false
Füge die Column-Finder-ID nicht zu allow[] hinzu; dort werden nur IDs mitgelieferter Plugins akzeptiert. Diese Konfiguration erlaubt auch andere Drittanbieter-Plugins, installiere also nur solche, denen du vertraust. Eine system.config.ini eines Administrators kann Benutzereinstellungen überschreiben.
Öffne in Beekeeper Tools → Manage Plugins, um zu prüfen, dass Column Finder aktiviert ist. Starte bei Bedarf neu. Nutze dann das Tab-Dropdown neben +.
Verhalten und Einschränkungen
| Datenbank | Suchbereich |
|---|---|
| PostgreSQL | Alle zugänglichen Benutzerschemas in der aktiven Datenbank, ausgenommen pg_catalog, information_schema und pg_toast* |
| MySQL | DATABASE(), die ausgewählte Datenbank |
| MariaDB | DATABASE(), die ausgewählte Datenbank |
Die Suche liest nur information_schema.columns und spiegelt deine Metadaten-Berechtigungen wider. Sie verwendet hex-kodierte UTF-8-Eingaben, verhindert so SQL-Injection und behandelt Prozent- und Unterstrichzeichen wörtlich. Es werden keine Schreibvorgänge ausgeführt. Bis zu 500 Treffer werden angezeigt, mit einem Hinweis, falls es mehr gibt.
Der Structure-Shortcut hängt von Beekeepers bereits geladener Tabellenliste ab. Aktualisiere die Entitätsliste, wenn eine Tabelle gefunden wird, die Navigation aber fehlschlägt. Bei MySQL und MariaDB wird das Schema bei der Navigation weggelassen, passend zur internen Darstellung des Hosts. Auch manche PostgreSQL-Schemas fehlen eventuell im Host-Cache.
Entwicklung und Tests
npm install
npm test
npm run build
npm run dev
- Nodes eingebauter Test-Runner prüft SQL-Generierung, Injection-Resistenz, Dialekte und Optionen der Tabellennavigation (8 Unit-Tests).
- Der TypeScript-Compiler prüft die Typen und Vite baut das Plugin für die Produktion.
- GitHub Actions führt Tests und Build auf Windows und Ubuntu aus und lädt dann manifest.json + dist als Artefakt hoch.
- Unit-Tests führen keine Abfragen gegen echte Datenbanken aus; prüfe die Integration mit MySQL/PostgreSQL/MariaDB manuell.
Projektstruktur: src/sql.ts (SQL), src/navigation.ts (Tab-Navigation des Hosts), src/main.ts (SDK-Integration), src/style.css und index.html (UI), tests/*.test.mjs (Unit-Tests) und .github/workflows/ci.yml (Automatisierung).
Fehlerbehebung
- Plugin fehlt/deaktiviert: Prüfe Tools → Manage Plugins und user.config.ini.
- Alte Version: Prüfe die manifest.json im tatsächlichen Plugin-Verzeichnis oder im Junction-Ziel.
- Structure zeigt „Table not found“: Aktualisiere die Entitäten; der Host öffnet nur gecachte Tabellen.
- Build schlägt nach Wechsel zwischen Windows/Linux fehl: Installiere die Abhängigkeiten mit npm install für deine Plattform neu.
- SDK-Probleme: Prüfe Help → Show Developer Tools in Beekeeper.
Referenzen und Lizenz
MIT-Lizenz. Unabhängiges Community-Projekt; nicht von Beekeeper Studio unterstützt.