attr: clickhouse_migrations.__doc__
Project description
Clickhouse Migrations
Python library for creating and applying migrations in ClickHouse database.
Development and Maintenance of large-scale db systems many times requires constant changes to the actual DB system. Holding off the scripts to migrate these will be painful.
Features:
- Supports multi statements - more than one query per migration file.
- Allow running migrations out-of-box
- Simple file migrations format: {VERSION}_{name}.sql
- Supports Cluster deployments, makes sure that migrations state is consistent on all cluster nodes
Known alternatives
This package originally forked from clickhouse-migrator.
Package | Differences |
---|---|
clickhouse-migrator | Doesn't support multistatement in a single file , to heavy because of pandas, looks like abandoned |
django-clickhouse | Need django |
clickhouse-migrate | Doesn't support multistatement |
Installation
You can install from pypi using pip install clickhouse-migrations
.
Usage
In command line
clickhouse-migrations --db-host localhost \
--db-user default \
--db-password secret \
--db-name test \
--migrations-dir ./migrations
In code
from clickhouse_migrations.clickhouse_cluster import ClickhouseCluster
cluster = ClickhouseCluster(db_host, db_user, db_password)
cluster.migrate(db_name, migrations_home, cluster_name=None,create_db_if_no_exists=True, multi_statement=True)
Parameter | Description | Default |
---|---|---|
db_host | Clickhouse database hostname | localhost |
db_port | Clickhouse database port | 9000 |
db_user | Clickhouse user | default |
db_password | Clichouse password | default |
db_name | Clickhouse database name | None |
migrations_home | Path to list of migration files | <project_root> |
cluster_name | Name of Clickhouse topology cluster from <remote_servers> | None |
create_db_if_no_exists | If the db_name is not present, enabling this will create the db |
True |
multi_statement | Allow multiple statements in migration files | True |
Notes
The Clickhouse driver does not natively support executing multipe statements in a single query. To allow for multiple statements in a single migration, you can use the multi_statement param. There are two important caveats:
- This mode splits the migration text into separately-executed statements by a semi-colon ;. Thus cannot be used when a statement in the migration contains a string with a semi-colon.
- The queries are not executed in any sort of transaction/batch, meaning you are responsible for fixing partial migrations.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for clickhouse-migrations-0.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b808ea1cd45b901f85982a3602f59cb9d493cf4005178b9def3fac2ea03435e |
|
MD5 | 400b8f6a8bf7ad580ce5be876c311e56 |
|
BLAKE2b-256 | 4cec376132d516b23bf52b2725383411ef448366a3593758c4bd87ad03161628 |
Hashes for clickhouse_migrations-0.4.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4c795f99094051e4c842f98a71a6eb56fbefb6287938ca2715a602e55d1ad5a |
|
MD5 | 3e9ea67cb6bc375a3259ed7b09eae075 |
|
BLAKE2b-256 | 4cf3aef5d9c5af7aaa4676015b9a15ef908cd553980469d53aee41f57bf46109 |