clickhouse://host:port?username=user&password=qwerty&database=clicks&x-multi-statement=true
URL Query | Description |
---|---|
x-migrations-table |
Name of the migrations table |
x-migrations-table-engine |
Engine to use for the migrations table, defaults to TinyLog |
database |
The name of the database to connect to |
username |
The user to sign in as |
password |
The user's password |
host |
The host to connect to. |
port |
The port to bind to. |
x-multi-statement |
false |
- 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
x-multi-statement
param. There are two important caveats:- This mode splits the migration text into separately-executed statements by a semi-colon
;
. Thusx-multi-statement
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.
- This mode splits the migration text into separately-executed statements by a semi-colon
- Using the default TinyLog table engine for the schema_versions table prevents backing up the table if using the clickhouse-backup tool. If backing up the database with make sure the migrations are run with
x-migrations-table-engine=MergeTree
.