Skip to content

docs: refresh README with full engine + feature coverage - #47

Closed
broisnischal wants to merge 1 commit into
masterfrom
docs/readme-refresh
Closed

docs: refresh README with full engine + feature coverage#47
broisnischal wants to merge 1 commit into
masterfrom
docs/readme-refresh

Conversation

@broisnischal

Copy link
Copy Markdown
Owner

Brings the README in line with what the app actually ships today.

What changed

  • Supported databases — added the three engines that were supported but undocumented: ClickHouse, DuckDB, and Microsoft SQL Server. Split the list into core engines vs one-click providers, and added Prisma Postgres to the providers (alongside Neon, Supabase, PlanetScale).
  • New feature sections — documented capabilities that were missing entirely:
    • Live mode (real-time table change streaming)
    • Global search
    • EXPLAIN plans in the SQL console
    • Relation tree (foreign-key drill-down)
    • Schema-object creation dialogs (tables, schemas, sequences, triggers, enums, FKs) + enum management
  • Backup & restore — corrected to describe the real behavior: a SQL dump with granular include toggles (schema/data/views/triggers/functions/sequences/enums), per-table selection, a live progress log, and cancellation — for PostgreSQL, MySQL, SQLite, and Cloudflare D1. (The old text claimed "SQL dumps or CSV" import, which isn't how it works.)
  • Storage — noted OS-keychain credential storage; Charts now mentions ECharts + choropleth maps.
  • Connecting — expanded to cover every engine and provider (DuckDB file, ClickHouse TLS, SQL Server, provider sign-in).

Verification

Every addition was checked against the codebase — engines from ActiveConnection (connection.rs), providers from providers.js, export formats from export.js, and features from the component set. No aspirational claims.

Docs-only; no release label (nothing to build/publish).

- Add ClickHouse, DuckDB, and SQL Server to supported databases
- Add Prisma Postgres to one-click providers; group core engines vs providers
- Document live mode, global search, EXPLAIN plans, relation tree, and
  schema-object creation dialogs
- Correct the backup/restore section (SQL-dump based with include toggles,
  per-table selection, live log, cancel; PG/MySQL/SQLite/D1)
- Note OS-keychain credential storage; mention ECharts/choropleth charts
- Expand the Connecting section to cover every engine and provider
@changeset-bot

changeset-bot Bot commented Jul 14, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3e6c523

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@broisnischal

Copy link
Copy Markdown
Owner Author

Superseded by #49 (consolidated release PR, labeled release:minor → v1.12.0). All changes from this PR are included there.

@github-actions github-actions Bot locked and limited conversation to collaborators Jul 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant