chartdb  by chartdb

Web-based editor for database diagramming and schema visualization

created 1 year ago
17,555 stars

Top 2.6% on sourcepulse

GitHubView on GitHub
Project Summary

ChartDB is a web-based database diagramming editor designed for developers and database administrators to visualize, design, and migrate database schemas. It offers instant schema import from a single query, interactive editing, and AI-powered DDL script generation for cross-database migrations, all without requiring database passwords or installations for its cloud version.

How It Works

The tool operates by accepting a "smart query" that retrieves a database's schema as JSON. This JSON data is then rendered into an interactive diagram. An AI component can translate this schema or generated DDL into different SQL dialects, facilitating database migrations. The web-based interface allows for direct manipulation and annotation of the schema diagrams.

Quick Start & Requirements

  • Install/Run: npm install && npm run dev (local development), docker run -p 8080:80 ghcr.io/chartdb/chartdb:latest (Docker).
  • Prerequisites: Node.js for local builds. For AI capabilities, an OpenAI API key or a custom inference server endpoint and model name must be configured via environment variables (VITE_OPENAI_API_KEY or VITE_OPENAI_API_ENDPOINT, VITE_LLM_MODEL_NAME).
  • Supported Databases: PostgreSQL, MySQL, SQL Server, MariaDB, SQLite, Cloudflare D1, CockroachDB, ClickHouse.
  • Demo: Available at ChartDB.io.

Highlighted Details

  • Instant schema visualization via a single query.
  • AI-powered DDL export for cross-database migration.
  • Interactive schema editing and annotation.
  • No database password required for schema import.

Maintenance & Community

The project is in Public Beta and actively seeking community contributions. Support and discussion are available via Discord and bug reporting via GitHub Issues. Updates are announced on Twitter.

Licensing & Compatibility

Licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This license is copyleft and may have implications for commercial or closed-source use, requiring derived works to also be open-sourced under the same license.

Limitations & Caveats

The project is in Public Beta, indicating potential instability or incomplete features. AI capabilities require external API keys or self-hosted models, adding complexity and potential cost. The AGPL-3.0 license may restrict integration into proprietary software.

Health Check
Last commit

1 day ago

Responsiveness

1 day

Pull Requests (30d)
66
Issues (30d)
12
Star History
1,398 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.