README

需求

php 8.0+

安装

通过composer

composer require tangwei/clickhouse-builder

用法

对于工作查询构建器，我们必须之前在构造函数中实例化并传递smi2/phpclickhouse。

$config = [
    'host' => '127.0.0.1',
    'port' => '8123',
    'username' => 'user',
    'password' => 'pass',
];
$client = new \ClickHouseDB\Client($config);
$client->database('default');
$builder = new \Tinderbox\ClickhouseBuilder\Query\Builder($client);

之后我们可以构建并执行sql查询。

选择列

$builder->select('column', 'column2', 'column3 as alias');
$builder->select(['column', 'column2', 'column3 as alias']);
$builder->select(['column', 'column2', 'column3' => 'alias']);

所有这些调用将被转换成以下的sql

SELECT `column`, `column2`, `column3` AS `alias`

此外，我们也可以将闭包作为列传递。在这种情况下，闭包将传递Column类的实例，在其中我们可以按我们的意愿设置列。这对于包含许多函数、子查询等的复杂表达式非常有用。

$builder->select(function ($column) {
    $column->name('time')->sumIf('time', '>', 10);
});

将编译为

SELECT sumIf(`time`, time > 10)

$builder->select(function ($column) {
    $column->as('alias') //or ->name('alias') in this case
    ->query()
    ->select('column')
    ->from('table');
});

将编译为

