churakovmike/laravel-clickhouse

Clickhouse 的 Eloquent 扩展

v0.4 2021-10-10 14:34 UTC

This package is auto-updated.

Last update: 2024-09-21 22:18:55 UTC


README

Maintainability License Latest Stable Version PHP Version Require StyleCI PSALM

要求

  • laravel 7+
  • php 7.4+

安装

composer require churakovmike/laravel-clickhouse

如果您需要最新版本

composer require churakovmike/laravel-clickhouse:dev-main

集成

config/app.php 中添加

    'providers' => [
        ...
        \ChurakovMike\LaravelClickHouse\ClickhouseServiceProvider::class,
        ...
    ]

通过 config/database.php 配置连接

Clickhouse 默认配置示例

'connections' => [
    'clickhouse' => [
        'driver' => 'clickhouse',
        'host' => 'http://127.0.0.1',
        'port' => 8123,
        'database' => 'database_name',
        'username' => 'default',
        'password' => '',
        'options' => [
            'timeout' => 10,
        ]
    ]
]

用法

创建新的模型并从新模型继承

<?php

namespace App;

use ChurakovMike\LaravelClickHouse\Database\Model;

class Events extends Model
{
    // ...
}

就是这样,您可以使用熟悉的 Eloquent 模型与 Clickhouse 一起工作。

以下功能即将推出

  • 集群切换
  • 服务器切换
  • 模型的原生 Clickhouse 函数(sumIf, countIf, quantilesTimingIf, argMinIf 等。)
  • 新的迁移管理器和新的 Clickhouse Blueprint
  • 查询的新数据类型