zeeshantariq/filament-sqlgen

A FilamentPHP package that generates SQL from natural language using Gemini AI.

v1.1.0 2025-04-30 12:03 UTC

Requires

• php: ^8.1
• filament/support: ^3.3
• guzzlehttp/guzzle: ^7.0

MIT

• Zeeshan Tariq

• ai
• Gemini
• filament
• filamentphp
• google-ai
• sqlgen
• text-to-sql
• natural-language-to-sql

README

A FilamentPHP package that integrates a Gemini-powered AI assistant into your Laravel admin panel — converting natural language into SQL and showing results in real-time.

Features

• Text-to-SQL AI: Converts natural language questions into SQL using Google Gemini and executes them securely.
• Read-only access: Executes only SELECT queries for safety.
• Interactive UI: Results are rendered in a styled HTML table within the Filament widget.
• Easy setup: Plug-and-play widget for any FilamentPHP admin panel.

Requirements

• Laravel 8 or above
• FilamentPHP 3.x or above
• A Gemini API key from Google AI

Installation

Install via Composer:

composer require zeeshantariq/filament-sqlgen

Configuration

1. Publish the views (optional)

php artisan vendor:publish --provider="ZeeshanTariq\FilamentSqlGen\FilamentSqlGenServiceProvider"

2. Publish the configuration file

php artisan vendor:publish --provider="ZeeshanTariq\FilamentSqlGen\FilamentSqlGenServiceProvider" --tag="config"

This will create a filament-sqlgen.php file in your config directory. You can customize various settings, such as the default table style or query timeout, in this configuration file.

3. Add your Gemini API key and other settings to .env

In your .env file, add the following configuration settings:

GEMINI_API_KEY=your-gemini-api-key-here
GEMINI_API_ENDPOINT=https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent
GEMINI_API_TIMEOUT=30
GEMINI_API_RETRY_ATTEMPTS=3
GEMINI_LOGGING_ENABLED=false
GEMINI_CACHE_ENABLED=true
GEMINI_CACHE_DURATION=60

• GEMINI_API_KEY: Your Google Gemini API key.
• GEMINI_API_ENDPOINT: The Gemini API endpoint for query generation.
• GEMINI_API_TIMEOUT: The timeout value for API calls (default is 30 seconds).
• GEMINI_API_RETRY_ATTEMPTS: The number of retry attempts for failed API calls (default is 3).
• GEMINI_LOGGING_ENABLED: Whether to log Gemini API calls (default is false).
• GEMINI_CACHE_ENABLED: Enable or disable caching of query results (default is true).
• GEMINI_CACHE_DURATION: The duration (in minutes) for caching query results (default is 60 minutes).

Usage

Add the widget to your Filament dashboard or resource page:

use ZeeshanTariq\FilamentSqlGen\Filament\Widgets\SqlGenWidget;

public static function getWidgets(): array
{
    return [
        SqlGenWidget::class,
    ];
}

Users can then type questions like:

"How many users signed up today?"

The AI will respond by generating and executing a query like:

SELECT COUNT(*) FROM users WHERE DATE(created_at) = CURDATE();

The results are shown in a neat, scrollable table.

Security

Only SELECT queries are allowed to prevent unwanted changes to your database. Write/update/delete operations are blocked by design.

Customization

To override the widget view:

1. Publish the views as shown above.
2. Modify the Blade view at:
   resources/views/vendor/filament-sqlgen/widgets/sql-gen-widget.blade.php

You can style it using Tailwind or customize the logic as needed.

Contributing

Contributions are welcome! Please fork the repo, make changes, and open a pull request.

License

This package is open-source and licensed under the MIT license.