PHPackages                             suman/sql-analyzer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. suman/sql-analyzer

ActiveLibrary[Database & ORM](/categories/database)

suman/sql-analyzer
==================

A Laravel package for an SQL editor and visualizer with autocomplete and paginated results.

09Blade

Since Mar 18Pushed 2mo agoCompare

[ Source](https://github.com/suman98/laravel-sql-editor)[ Packagist](https://packagist.org/packages/suman/sql-analyzer)[ RSS](/packages/suman-sql-analyzer/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependenciesVersions (1)Used By (0)

SQL Analyzer Package
====================

[](#sql-analyzer-package)

A Laravel package that provides a SQL editor UI with query execution, saved queries, and optional AI-assisted SQL generation.

Requirements
------------

[](#requirements)

- PHP 8.2+
- Laravel 12+
- Python 3.8+ (for AI-assisted query generation)

Installation
------------

[](#installation)

1. Require the package (local path or VCS):

```
composer require suman/laravel-sql-editor
```

2. Publish package assets:

```
php artisan vendor:publish --tag=sql-analyzer-config
php artisan vendor:publish --tag=sql-analyzer-views
php artisan vendor:publish --tag=sql-analyzer-migrations
```

3. Run migrations:

```
php artisan migrate
```

4. (Optional) Install the Python environment for AI generation:

```
php artisan sql-analyze:install
```

Configuration
-------------

[](#configuration)

The config file is published to `config/sql-analyzer.php`.

- `prefix`: Route prefix for the UI (default: `sql-analyzer`)
- `middleware`: Middleware for routes (default: `web`)
- `connection`: Database connection name (default: null)
- `max_rows`: Max rows returned for queries (default: 1000)
- `allowed_statements`: Allowed SQL statements (default: `select`)
- `root_url`: Optional root URL override for the package
- `openai_api_key`: Optional OpenAI API key override

Environment options:

```
SQL_ANALYZER_ROOT_URL=
SQL_ANALYZER_OPENAI_API_KEY=
OPENAI_API_KEY=
```

For Python database access, set your DB settings in `.env`:

```
DB_CONNECTION=pgsql
DB_HOST=127.0.0.1
DB_PORT=5432
DB_DATABASE=your_db
DB_USERNAME=your_user
DB_PASSWORD=your_password
```

Usage
-----

[](#usage)

Open the UI in your browser:

```
/{prefix}

```

Example (default prefix):

```
/sql-analyzer

```

AI Query Generation
-------------------

[](#ai-query-generation)

If you enable prompted query in the UI, the package will use the Python agent to generate SQL. Make sure:

- Python venv is installed via `php artisan sql-analyze:install`
- `OPENAI_API_KEY` or `SQL_ANALYZER_OPENAI_API_KEY` is set
- The database credentials are configured in `.env`

Troubleshooting
---------------

[](#troubleshooting)

- If the Python script cannot be found, verify the package is installed correctly and rerun `php artisan sql-analyze:install`.
- If you see context length errors, reduce the number of selected tables.

License
-------

[](#license)

MIT

###  Health Score

20

—

LowBetter than 13% of packages

Maintenance56

Moderate activity, may be stable

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/b3cd140229f528c83a8b05dd48dd3622c5efdeace4f2bfee3b6b7ee8f1317fc3?d=identicon)[suman98](/maintainers/suman98)

---

Top Contributors

[![suman98](https://avatars.githubusercontent.com/u/41943773?v=4)](https://github.com/suman98 "suman98 (16 commits)")

### Embed Badge

![Health badge](/badges/suman-sql-analyzer/health.svg)

```
[![Health](https://phpackages.com/badges/suman-sql-analyzer/health.svg)](https://phpackages.com/packages/suman-sql-analyzer)
```

###  Alternatives

[jdorn/sql-formatter

a PHP SQL highlighting library

3.9k116.5M113](/packages/jdorn-sql-formatter)[propel/propel1

Propel is an open-source Object-Relational Mapping (ORM) for PHP5.

8361.6M87](/packages/propel-propel1)[mpociot/laravel-composite-key

Support composite keys in your laravel app.

3544.8k1](/packages/mpociot-laravel-composite-key)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)