Generate beautiful database documentation and safely deploy schemas—all from VS Code.
Features
✨ Generate Docs — Auto-create markdown documentation from your database schema 🚀 Safe Deployment — Deploy schemas with automatic backups and permission checking 🔐 Permission Checking — Know exactly what operations you can perform 💾 Auto-Backups — Never lose data with automatic backups before changes 📋 Dry-Run Preview — See what will change before deploying ⚙️ Multi-Database — Works with PostgreSQL, MySQL, and SQLite
Quick Start
1. Configure Your Database
Open VS Code Settings and search for "db-schema-manager":
{
"db-schema-manager.dbType": "postgres",
"db-schema-manager.host": "localhost",
"db-schema-manager.user": "postgres",
"db-schema-manager.password": "yourpassword",
"db-schema-manager.database": "mydb"
}
2. Generate Documentation
- Open Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
- Type: "DB Schema Manager: Generate Documentation"
- Documentation opens as
DATABASE.md
3. Check Permissions
- Open Command Palette
- Type: "DB Schema Manager: Check Permissions"
- See what operations you can perform
4. Deploy Schema
- Open Command Palette
- Type: "DB Schema Manager: Deploy Schema"
- Choose preview (dry-run) or deploy
- Confirm and deploy
Commands
DB Schema Manager: Generate Documentation- Create markdown docs from schemaDB Schema Manager: Check Permissions- Verify deployment permissionsDB Schema Manager: Deploy Schema- Deploy schema safely with backups
Configuration
db-schema-manager.dbType (default: "postgres")
- Database type: postgres, mysql, or sqlite
db-schema-manager.host (default: "localhost")
- Database host/server address
db-schema-manager.port (optional)
- Database port number
db-schema-manager.user (default: "postgres")
- Database username
db-schema-manager.password
- Database password (masked in settings)
db-schema-manager.database (required)
- Database name to connect to
Supported Databases
- PostgreSQL 9.6+
- MySQL 5.7+
- SQLite 3.0+
Security
🔒 Passwords are masked in VS Code settings Always use environment variables for sensitive data
License
MIT