ContextQMD
Back to Chat2db

README

README.md

3.4.111.9 KB
Original Source
<div align="center"> <h2>๐Ÿš€ Zoer is Launching</h2> <p><strong>Powered by Chat2DB Team - AI-powered app builder that creates professional applications in minutes, no coding required</strong></p> <a href="https://zoer.ai/?utm_source=chat2db&utm_medium=banner&utm_campaign=github" target="_blank"> </a>
<a href="https://trendshift.io/repositories/11808" target="_blank"> </a> </div> <div align="center">

</div> <div align="center"> <a href="./README.md"></a> <a href="./README_CN.md"></a> <a href="./README_JA.md"></a> </div>

1. Intelligent SQL Generation:
Chat2DB Pro supports AI-driven intelligent SQL development to help you write SQL queries faster.

2. Database Management:
Supports more than 10 databases, including MySQL, PostgreSQL, H2, Oracle, SQLServer, SQLite, MariaDB, ClickHouse, DM, Presto, DB2, OceanBase, Hive, KingBase, MongoDB, Redis, Snowflake, and more.

3. Intelligent Report Generation:
Chat2DB Pro supports AI-driven intelligent data reporting to help you generate dashboards faster.

4. Data Structure Synchronization:
Chat2DB Pro supports database table structure synchronization to help you sync database table structures faster.

Feature Comparison

<table style="width: 100%;"> <tr> <th align="center">Feature</th> <th align="center">Community Open Source</th> <th align="center">Local</th> <th align="center">Pro </th> </tr> <tr> <td align="center">Database Types</td> <td align="center">16+</td> <td align="center">Target 100+</td> <td align="center">Target 100+</td> </tr> <tr> <td align="center">Supported AI</td> <td align="center">Requires AI Configuration</td> <td align="center">AI ready on installation</td> <td align="center">AI ready on installation</td> </tr> <tr> <td align="center">AI Capabilities</td> <td align="center">Basic</td> <td align="center">Varied</td> <td align="center">Varied</td> </tr> <tr> <td align="center">Visual Table Editor</td> <td align="center">โœ…</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">SQL Console</td> <td align="center">โœ…</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">SQL Formatting</td> <td align="center">โœ…</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Save Query Records</td> <td align="center">โœ…</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Theme Color Settings</td> <td align="center">โœ…</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Data Structure Sync</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Database Grouping</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Database Structure Import/Export</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Data Import/Export</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Data Migration</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Copy/Clear Table</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Open and Run SQL Files</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">UML Diagram</td> <td align="center">โŒ</td> <td align="center">In Development</td> <td align="center">In Development</td> </tr> <tr> <td align="center">Generate Code</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Copy Results as Insert/Update</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Modify Query Results</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Intelligent SQL Editor</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">AI Table Creation</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">AI Data Sets</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Chat2Excel</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Intelligent Dashboard</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Editor Settings</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Custom Shortcuts</td> <td align="center">โŒ</td> <td align="center">โœ…</td> <td align="center">โœ…</td> </tr> <tr> <td align="center">Cross-device Usage</td> <td align="center">โŒ</td> <td align="center">โŒ</td> <td align="center">โœ…</td> </tr> </table>

Download and Installation

Chat2DB is a cross-platform application that supports Windows, MacOS, and Linux. You can download Chat2DB from the following links:

Community Edition Docker Installation

System Requirements

Before installing Chat2DB, ensure your system meets the following requirements:

  • Docker 19.03.0 or later
  • Docker Compose 1.25.0 or later
  • CPU >= 2 Cores
  • RAM >= 4 GiB
bash
  docker rm chat2db
  
  docker run --name=chat2db -ti -p 10824:10824 -v ~/.chat2db-docker:/root/.chat2db  chat2db/chat2db:latest

  docker start chat2db

Code Debugging

Runtime Environment

Note: If local debugging is needed:

  • Java runtime: <a href="https://adoptopenjdk.net/" target="_blank">Open JDK 17</a>
  • Node.js runtime: Node 16 <a href="https://nodejs.org/" target="_blank">Node.js</a>.

Clone the repository locally

bash
$ git clone [email protected]:chat2db/Chat2DB.git

Frontend Debugging

bash
Node version must be 16 or higher  
Use yarn only, npm is not supported
$ cd Chat2DB/chat2db-client
$ yarn
$ yarn run start:web

Backend Debugging

bash
$ cd ../chat2db-server
$ mvn clean install # Maven version 3.8 or higher is required
$ cd chat2db-server/chat2db-server-start/target/
$ java -jar -Dloader.path=./lib -Dchatgpt.apiKey=xxxxx chat2db-server-start.jar  # ้œ€่ฆๅฎ‰่ฃ…java 17ไปฅไธŠ็‰ˆๆœฌ๏ผŒๅฏๅŠจๅบ”็”จ chatgpt.apiKey ้œ€่ฆ่พ“ๅ…ฅChatGPT็š„key,ๅฆ‚ๆžœไธ่พ“ๅ…ฅๆ— ๆณ•ไฝฟ็”จAIGCๅŠŸ่ƒฝ

Standalone Deployment

bash
# chat2db-client
$ npm run build:web:prod 
$ cp -r dist ../chat2db-server/chat2db-server-start/src/main/resources/static/front 
$ cp -r dist/index.html ../chat2db-server/chat2db-server-start/src/main/resources/thymeleaf

Contact Us

Acknowledgments

Thanks to everyone who has contributed to Chat2DB~~

<a href="https://github.com/chat2db/Chat2DB/graphs/contributors"> </a>

Star History

<a href="https://star-history.com/#CodePhiliaX/chat2db&Date"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=CodePhiliaX/chat2db&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=CodePhiliaX/chat2db&type=Date" /> </picture> </a>

License

The primary license used by this software is the Apache License 2.0, supplemented by the Chat2DB License.