clickhouse-migrate: Core definitions and execution for ClickHouse migrations

[ bsd3, database, library ] [ Propose Tags ] [ Report a vulnerability ]

Core definitions and execution for ClickHouse migrations. Validated public APIs with explicit application-owned configuration and scope.


[Skip to Readme]

Flags

Manual Flags

NameDescriptionDefault
internal-test-driver

Build private runtime qualification driver (supplied by EP-4)

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0
Change log CHANGELOG.md
Dependencies aeson (>=2.2.4.1 && <2.4), base (>=4.21 && <4.22), bytestring (>=0.12.2 && <0.13), containers (>=0.7 && <0.9), cryptohash-sha256 (>=0.11.102.1 && <0.12), entropy (>=0.4.1.10 && <0.5), http-client (==0.7.19), http-client-tls (>=0.3.6.4 && <0.5), http-types (>=0.12.4 && <0.13), text (>=2.1 && <2.2), time (>=1.12.2 && <1.17) [details]
Tested with ghc ==9.12.4
License BSD-3-Clause
Author shinzui
Maintainer shinzui@users.noreply.github.com
Uploaded by shinzui at 2026-10-16T20:04:34Z
Category Database
Source repo head: git clone https://github.com/shinzui/clickhouse-migrate.git(clickhouse-migrate)
Distributions
Reverse Dependencies 3 direct, 0 indirect [details]
Executables clickhouse-migrate-test-driver
Downloads 0 total (0 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for clickhouse-migrate-0.1.0.0

[back to package description]

clickhouse-migrate

Validated ordered migration definitions, exact-byte checksum v1, conservative direct HTTP execution, immutable ledger history, scoped inspection/recovery and source-neutral legacy adoption. No runtime file discovery, implicit credentials, printing or process exit. Optional embedding, CLI and server fixtures are separate packages.

Construct MigrationPlan with the public smart constructors; supply validated TargetConfig, a mandatory externally serialized administrative provider, event sink and diagnostic policy to mutationContext. up initializes only with a retained explicit target/UUID authorization. Uncertain work blocks ordinary up. Status/history never initialize; verify checks definition compatibility, optionally currency, not schema equality. All repair/adoption operations require explicit evidence and fresh expected state. Async cancellation propagates after bounded cleanup.

Qualified target: exact ClickHouse 26.8.28.14 LTS official Apple Silicon macOS binary, direct self-managed Atomic/MergeTree on healthy writable Local storage. No Cloud, proxy, distributed/replicated, Linux or power-loss claim. Runtime version probes do not attest platform/digest. The workspace's docs/user/contracts and docs/user/operations.md publish frozen formats, server artifact identity and coordination/recovery limits. The standard Haskell process library is a transitive HTTP dependency; fixture tools, optional packages and the opt-in internal driver are absent from production outputs.