sqlchat/sqlchat
Sqlchat
SQL Chat is a Docker-deployed chat interface that translates natural language questions into SQL queries and executes them against connected databases. It uses a large language model to generate SQL from plain English instructions, supporting both querying and record modification through INSERT, UPDATE, and DELETE statements within the chat conversation flow.
The application connects to MySQL, PostgreSQL, MSSQL, TiDB Cloud, and OceanBase databases through a unified driver abstraction layer, allowing users to interact with multiple database types from a single chat interface. Users provide their own OpenAI API key for authentication, or can configure a custom API endpoint to use self-hosted or third-party AI models like Ollama. An optional database-backed account system tracks per-user usage, enforces spending limits, and processes payments.
The project is packaged as a Docker container with environment variable configuration for authentication and AI service settings, enabling straightforward self-hosted deployment.
Features
- LLM-Based SQL Generation - Translates natural language queries into SQL statements using a large language model API.
- Docker Container Deployments - Packaged as a Docker container with environment variable configuration for easy self-hosted deployment.
- Natural Language Query Interfaces - Provides a chat interface that translates natural language into SQL queries against connected databases.
- Natural Language Querying Interfaces - Translates plain English questions into SQL queries and executes them against connected databases, returning results in a chat interface.
- SQL Assistants - Ships a self-hosted SQL assistant that uses custom AI endpoints for natural language to SQL translation.
- Natural Language to SQL - Converts plain English questions into executable SQL queries using a large language model API.
- Mutation Statements - Generates and executes INSERT, UPDATE, and DELETE SQL from natural language instructions.
- Database Driver Abstractions - Provides a unified interface for connecting to multiple database types through a common driver abstraction.
- Natural Language Modifications - Inserts, updates, or deletes records in supported databases by giving natural language instructions instead of writing SQL.
- Natural Language Querying - Translates plain English questions into SQL queries executed against connected databases.
- Multi-Database Connections - Connects to MySQL, PostgreSQL, MSSQL, TiDB Cloud, and OceanBase databases through a single chat interface.
- Multi-Database Connectors - Connects to MySQL, PostgreSQL, MSSQL, TiDB Cloud, and OceanBase databases through a unified interface.
- Chat-Based Interfaces - Connects to MySQL, PostgreSQL, MSSQL, TiDB Cloud, and OceanBase databases through a unified chat interface for querying and management.
- Chat-Integrated Command Execution - Executes generated SQL queries and returns results directly within the chat conversation flow.
- Database-Connected Clients - Connects to MySQL, PostgreSQL, MSSQL, TiDB Cloud, and OceanBase databases for querying and modifying records through natural language.
- Self-Hosted AI Models - Configures a custom OpenAI API endpoint to use locally hosted AI models like Ollama for processing queries.
- Custom API Endpoints - Supports custom OpenAI-compatible endpoints for using locally hosted AI models like Ollama.
- Custom API Endpoints - Allows users to specify a custom OpenAI-compatible API endpoint for using self-hosted or third-party AI models.
- API Key Authentication - Accepts an OpenAI API key supplied directly through the user interface for authenticating AI service requests.
- User-Provided Keys - Allows users to provide their own OpenAI API key through the interface for authenticating AI service requests.
- Database Tools - Chat-based SQL client and editor.
- SQL Enhancement - Tool for converting natural language into SQL queries.
- Programming Tools - Chat-based SQL client for natural language database queries.
