SQLBot/README.md

Chat with your SQL database

---

SQLBot allows you to interact with your SQL database through advanced Text-to-SQL technology. This capability is powered by Large Language Models (LLMs) and Retrieval-Augmented Generation (RAG).

• Easy to use: TBD.
• Accurate text-to-sql generation: TBD.
• Easy to integrate: TBD.
• Supported databases: MySQL, PostgreSQL, Oracle, Microsoft SQL Server, PrestoDB, Apache Hive, Apache Doris, ClickHouse,etc.

How SQLBot works

TBD

Quick Start

Execute the script below to start a SQLBot container using Docker:

docker run -d --name=sqlbot --restart=always -p 8080:8080 -v ~/.sqlbot:/var/lib/postgresql/data 1panel/sqlbot

Access SQLBot web interface at http://your_server_ip:8080 with default admin credentials:

• username: admin
• password: SQLBot@123..

Screenshots

Technical Stack

• Frontend：Vue.js
• Backend：Python / Django
• Database：PostgreSQL + pgvector

Star History

License

Licensed under The GNU General Public License version 3 (GPLv3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.gnu.org/licenses/gpl-3.0.html

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.