Install this package via Composer.
$ composer require alexeykhr/laravel-clickhouse-migrations
Note: PHP 7.2.5 or later is required
Publish Clickhouse configs:
$ php artisan vendor:publish --provider='Alexeykhr\ClickhouseMigrations\Providers\MigrationProvider'
Create a new migration file:
$ php artisan make:clickhouse-migration {name}
Up migrations:
$ php artisan clickhouse-migrate
Down last migration:
$ php artisan clickhouse-migration:rollback
To create a new migration, use this command:
$ php artisan make:clickhouse-migration {name}
For example:
$ php artisan make:clickhouse-migration create_users_table
The new file will be located at the path specified in the configs: clickhouse.path
You can use a more prepared stub from the library that contains a template for quickly adding a new table by adding the --table option:
$ php artisan make:clickhouse-migration create_users_table --table=users
You can override the path to the migrations folder by passing the --path option:
$ php artisan make:clickhouse-migration create_users_table --path=database/new-migrations-folder
If you want to use an absolute path to the file, add one more option - --realpath to the existing option:
$ php artisan make:clickhouse-migration create_users_table --path=/path/to/migrations --realpath
You can use your (override) prepared stub when creating a new file, list: clickhouse.stubs:
For example:
$ php artisan make:clickhouse-migration create_users_table --stub=default
Also you can add Handlers, with them, you can customize over one stub every time you create a file:
$ php artisan make:clickhouse-migration create_users_table --stub=myStub --stub.handler='App\Clickhouse\MyHandler'
The class must implement the
Alexeykhr\ClickhouseMigrations\Contracts\MigrationStubHandlerContract
interface
You can pass your $parameters
, for example:
$ php artisan make:clickhouse-migration create_users_table --stub.handler='App\Clickhouse\MyHandler' --stub.param=key:value --stub.param=table:products
You can also register a global handler that will apply to all generated stub files: clickhouse.handlers.global
To remove the interactive question during production migrations, you can use --force option:
$ php artisan clickhouse-migrate --force
To output migrations to be applied use --output option:
$ php artisan clickhouse-migrate --output
Before applying the shown migrations - will display an interactive question, to remove it, you can add another --force option to this option:
$ php artisan clickhouse-migrate --output --force
You can specify how many files need to be applied:
$ php artisan clickhouse-migrate --step=1
Value
0
- all files
Has the same properties as in Up Migrations.
You can use a singleton object smi2/phpClickHouse to query ClickHouse (used in migrations):
app('clickhouse')->select(/* Query */);
app('clickhouse')->write(/* Query */);
Detailed changes for each release are documented in the CHANGELOG.md.