laraforge/database-studio

Headless Database Studio & Visual Table Explorer GUI for Laravel applications.

Maintainers

Package info

github.com/abhishekparmar1994/laraforgeX-Database-Studio

Language:Blade

pkg:composer/laraforge/database-studio

Transparency log

Statistics

Installs: 15

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

1.0.9 2026-07-29 09:11 UTC

This package is auto-updated.

Last update: 2026-07-30 11:50:40 UTC


README

URL : https://packagist.org/packages/laraforge/database-studio

LaraforgeX Database Studio & Table Manager GUI

Latest Version on Packagist Total Downloads License

A self-contained, powerful LaraforgeX Database Studio & Table Manager GUI for Laravel 10, 11, 12, and 13 applications.

📸 Screenshots

Dashboard Explorer Visual Table Creator
Dashboard Explorer Visual Table Creator
Table Column Modifier Browse Data & Filter Builder
Table Column Modifier Browse Data with Filters
Interactive SQL Console Security Login Gateway
Interactive SQL Console Security Login Gateway

🌟 Key Features

  • 🔐 Security Gateway & Auth Guard: Protected with an authentication login gateway (customizable via .env credentials).
  • Zero DB Setup Needed: Automatically detects and uses your host Laravel application's active database connection credentials from your .env file out-of-the-box.
  • 📊 Interactive Database Dashboard: View table engine types, estimated row counts, data/index disk sizes, and table collations.
  • 🛠️ Visual Table Creator Wizard: Design new database tables, define column data types, precision, nullability, auto-increments, and default values.
  • 🔍 Schema Inspector & Data Grid: Inspect columns, indexes, foreign keys, filter records in real-time with AND logic rules, and browse live rows.
  • 💻 Interactive SQL Console: Execute raw SELECT, INSERT, UPDATE, ALTER, or CREATE queries directly from your browser.
  • 📥 One-Click CSV / Excel Exporter: Export filtered table records directly to UTF-8 CSV or XML Excel formats.
  • 🔒 Safety Guards: Protect critical system tables (migrations, failed_jobs, users) from accidental truncation or dropping.

🔐 Security Authentication (.env Setup)

To prevent unauthorized access to your database manager, Database Studio includes a built-in security gateway login screen.

Set your security credentials in your .env file:

DB_STUDIO_AUTH_ENABLED=true
DB_STUDIO_AUTH_USERNAME=admin@admin.com
DB_STUDIO_AUTH_PASSWORD=admin123

When users visit /database-studio, they will be prompted to enter the username and password defined above before gaining access to the database dashboard, console, or API.

⚡ Automatic Database Credentials (.env Integration)

No manual database setup or credentials entry is required!

Database Studio automatically reads your active database connection (DB_HOST, DB_PORT, DB_DATABASE, DB_USERNAME, DB_PASSWORD) from your application's .env file:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database_name
DB_USERNAME=root
DB_PASSWORD=secret

🚀 Installation Guide

Option 1: Installing Locally for Development (e.g. in C:\laragon\www\jobQueue)

Since the package is located on your local disk at C:/laragon/www/laravel-database-studio, configure Composer in your target project (jobQueue) to use a local path repository:

  1. Open your target application's composer.json (e.g. C:\laragon\www\jobQueue\composer.json).
  2. Add the "repositories" block:
"repositories": [
    {
        "type": "path",
        "url": "../laravel-database-studio",
        "options": {
            "symlink": true
        }
    }
]
  1. Run the require command in your terminal:
composer require laraforge/database-studio:@dev

Option 2: Installing Globally via Packagist (Public Package)

Once you upload this repository to GitHub and submit it to Packagist.org, anyone anywhere in the world can install it directly by running:

composer require laraforge/database-studio

Step 2: Publish Configuration (Optional)

Publish the database-studio.php config file to customize route path, middleware, and protected tables:

php artisan vendor:publish --tag=database-studio-config

Step 3: Access the Web Dashboard

Open your browser and navigate to:

http://mysite.test/database-studio

🗑️ Uninstalling & Removing Package

To completely remove Database Studio from a Laravel application:

Step 1: Remove via Composer

composer remove laraforge/database-studio

Step 2: Clear Laravel Cache

php artisan optimize:clear

⚙️ Configuration (config/database-studio.php)

return [
    'enabled' => env('DB_STUDIO_ENABLED', true),
    'path' => env('DB_STUDIO_PATH', 'database-studio'),
    'api_prefix' => env('DB_STUDIO_API_PREFIX', 'api/v1/database-manager'),
    'auth' => [
        'enabled'  => env('DB_STUDIO_AUTH_ENABLED', true),
        'username' => env('DB_STUDIO_AUTH_USERNAME', 'admin@admin.com'),
        'password' => env('DB_STUDIO_AUTH_PASSWORD', 'admin123'),
    ],
    'middleware' => [
        'web' => ['web'],
        'api' => ['web', 'api'],
    ],
    // Automatically fetched from env('DB_CONNECTION') if null
    'connection' => env('DB_STUDIO_CONNECTION', null),
    'protected_tables' => [
        'migrations',
        'failed_jobs',
        'personal_access_tokens',
        'password_reset_tokens',
    ],
];

📄 License

The MIT License (MIT). Please see License File for more information.