sagirba/clickhouse-migrations

Clickhouse migrations for laravel/lumen

0.0.8 2023-12-08 12:26 UTC

Requires

• php: >=7.4
• illuminate/console: ^9.0
• illuminate/contracts: ^9.0
• illuminate/support: ^9.0
• league/flysystem: ^1.0.8
• smi2/phpclickhouse: ^1.3
• symfony/finder: ^6.0

MIT

• migrations
• migration
• laravel
• lumen
• clikchouse

README

ClickHouse is an open source column-oriented database management system capable of real time generation of analytical data reports using SQL queries.

Library is suitable for Laravel / Lumen.

Installing

composer require sagirba/clickhouse-migrations

Usage

Configure /config/database.php

Example for clickhouse and migrations settings:

...
'clickhouse' => [
    'host' => env('CLICKHOUSE_HOST', 'localhost'),
    'port' => env('CLICKHOUSE_PORT', 8123),
    'username' => env('CLICKHOUSE_USER', 'default'),
    'password' => env('CLICKHOUSE_PASSWORD', ''),
    'options' => [
        'database' => env('CLICKHOUSE_DATABASE', 'default'),
        'timeout' => 1,
        'connectTimeOut' => 2,
    ],
],
'clickhouse-migrations' => [
    'dir' => env('CLICKHOUSE_MIGRATION_DIR', '/database/clickhouse-migrations/'),
    'table' => env('CLICKHOUSE_MIGRATION_TABLE_NAME', 'migrations'),
],
    ...

Register provider

Laravel

'providers' => [
    ...
    \Sagirba\ClickhouseMigrations\ClickhouseProvider::class,
    ...
],

Lumen

$app->register(Sagirba\ClickhouseMigrations\ClickhouseProvider::class);

Usage

Create new migration

php artisan clickhouse:migration:create {name}

Up migrations

php artisan clickhouse:migrate

Down last migration

php artisan clickhouse:migrate --down

Built With

• https://github.com/smi2/phpClickHouse - PHP ClickHouse wrapper