# chartdb **Repository Path**: felixchina2024/chartdb ## Basic Information - **Project Name**: chartdb - **Description**: 免费开源的数据库 ER 图可视化编辑器，一条“魔法 SQL”即可导入 PostgreSQL / MySQL / SQL Server 等 7 种数据库结构，支持 AI 生成迁移 DDL、在线协作与本地 Docker 部署，GitHub 星标 16 k+。 - **Primary Language**: Unknown - **License**: AGPL-3.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-09-05 - **Last Updated**: 2025-09-05 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

ChartDB ChartDB

Open-source database diagrams editor
No installations • No Database password required.

Community • Website • Examples • Demo

ChartDB is released under the AGPL license. PRs welcome! Discord community channel

---

### 🎉 ChartDB ChartDB is a powerful, web-based database diagramming editor. Instantly visualize your database schema with a single **"Smart Query."** Customize diagrams, export SQL scripts, and access all features—no account required. Experience seamless database design here. **What it does**: - **Instant Schema Import** Run a single query to instantly retrieve your database schema as JSON. This makes it incredibly fast to visualize your database schema, whether for documentation, team discussions, or simply understanding your data better. - **AI-Powered Export for Easy Migration** Our AI-driven export feature allows you to generate the DDL script in the dialect of your choice. Whether you're migrating from MySQL to PostgreSQL or from SQLite to MariaDB, ChartDB simplifies the process by providing the necessary scripts tailored to your target database. - **Interactive Editing** Fine-tune your database schema using our intuitive editor. Easily make adjustments or annotations to better visualize complex structures. ### Status ChartDB is currently in Public Beta. Star and watch this repository to get notified of updates. ### Supported Databases - ✅ PostgreSQL ( + Supabase + Timescale ) - ✅ MySQL - ✅ SQL Server - ✅ MariaDB - ✅ SQLite ( + Cloudflare D1 Cloudflare D1) - ✅ CockroachDB - ✅ ClickHouse ## Getting Started Use the [cloud version](https://app.chartdb.io?ref=github_readme_2) or deploy locally: ### How To Use ```bash npm install npm run dev ``` ### Build ```bash npm install npm run build ``` Or like this if you want to have AI capabilities: ```bash npm install VITE_OPENAI_API_KEY= npm run build ``` ### Run the Docker Container ```bash docker run -e OPENAI_API_KEY= -p 8080:80 ghcr.io/chartdb/chartdb:latest ``` #### Build and Run locally ```bash docker build -t chartdb . docker run -e OPENAI_API_KEY= -p 8080:80 chartdb ``` #### Using Custom Inference Server ```bash # Build docker build \ --build-arg VITE_OPENAI_API_ENDPOINT= \ --build-arg VITE_LLM_MODEL_NAME= \ -t chartdb . # Run docker run \ -e OPENAI_API_ENDPOINT= \ -e LLM_MODEL_NAME= \ -p 8080:80 chartdb ``` > **Privacy Note:** ChartDB includes privacy-focused analytics via Fathom Analytics. You can disable this by adding `-e DISABLE_ANALYTICS=true` to the run command or `--build-arg VITE_DISABLE_ANALYTICS=true` when building. > **Note:** You must configure either Option 1 (OpenAI API key) OR Option 2 (Custom endpoint and model name) for AI capabilities to work. Do not mix the two options. Open your browser and navigate to `http://localhost:8080`. Example configuration for a local vLLM server: ```bash VITE_OPENAI_API_ENDPOINT=http://localhost:8000/v1 VITE_LLM_MODEL_NAME=Qwen/Qwen2.5-32B-Instruct-AWQ ``` ## Try it on our website 1. Go to [ChartDB.io](https://chartdb.io?ref=github_readme_2) 2. Click "Go to app" 3. Choose the database that you are using. 4. Take the magic query and run it in your database. 5. Copy and paste the resulting JSON set into ChartDB. 6. Enjoy Viewing & Editing! ## 💚 Community & Support - [Discord](https://discord.gg/QeFwyWSKwC) (For live discussion with the community and the ChartDB team) - [GitHub Issues](https://github.com/chartdb/chartdb/issues) (For any bugs and errors you encounter using ChartDB) - [Twitter](https://x.com/intent/follow?screen_name=jonathanfishner) (Get news fast) ## Contributing We welcome community contributions, big or small, and are here to guide you along the way. Message us in the [ChartDB Community Discord](https://discord.gg/QeFwyWSKwC). For more information on how to contribute, please see our [Contributing Guide](/CONTRIBUTING.md). This project is released with a [Contributor Code of Conduct](/CODE_OF_CONDUCT.md). By participating in this project, you agree to follow its terms. Thank you for helping us make ChartDB better for everyone :heart:. ## License ChartDB is licensed under the [GNU Affero General Public License v3.0](LICENSE)