menu
languageFrançais
save_alt Télécharger

Column Finder

Trouve des colonnes dans les tables et vues PostgreSQL, MySQL et MariaDB grâce à des recherches de schéma en lecture seule.

par Vitor Hugo Plugin communautaire

Readme

Ce texte a été écrit par un tiers et traduit automatiquement. Lire l'original en anglais

CI

Un plugin Beekeeper Studio en lecture seule pour trouver des colonnes dans toutes les tables et vues de la base de données active.

Compatible avec PostgreSQL, MySQL et MariaDB. Les recherches partielles, insensibles à la casse, affichent le schéma, la table/vue, la colonne et le type de données. Un raccourci Structure ouvre les tables correspondantes si elles figurent dans la liste d’entités chargée par Beekeeper. Résultats limités à 500. Aucune télémétrie, aucun serveur supplémentaire, aucun identifiant de base de données.

Important : le plugin s’ouvre dans son propre onglet via la flèche à côté de +. Le SDK officiel ne permet pas aux plugins de modifier le filtre natif de la barre latérale.

Installer depuis l’artefact CI (sans Node)

  1. Ouvre Actions → CI et télécharge l’artefact beekeeper-column-finder d’une exécution réussie.
  2. Extrais son manifest.json et son dist/ dans un dossier nommé beekeeper-column-finder dans le répertoire des plugins de 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. Active les plugins communautaires (voir ci-dessous), redémarre complètement Beekeeper, puis ouvre Column Finder depuis le menu déroulant à côté de +.

Arborescence attendue : beekeeper-column-finder/manifest.json et beekeeper-column-finder/dist/index.html, plus dist/assets/.

La CI compile sur Windows et Ubuntu avec Node.js 22, lance les tests unitaires, puis publie un bundle de plugin installable (disponible 30 jours ; le téléchargement des artefacts GitHub peut nécessiter une connexion).

Installer depuis les sources (Windows PowerShell)

Lance ces commandes dans 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
}

Si tu as déjà lié une ancienne version, ne recrée pas la jonction. Récupère les dernières sources, lance npm install, npm test, npm run build, puis redémarre Beekeeper.

Activer les plugins communautaires (Beekeeper 5.7+)

Sous Windows, ouvre le fichier de paramètres :

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

Ajoute ou mets à jour une seule section pluginSystem en conservant tes autres paramètres :

[pluginSystem]
disabled = false
communityDisabled = false

N’ajoute pas l’ID de Column Finder dans allow[] ; seuls les ID des plugins intégrés y sont acceptés. Cette configuration autorise aussi d’autres plugins tiers, alors n’installe que ceux en qui tu as confiance. Le system.config.ini d’un administrateur peut écraser les paramètres utilisateur.

Dans Beekeeper, ouvre Tools → Manage Plugins pour vérifier que Column Finder est activé. Redémarre si besoin. Utilise ensuite le menu déroulant des onglets à côté de +.

Fonctionnement et limites

Base de données Portée de la recherche
PostgreSQL Tous les schémas utilisateur accessibles dans la base active, sauf pg_catalog, information_schema et pg_toast*
MySQL DATABASE(), la base sélectionnée
MariaDB DATABASE(), la base sélectionnée

La recherche lit uniquement information_schema.columns et reflète tes droits sur les métadonnées. Elle utilise une saisie UTF-8 encodée en hexadécimal, ce qui empêche l’injection SQL et traite littéralement les caractères pourcentage et underscore. Aucune écriture n’est exécutée. Jusqu’à 500 résultats sont affichés, avec une indication s’il y en a davantage.

Le raccourci Structure dépend de la liste de tables déjà chargée par Beekeeper. Actualise la liste d’entités si une table est trouvée mais que la navigation échoue. Pour MySQL et MariaDB, la navigation omet le schéma afin de correspondre à la représentation interne de l’hôte. Certains schémas PostgreSQL peuvent aussi être absents du cache de l’hôte.

Développement et tests

npm install
npm test
npm run build
npm run dev
  • Le test runner intégré de Node vérifie la génération SQL, la résistance aux injections, les dialectes et les options de navigation vers les tables (8 tests unitaires).
  • Le compilateur TypeScript vérifie les types et Vite compile le plugin pour la production.
  • GitHub Actions lance les tests et la compilation sur Windows et Ubuntu, puis publie manifest.json + dist en tant qu’artefact.
  • Les tests unitaires n’exécutent pas de requêtes sur de vraies bases de données ; vérifie l’intégration MySQL/PostgreSQL/MariaDB manuellement.

Structure du projet : src/sql.ts (SQL), src/navigation.ts (navigation dans les onglets de l’hôte), src/main.ts (intégration du SDK), src/style.css et index.html (interface), tests/*.test.mjs (tests unitaires) et .github/workflows/ci.yml (automatisation).

Dépannage

  • Plugin absent/désactivé : vérifie Tools → Manage Plugins et user.config.ini.
  • Ancienne version : inspecte le manifest.json dans le vrai répertoire du plugin ou dans la cible de la jonction.
  • Structure affiche « Table not found » : actualise les entités ; l’hôte n’ouvre que les tables en cache.
  • La compilation échoue après un passage Windows/Linux : réinstalle les dépendances avec npm install pour ta plateforme.
  • Problèmes de SDK : consulte Help → Show Developer Tools dans Beekeeper.

Références et licence

Licence MIT. Projet communautaire indépendant, non approuvé par Beekeeper Studio.