Skip to content

Add Python clickhouse-migrations to schema migration tools (and disambiguate the Node.js entry)#6477

Merged
dhtclk merged 1 commit into
ClickHouse:mainfrom
zifter:add-python-clickhouse-migrations
Jul 2, 2026
Merged

Add Python clickhouse-migrations to schema migration tools (and disambiguate the Node.js entry)#6477
dhtclk merged 1 commit into
ClickHouse:mainfrom
zifter:add-python-clickhouse-migrations

Conversation

@zifter

@zifter zifter commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

The Schema migration tools for ClickHouse knowledge-base page lists clickhouse-migrations in the "Other Tools in the Ecosystem" table, but the link points to the npm / Node.js package. There is a separate, actively maintained Python project of the same name that isn't represented:

This PR:

  • Renames the existing row to clickhouse-migrations (Node.js) so the name collision between the two projects is explicit.
  • Adds clickhouse-migrations (Python) — a file-based schema migration runner available both as a CLI and as a Python library, with single-node and cluster (ON CLUSTER / replicated) support, --dry-run and --fake modes, and multi-statement migration files. Supports Python 3.9–3.14, MIT licensed.

Only the one table in knowledgebase/schema_migration_tools.md is changed; no other content is touched.

Why

Readers searching for a Python-native ClickHouse migration tool currently see only Houseplant and Alembic, and the same-named Node.js entry is easy to mistake for the Python package. Disambiguating the name and listing the Python project makes the ecosystem table accurate and more useful.

@zifter zifter requested a review from a team as a code owner July 1, 2026 21:35
@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

@zifter is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant

CLAassistant commented Jul 1, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@vercel

vercel Bot commented Jul 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview Jul 2, 2026 3:55pm

Request Review

@dhtclk

dhtclk commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

@zifter - Thanks for the contribution!

@dhtclk dhtclk merged commit 2517cd8 into ClickHouse:main Jul 2, 2026
11 of 15 checks passed
@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown

Docs PR opened: ClickHouse/mintlify-docs-dev#320

Disambiguated the existing clickhouse-migrations entry as Node.js and added a new Python clickhouse-migrations entry to the schema migration tools list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants