Plugin et suite d’outils avancés pour Beekeeper Studio (v5.4+). Créé par T3zcaDev.
English · Español
L’interface du plugin est disponible en anglais et en espagnol ; change de langue depuis l’en-tête.
✨ Fonctionnalités clés
- 📸 Snapshots & sauvegardes intelligentes (1 clic) :
- Sauvegardes compressées à la volée avec Zstandard (
zstd -3) ou Gzip ultra-rapide. - Moteur hybride : streame directement via des pipes quand le daemon tourne, ou fait un dump natif depuis le navigateur avec
CompressionStreamquand il est hors ligne. - Explorateur local de snapshots avec date, taille et moteur, plus une restauration assistée avec modale de confirmation et protection contre le path traversal.
- Sauvegardes compressées à la volée avec Zstandard (
- 🔄 Live Stream Clone (A ➔ B) :
- Transfère des bases de données entières entre serveurs (Production/Staging ➔ Local/Docker) en temps réel via des pipes, sans écrire de fichiers temporaires sur le disque.
- Nettoyage automatique : supprime les instructions conflictuelles (
DEFINER,USE,CREATE DATABASE,SQL_LOG_BIN). - Filtrage des tables et masquage des données : exclut les tables de télémétrie et masque les e-mails et les données sensibles à la volée.
- Mode incrémental (modifications uniquement) : compare les empreintes de chaque table avec la dernière synchronisation et ne copie que ce qui a changé. Les tables marquées append-only ne copient que les nouvelles lignes. Conçu pour les grosses bases de données, où le deuxième import ne doit pas tout refaire à 100 %. Consulte docs/INCREMENTAL_SYNC.md.
- ⚖️ Schema Diff V2 multi-moteur & migrations :
- Prise en charge multi-moteur pour MySQL / MariaDB et PostgreSQL.
- Détecte les tables manquantes, les colonnes manquantes, les types incompatibles, les index et les clés étrangères.
- Double export : génère du DDL natif et du code de migration Laravel (
Blueprintavec les méthodesup()etdown()). Ouvre-le directement dans l’éditeur SQL de Beekeeper Studio ou enregistre-le en.sql/.php.
- 🩺 Audit de santé & de performance :
- Score de santé global (0 - 100) avec un indicateur tricolore et des pénalités configurables.
- Tables sans clé primaire : signale les tables qui dégradent la réplication par ligne (RBR) et les performances.
- Index redondants : repère les index strictement dupliqués et les préfixes redondants qui ralentissent les écritures
INSERT/UPDATE. - Répartition du stockage : taille des données vs. des index par tableau.
- Moniteur de processus en direct : affiche les threads et requêtes actifs (
SHOW PROCESSLIST/pg_stat_activity) avec un bouton pour arrêter une requête en toute sécurité (KILL QUERY <id>).
- 🧪 Générateur intelligent de données fictives & seeding en cascade (DAG) :
- Remplit n’importe quel tableau avec des données réalistes grâce à Faker.
- Tout peupler en cascade (graph seeding) : résout le graphe de dépendances des clés étrangères pour les tables vides, en remplissant d’abord les tables parentes puis en injectant automatiquement leurs ID dans les tables enfants.
- Export des seeds : exporte en
.sql(INSERT INTO),.csvet.json.
- 🐳 Auto-Discovery (Docker & projets locaux) :
- Détecte les conteneurs en cours d’exécution (
docker ps) pour MySQL, Postgres, MongoDB, Redis, ClickHouse et SQL Server, avec le mapping des ports de l’hôte. - Récupère les identifiants depuis les fichiers
.envlocaux, prêts à être enregistrés dans Beekeeper.
- Détecte les conteneurs en cours d’exécution (
- 📖 Dictionnaire de données :
- Exporte la documentation technique de la base de données en Markdown ou en HTML statique.
📋 Prérequis
- Beekeeper Studio 5.4+
- Node.js 18+ et npm — uniquement si tu installes via l’option B (symlink/développement). L’installeur natif du companion (option A) ne nécessite pas Node.js.
mysql/mysqldump,psql/pg_dump,mongodump,docker(selon le moteur que tu utilises) — le companion les appelle mais ne les embarque pas ; consulteTools ➔ DB Managerou/api/statuspour voir lesquels il détecte.- CLI
sqlite3(facultatif, uniquement pour lire les connexions déjà enregistrées dans Beekeeper)
🔒 Confidentialité
Tout le traitement se fait sur ta machine. Le daemon companion écoute uniquement sur 127.0.0.1:58765 (loopback) et ne communique jamais avec des serveurs externes. Tes identifiants de connexion ne quittent jamais ton ordinateur.
🚀 Installation et démarrage automatique
Option A : marketplace Beekeeper Studio + installeur natif (recommandé)
- Installe DB Manager Pro depuis la marketplace de plugins de Beekeeper Studio (
Plugins➔ recherche « DB Manager Pro »). - La première fois que tu ouvres un outil qui a besoin du companion (Stream Clone, Auto-Discovery, Schema Diff), tu verras un avis « Companion Daemon not responding » avec un bouton Download Companion — télécharge l’exécutable pour ton OS depuis les GitHub Releases et ouvre-le d’un double-clic.
- C’est tout : l’exécutable s’installe tout seul, s’enregistre pour démarrer à la connexion (Linux
systemd --user, macOSLaunchAgent, WindowsStartup) et se lance. Pas besoin d’installer Node.js ni de garder un terminal ouvert.
L’installeur n’est pas encore signé (voir docs/COMPANION.md), donc Windows/macOS afficheront un avertissement de sécurité la première fois — ce document t’explique exactement sur quel bouton cliquer pour continuer.
⚠️ Mode lecture seule (Beekeeper Studio 6.2+)
Beekeeper Studio 6.2 installe les plugins en mode lecture seule par défaut, ce qui bloque les écritures faites via runQuery. DB Manager Pro a besoin qu’il soit désactivé pour Stream Clone, la génération de Mock Data, l’application des migrations Schema Diff et l’annulation de processus depuis l’audit de santé ; l’option se trouve dans les paramètres du plugin (Plugins ➔ DB Manager Pro). Les snapshots, le dictionnaire de données, l’Auto-Discovery et l’inspection de santé fonctionnent toujours en lecture seule.
Option B : symlink pour le développement/la contribution
git clone https://github.com/JonathanHerSa/bks-db-manager.git
cd bks-db-manager
npm install
npm run build
ln -s "$(pwd)" ~/.config/beekeeper-studio/plugins/t3zca-db-manager
npm install laisse déjà le daemon companion tourner en arrière-plan, configuré pour démarrer automatiquement et pointant vers le dépôt cloné (pas le binaire natif) — aucune commande ni fenêtre de terminal supplémentaire pour utiliser le plugin.
Beekeeper Studio 6.2+ : le système de plugins a ajouté
unlistedDisabled, activé par défaut. Pour que Beekeeper charge le symlink de développement, ajoute ceci à~/.config/beekeeper-studio/user.config.ini:[pluginSystem] disabled = false unlistedDisabled = false communityDisabled = false
Gestion manuelle du service (facultatif)
Tu n’en as besoin que si tu as installé avec npm install --ignore-scripts, déplacé le dossier du projet, ou si tu veux le désactiver :
# (Re)install the background service manually
npm run daemon:install
# Check that it is running and responding
npm run daemon:status
# Uninstall it at any time
npm run daemon:uninstall
(Tu peux aussi le lancer temporairement dans un terminal avec npm run server au lieu du service persistant.)
L’ouvrir dans Beekeeper Studio
- Ouvre Beekeeper Studio et connecte-toi à n’importe quelle base de données.
- Tous les outils sont accessibles depuis la barre du haut, sous
Tools(les libellés du menu de l’app sont pour l’instant en espagnol) :Tools➔DB Manager: Snapshots & BackupsTools➔DB Manager: Clonado Stream (A ➔ B)— clone en streaming en directTools➔DB Manager: Schema Diff & Migraciones— diff de schéma & migrationsTools➔DB Manager: Auditor de Salud & Rendimiento— audit de santé & de performanceTools➔DB Manager: Generador Mock Data— générateur de données fictivesTools➔DB Manager: Diccionario de Datos— dictionnaire de donnéesTools➔DB Manager: Auto-Discovery (Docker & .env)- Ou fais un clic droit sur n’importe quel tableau ➔
DB Manager: Mock Data para esta tabla.
Mode développement avec Hot Reload (facultatif)
Pour modifier les composants Vue et voir les changements instantanément :
npm run dev
📦 Build et releases
npm run build # plugin frontend -> dist/
npm run companion:build # native companion binary for your OS -> build/
Chaque push de tag vX.Y.Z déclenche .github/workflows/release.yml, qui build et publie une seule GitHub Release contenant :
manifest.jsonett3zca-db-manager-{version}.zip(le frontend du plugin, selon le processus de publication de Beekeeper Studio Plugins).bks-db-manager-companion-{linux-x64,linux-arm64,darwin-arm64,win-x64}.{tar.gz,zip}+ leurs.sha256(l’installeur natif du companion, voir docs/COMPANION.md) — sans version dans le nom, pour pouvoir toujours les lier depuis/releases/latest/download/. macOS Intel (x64) est encore en attente à cause d’un bug Node.js ouvert (nodejs/node#62893).
🤝 Contribuer
Les issues et pull requests sont les bienvenues. Avant d’ouvrir une grosse PR, ouvre d’abord une issue pour discuter du changement.
📄 Licence
Ce projet est sous licence GPLv3 — consulte LICENSE pour le texte complet.
👤 Auteur
T3zcaDev — GitHub (@JonathanHerSa)