nechehin/clickhouse-migrations

Clickhouse migrations for laravel/lumen

0.6.0 2024-06-17 13:22 UTC

Requires

• php: ^7.3|^8.0
• illuminate/console: ^8.0|^9.0|^10.0|^11.0
• illuminate/contracts: ^8.0|^9.0|^10.0|^11.0
• illuminate/support: ^8.0|^9.0|^10.0|^11.0
• league/flysystem: ^3.14
• smi2/phpclickhouse: ^1.5
• 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.

Installing

composer require nechehin/laravel-clickhouse-migrations

Usage

Configure /config/database.php

Example for clickhouse and migrations settings:

'connections' => [

    ...

    '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

'providers' => [
    ...
    \Serkarn\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