attr: clickhouse_migrations.__doc__
Project description
Clickhouse Migrations
Clickhouse is known for its scale to store and fetch large datasets.
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
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, create_db_if_no_exists=True, multi_statement=True)
Parameter | Description | Default |
---|---|---|
db_host | Clickhouse database hostname | localhost |
db_user | Clickhouse uesr | **** |
db_password | ***** | **** |
db_name | Clickhouse database name | None |
migrations_home | Path to list of migration files | <project_root> |
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
Close
Hashes for clickhouse-migrations-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b54ed8490207aa121d894d717aefaf373ce27e4c563ebf594f24f6f5f651544e |
|
MD5 | d7c7d97eb837476e53adba5aa35586a3 |
|
BLAKE2b-256 | f43644c351ba823e9e215c49913c10794d0b26f52e6097ef9da768fdd14ff16f |
Close
Hashes for clickhouse_migrations-0.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57585f324b6b06364426b7a287fc9e85808a6a35d5d0e0edb0c382775e089f09 |
|
MD5 | 5e728c2cbf01cee69bc9f1f020b08293 |
|
BLAKE2b-256 | ea38c219dd51aab558213504400dc762b432db275eb29d32cf86c3f55dbc9fa0 |