SELECT  (SELECT `column` FROM `table) as `alias`

也可以通过以下任何一种方法实现相同的行为

$1 = $builder->select(function ($column) {
         $column->as('alias') //or ->name('alias') in this case
            ->query(function ($query) {
                $query->select('column')->from('table');
            })
});
$2 = $builder->select(function ($column) {
         $column->as('alias') //or ->name('alias') in this case
            ->query($builder->select('column')->from('table'));
});

注意！列上的函数不稳定，正在开发中。

来自

$builder->select('column')->from('table', 'alias');

生成以下查询

SELECT `column` FROM `table` as `alias`

也可以传递闭包或构建器作为执行子查询的参数。

$builder->from(function ($from) {
    $from->query()->select('column')->from('table');
});

SELECT * FROM (SELECT `column` FROM `table`)

或

$builder->from(function ($from) {
    $from->query(function ($query) {
        $query->select('column')->from('table');
    });
});

或

$builder->from(function ($from) {
    $from->query($builder->select('column')->from('table'));
});

或

$builder->from($builder->select('column')->from('table'));

这是上面列出的相同sql查询的所有变体。

样本系数

$builder->select('column')->from('table')->sample(0.1);

SELECT `column` FROM `table` SAMPLE 0.1

我想不需要额外的话了）

连接

$builder->from('table')->join('another_table', 'any', 'left', ['column1', 'column2'], true, 'alias');

SELECT * FROM `table` GLOBAL ANY LEFT JOIN `another_table` AS `alias` USING `column1`, `column2`

对于将子查询作为第一个参数执行，你可以传递闭包或构建器。

$builder->from('table')->join(function ($join) {
    $join->query()->select('column1', 'column2')->from('table2');
}, 'any', 'left', ['column1', 'column2']);

$builder->from('table')->join($builder->select('column1', 'column2')->from('table2'), 'any', 'left', ['column1', 'column2']);

SELECT * FROM `table` ANY LEFT JOIN (SELECT `column1`, `column2` FROM `table2`) USING `column1`, `column2`

还有许多带有硬编码参数的辅助函数，如严格或类型及其组合。

$builder->from('table')->anyLeftJoin('table', ['column']);
$builder->from('table')->allLeftJoin('table', ['column']);
$builder->from('table')->allInnerJoin('table', ['column']);
$builder->from('table')->anyInnerJoin('table', ['column']);

$buulder->from('table')->leftJoin('table', 'any', ['column']);
$buulder->from('table')->innerJoin('table', 'all', ['column']);

你也可以使用数组连接。

$builder->from('test')->arrayJoin('someArr');
$builder->from('test')->leftArrayJoin('someArr');

SELECT * FROM `test` ARRAY JOIN `someArr`
SELECT * FROM `test` LEFT ARRAY JOIN `someArr`

临时表的使用

有些情况下，你需要根据ID过滤用户，但ID的数量非常大。你可以将用户ID存储在本地文件中，上传到服务器，并将其用作临时表。

有关本地文件的更多信息，请参阅这里的Select WHERE IN (本地csv文件)部分。

选择

$file_name_data1 = '/tmp/temp_csv.txt'; 
$builder->table(raw('numbers(0,1000)')->attachFile($file_name_data1,'temp_tale', ['site_id' => 'Int32', 'site_hash' => 'String'], \ClickHouseDB\Query\WhereInFile::FORMAT_CSV)->get();

如果你想要自动检测表，请在调用whereIn之前调用addFile方法。

你可以在查询构建器的whereIn、prewhereIn、havingIn和join语句中使用本地文件。

插入

如果你想要将文件或文件插入Clickhouse，可以使用insertBatchFiles方法。

$builder->table('test')->insertBatchFiles('test.tsv',['event_time', 'site_key'], Format::TSV);

预where，where，having

所有示例都将关于where，但对于prewhere和having也是同样的行为。

$builder->from('table')->where('column', '=', 'value');
$builder->from('table')->where('column', 'value');

SELECT * FROM `table` WHERE `column` = 'value'

所有字符串值都将用单引号括起来。如果没有提供操作符，则使用=。如果没有提供操作符，并且值是一个数组，则使用IN。

$builder->from('table')->where(function ($query) {
    $query->where('column1', 'value')->where('column2', 'value');
});

SELECT * FROM `table` WHERE (`column1` = 'value' AND `column2` = 'value')

如果第一个参数传递了闭包，那么内部的所有where语句都将用括号括起来。但如果在该构建器（闭包内部）指定了from，则它将被转换为子查询。

$builder->from('table')->where(function ($query) {
    $query->select('column')->from('table');
})

SELECT * FROM `table` WHERE (SELECT `column` FROM `table`)

对于值参数来说，几乎相同，除了括号外。传递为值的任何闭包或构建器实例都将转换为子查询。

$builder->from('table')->where('column', 'IN', function ($query) {
    $query->select('column')->from('table');
});

SELECT * FROM `table` WHERE `column` IN (SELECT `column` FROM `table`)

你也可以传递此语句的内部表示，它将被使用。我不会深入解释这一点，因为这不是首选的使用方式。

就像连接一样，有许多带有硬编码参数的辅助函数。

$builder->where();
$builder->orWhere();

$builder->whereRaw();
$builer->orWhereRaw();

$builder->whereIn();
$builder->orWhereIn();

$builder->whereGlobalIn();
$builder->orWhereGlobalIn();

$builder->whereGlobalNotIn();
$builder->orWhereGlobalNotIn();

$builder->whereNotIn();
$builder->orWhereNotIn();

$builder->whereBetween();
$builder->orWhereBetween();

$builder->whereNotBetween();
$builder->orWhereNotBetween();

$builder->whereBetweenColumns();
$builder->orWhereBetweenColumns();

$builder->whereNotBetweenColumns();
$builder->orWhereNotBetweenColumns();

还有方法通过字典制作where

$builder->whereDict('dict', 'attribute', 'key', '=', 'value');

SELECT dictGetString('dict', 'attribute', 'key') as `attribute` WHERE `attribute` = 'value'

如果你想使用复杂键，你可以传递一个数组作为$key，然后数组将被转换为元组。默认情况下，所有字符串都将用单引号转义，但你可以传递一个Identifier实例来传递，例如列名。

$builder->whereDict('dict', 'attribute', [new Identifier('column'), 'string value'], '=', 'value');

将生成

SELECT dictGetString('dict', 'attribute', tuple(`column`, 'string value')) as `attribute` WHERE `attribute` = 'value'

Group By

与选择类似。

$builder->from('table')->select('column', raw('count()'))->groupBy('attribute');

最终的查询将类似于

SELECT `column`, count() FROM `table` GROUP BY `attribute`

按顺序排序

$builder->from('table')->orderBy('column', 'asc', 'fr');

在上面的例子中，第三个参数是可选的

SELECT *  FROM `table` ORDER BY `column` ASC COLLATE 'fr'

别名

$builder->orderByAsc('column');
$builder->orderByDesc('column');

对于列，其行为与select方法中相同。

限制

有两种类型的限制。限制和限制n by。

限制n by

$builder->from('table')->limitBy(1, 'column1', 'column2');

将生成

SELECT * FROM `table` LIMIT 1 BY `column1`, `column2`

简单限制

$builder->from('table')->limit(10, 100);

将生成

SELECT * FROM `table` LIMIT 100, 10

UNION ALL

在unionAll方法中可以传递闭包或构建器实例。如果是闭包，则内部将传递构建器实例。

$builder->from('table')->unionAll(function($query) {
    $query->select('column1')->from('table');
})->unionAll($builder->select('column2')->from('table'));

SELECT * FROM `table` UNION ALL SELECT `column1` FROM `table` UNION ALL SELECT `column2` FROM `table`

执行请求并获取结果。

构建请求后，必须调用get()方法以将请求发送到服务器。还有机会进行异步请求。它的工作方式几乎与unionAll相同。

$builder->from('table')->asyncWithQuery(function($query) {
    $query->from('table');
});
$builder->from('table')->asyncWithQuery($builder->from('table'));
$builder->from('table')->asyncWithQuery()->from('table');

这些调用将产生相同的行为。两个将异步执行的查询。现在，如果您调用get()方法，结果将返回一个数组，其中数字索引对应于具有此编号的请求的结果。

tangwei / clickhouse-builder

维护者

详细信息