DevDb

VS Code Marketplace page ⋅ Open VSX Registry page

A lightweight VS Code extension that auto-loads your database and provides affordances from your database to aid development and debugging.

Built with 💖 for developers.

Featured In

Latest Features

1. New zero-config support: applications running in DDEV
2. New zero-config support: Adonis (Lucid ORM) - MySQL and PostgreSQL
3. One-click reconnection

Sponsors

We are genuinely grateful to the following sponsors of DevDb:

• Traycer AI - A Powerful AI assistance, natively integrated into your VS Code workflow.

Features

• Zero-config Automatic Database Integration: Automatically load your database with no manual configuration required. Supports environments like DDEV, Adonis (Lucid ORM for MySQL and PostgreSQL), Laravel (default local SQLite, MySQL/MariaDB, PostgreSQL, and Microsoft SQL Server), containerized setups (Laravel Sail), etc.

• Database affordances: Because of a deep understanding of your database schema, DevDb is able to provide affordances that aid development and debugging, such as one-click generation of model factory files, etc.

• Context Menu & CodeLens Integrations: Access powerful directly from your editor, such as opening tables, generating Laravel factories from models, and invoking SQL query explainers to optimize queries.

• One-click Actions with Intuitive UX: Dedicated view with one-click data browsing, inline editing, deletion, one-click reconnection, etc. Easily modify, set values to null, and preview complex JSON data, all within a responsive interface.

• Data Export: Export table data as well-formatted JSON or SQL INSERT statements with a single click ― copied to the clipboard or saved to file.

• Comprehensive Multi-database Support: Seamlessly interface with SQLite, MySQL, MariaDB, PostgreSQL, and Microsoft SQL Server.

• Enhanced Developer Productivity: Leverage a rich configuration system via the .devdbrc file to configure database connection in environments that does not yet support Zero-config, with quick snippets to easily configure your connections, JSON Schema validation IntelliSense.

• Integrated Framework & Tool Support: Tailored support for popular frameworks and tools including Laravel, DDEV, and Adonis ensures a seamless development experience, with specialized providers for each environment.

• Cross-platform Compatibility: Engineered to perform consistently on Linux, macOS, and Windows, ensuring maximum flexibility regardless of your development platform.

Screenshots

Requirements

• VS Code 1.83 or newer
• A VS Code project using any of the supported databases

OS/Platform Support

• Linux (Linux-x64, Linux-arm64, Linux-arm, Alpine-x64)
• macOS (Darwin-x64, Darwin-arm64 Apple Silicon)
• Windows (Win32-x64)

Quick Start

• In a VS Code project using any of the supported databases, ensure your database is properly configured and accessible from your application code.
• For zero-config environments, DevDb auto-loads your database. View your database by opening the DevDb view like in the screenshot shown, or by using the shortcut.

[!NOTE] DevDb also provides several Language and Framework Integrations

UI Actions and Key Map

• Cmd + K + D to toggle the view panel
• Cmd + Click table name in the sidebar to open the table in the current tab
• Cmd + Click on a database value to edit it
• Click any value to preview it in the pane (useful for viewing prettified JSON string values)
• The right pane offers options to view the current table schema or selected value
• During edit sessions (activated during data edit/delete), the control box appears as shown in the screenshot
• During edit sessions: Cmd + Z to undo changes, Cmd + Y to redo changes, and Cmd + S to save changes
• Added new "Suggest New Feature" button

One-click Actions (Data Manipulation)

• Click the trash icon on a table row to delete it
• Click the Set null button on a database value to set the value to null

Supported Databases

Currently supported databases:

• SQLite
• MySQL
• MariaDB
• PostgreSQL*
• Microsoft SQL Server

Loading Databases

DevDb can automatically load your database using connection details from your VS Code workspace (zero-config mode). When zero-config support isn't available, a configuration file option is provided.

1. Zero-config (Automatic Database Loading)

No configuration file is needed when the workspace root contains any of the following:

1. Applications managed by DDEV
2. Adonis using default .env config for MySQL and PostgreSQL (with Lucid ORM)
3. Laravel with default local SQLite database
4. Laravel with default .env config for MySQL/MariaDB, PostgreSQL, and Microsoft SQL Server
5. Containerized Laravel MySQL (Laravel Sail) with default .env/docker-compose.yml config (including dev containers support)

2. Config-based Database Loading

If zero-config support isn't available for your environment, create a .devdbrc file in your project root with your database connection details.

[!WARNING] Exclude the .devdbrc config file from version control by adding it to .gitignore. This protects sensitive information and allows team members to use different database configurations.

The configuration file should contain a single array of database connection objects. DevDb provides rich editing features for .devdbrc:

• JSON Schema Validation: Automatic configuration validation
• IntelliSense: Autocompletion for all fields, including type
• Snippets: Quick configuration templates:
  • devdb mysql: MySQL configuration
  • devdb mariadb: MariaDB configuration
  • devdb postgres: PostgreSQL configuration
  • devdb sqlite: SQLite configuration
  • devdb mssql: Microsoft SQL Server configuration

Configuration File Example

[
	{
		"name": "My test MySQL database",
		"type": "mysql",
		"host": "127.0.0.1",
		"port": "3306",
		"username": "root",
		"password": "12345",
		"database": "test" // <-- the database to show in VS Code DevDb view
	},
	{
		"type": "sqlite",
		"path": "/path/to/database.sqlite"
	}
]

Tools and Framework Integrations

Context Menu Entry

Open any database table in DevDb by right-clicking its name/model/entity from the editor in any framework/programming language.

Example from a Node.js app

Laravel

Eloquent Model Code Lens

DevDb provides Code Lens features for:

• Viewing the underlying table for the Eloquent model
• Generating a factory for the model (automatically pre-filled with real data from the underlying table)

[!NOTE] Factory Generation is also available via the context menu

Query Explainer

The Query Explainer integrates with MySQL Visual Explain to optimize SQL queries by analyzing MySQL's query execution plan. Usage:

1. Open a Laravel PHP file containing SQL query (Eloquent or DB facade)
2. Select the SQL query to analyze
3. Click the Explain query Code Lens or select Explain query from the context menu
4. View the explanation in your browser or copy the URL

[!NOTE] VS Code multi-root workspaces support is in development. Track progress here.

Support

You can support the development of DevDb by contributing or by sponsoring the development. We appreciate your DevDb sponsorships with perks. Check the sponsorship page for available sponsorship options.

We also appreciate your support by saying 'thank you' to our existing sponsors by patronizing or subscribing to the amazing services they offer:

• Traycer AI

Contribution

[!IMPORTANT] Contributions are currently limited to the extension core code. UI code is not available for public contribution.

1. Fork this repository and clone your fork locally
2. Run bun install to install dependencies
3. Make your contributions to the codebase
4. Press F5 to launch the debugger and test changes locally
5. Run test suites with bun run test-services and ensure all tests pass
6. Push changes to your fork
7. Open a PR to this repository
8. Take your flowers! 💐🌺🌹