Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-tinderbox/ClickhouseBuilder
Fluent queries builder for Clickhouse. Also has integration with Laravel / Lumen.
https://github.com/the-tinderbox/ClickhouseBuilder
clickhouse clickhouse-fluent clickhouse-wrapper
Last synced: 30 days ago
JSON representation
Fluent queries builder for Clickhouse. Also has integration with Laravel / Lumen.
- Host: GitHub
- URL: https://github.com/the-tinderbox/ClickhouseBuilder
- Owner: the-tinderbox
- Created: 2017-06-14T09:59:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T13:54:57.000Z (about 1 year ago)
- Last Synced: 2024-10-31T04:03:21.506Z (about 1 month ago)
- Topics: clickhouse, clickhouse-fluent, clickhouse-wrapper
- Language: PHP
- Size: 249 KB
- Stars: 191
- Watchers: 3
- Forks: 74
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-clickhouse - the-tinderbox/ClickhouseBuilder - A fluent query builder for Clickhouse that integrates with Laravel and Lumen. (Language bindings / PHP)
README
# Clickhouse Query Builder
[](https://travis-ci.org/the-tinderbox/ClickhouseBuilder) [](https://coveralls.io/github/the-tinderbox/ClickhouseBuilder?branch=master)
# Requirements
`php 7.1+`
# Install
Via composer
```bash
composer require the-tinderbox/clickhouse-builder
```
# Usage
For working query builder we must previously instantiate and pass in constructor `the-tinderbox/clickhouse-php-client`.
```php
$server = new Tinderbox\Clickhouse\Server('127.0.0.1', '8123', 'default', 'user', 'pass');
$serverProvider = (new Tinderbox\Clickhouse\ServerProvider())->addServer($server);
$client = new Tinderbox\Clickhouse\Client($serverProvider);
$builder = new Builder($client);
```
After that we can build and perform sql queries.
### Select columns
```php
$builder->select('column', 'column2', 'column3 as alias');
$builder->select(['column', 'column2', 'column3 as alias']);
$builder->select(['column', 'column2', 'column3' => 'alias']);
```
All this calls will be transformed into next sql:
```sql
SELECT `column`, `column2`, `column3` AS `alias`
```
Also, as a column we can pass closure. In this case in closure will be passed instance of Column class, inside which we
can setup column how we want. This can be useful for difficult expressions with many functions, subqueries and etc.
```php
$builder->select(function ($column) {
$column->name('time')->sumIf('time', '>', 10);
});
```
Will be compiled in:
```sql
SELECT sumIf(`time`, time > 10)
```
```php
$builder->select(function ($column) {
$column->as('alias') //or ->name('alias') in this case
->query()
->select('column')
->from('table');
});
```
Will be compiled in:
```sql
SELECT (SELECT `column` FROM `table) as `alias`
```
Same behavior can be also achieved by any of the following approaches:
```php
$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'));
});
```
**Notice! Functions on columns is not stable and under development.**
### From
```php
$builder->select('column')->from('table', 'alias');
```
Produce the following query:
```sql
SELECT `column` FROM `table` as `alias`
```
Also can be passed closure or builder as argument for performing sub query.
```php
$builder->from(function ($from) {
$from->query()->select('column')->from('table');
});
```
```sql
SELECT * FROM (SELECT `column` FROM `table`)
```
or
```php
$builder->from(function ($from) {
$from->query(function ($query) {
$query->select('column')->from('table');
});
});
```
or
```php
$builder->from(function ($from) {
$from->query($builder->select('column')->from('table'));
});
```
or
```php
$builder->from($builder->select('column')->from('table'));
```
It is all variants of the same sql query which was listed above.
### Sample coefficient
```php
$builder->select('column')->from('table')->sample(0.1);
```
```sql
SELECT `column` FROM `table` SAMPLE 0.1
```
I think there no need for additional words)
### Joins
```php
$builder->from('table')->join('another_table', 'any', 'left', ['column1', 'column2'], true, 'alias');
```
```sql
SELECT * FROM `table` GLOBAL ANY LEFT JOIN `another_table` AS `alias` USING `column1`, `column2`
```
For performing subquery as first argument you can pass closure or builder.
```php
$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']);
```
```sql
SELECT * FROM `table` ANY LEFT JOIN (SELECT `column1`, `column2` FROM `table2`) USING `column1`, `column2`
```
Also there are many helper functions with hardcoded arguments, like strict or type and they combinations.
```php
$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']);
```
You can use array join as well.
```php
$builder->from('test')->arrayJoin('someArr');
$builder->from('test')->leftArrayJoin('someArr');
```
```sql
SELECT * FROM `test` ARRAY JOIN `someArr`
SELECT * FROM `test` LEFT ARRAY JOIN `someArr`
```
### Temporary tables usage
There are some cases when you need to filter f.e. users by their ids, but amount of ids is huge. You can
store users ids in local file, upload it to server and use it as temporary table.
Read more about local files [here](https://github.com/the-tinderbox/ClickhouseClient) in section `Using local files`.
#### Select
You should pass instance of `TempTable` with declared table structure to attach file to query.
```php
$builder->addFile(new TempTable('numbersTable', 'numbers.tsv', ['number' => 'UInt64'], Format::TSV));
$builder->table(raw('numbers(0,1000)')->whereIn('number', 'numbersTable')->get();
```
**If you want tables to be detected automatically, call `addFile` method before calling `whereIn`.**
You can use local files in `whereIn`, `prewhereIn`, `havingIn` and `join` statements of query builder.
#### Insert
If you want to insert file or files into Clickhouse, you could use `insertFile` and `insertFiles` methods.
```
$builder->table('test')->insertFile(['date', 'userId'], 'test.tsv', Format::TSV);
```
Or you can pass batch of files into `insertFiles` method and all of them will be inserted
asynchronously.
```
$builder->table('test')-insertFiles(['date', 'userId'], [
'test-1.tsv',
'test-2.tsv',
'test-3.tsv',
'test-4.tsv',
'test-5.tsv',
'test-6.tsv',
'test-7.tsv',
], Format::TSV)
```
Also, you can use helper and insert data to temporary table with engine Memory.
```
$builder->table('test')->values('test.tsv')->format(Format::TSV);
into_memory_table($builder, [
'date' => 'Date',
'userId' => 'UInt64'
]);
```
Helper will drop temporary table with name `test` and creates table with declared structure, engine Memory
and inserts data from `test.tsv` file into just created table.
It's helpful if you want to fill some table with data to execute query and then drop it.
### Prewhere, where, having
All example will be about where, but same behavior also is for prewhere and having.
```php
$builder->from('table')->where('column', '=', 'value');
$builder->from('table')->where('column', 'value');
```
```sql
SELECT * FROM `table` WHERE `column` = 'value'
```
All string values will be wrapped with single quotes.
If operator is not provided `=` will be used.
If operator is not provided and value is an array, then `IN` will be used.
```php
$builder->from('table')->where(function ($query) {
$query->where('column1', 'value')->where('column2', 'value');
});
```
```sql
SELECT * FROM `table` WHERE (`column1` = 'value' AND `column2` = 'value')
```
If in the first argument was passed closure, then all wheres statements from inside will be wrapped with parenthesis.
But if on that builder (inside closure) will be specified `from` then it will be transformed into subquery.
```php
$builder->from('table')->where(function ($query) {
$query->select('column')->from('table');
})
```
```sql
SELECT * FROM `table` WHERE (SELECT `column` FROM `table`)
```
Almost same is for value parameter, except wrapping into parenthesis.
Any closure or builder instance passed as value will be converted into subquery.
```php
$builder->from('table')->where('column', 'IN', function ($query) {
$query->select('column')->from('table');
});
```
```sql
SELECT * FROM `table` WHERE `column` IN (SELECT `column` FROM `table`)
```
Also you can pass internal representation of this statement and it will be used. I will no talk about this with deeper
explanation because its not preferable way to use this.
Like joins there are many helpers with hardcoded parameters.
```php
$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();
```
Also there is method to make where by dictionary:
```php
$builder->whereDict('dict', 'attribute', 'key', '=', 'value');
```
```sql
SELECT dictGetString('dict', 'attribute', 'key') as `attribute` WHERE `attribute` = 'value'
```
If you want to use complex key, you may pass an array as `$key`, then array will be converted to tuple. By default all strings will be escaped by single quotes, but you may pass an `Identifier` instance to pass for example column name:
```php
$builder->whereDict('dict', 'attribute', [new Identifier('column'), 'string value'], '=', 'value');
```
Will produce:
```sql
SELECT dictGetString('dict', 'attribute', tuple(`column`, 'string value')) as `attribute` WHERE `attribute` = 'value'
```
### Group By
Works like select.
```php
$builder->from('table')->select('column', raw('count()'))->groupBy('attribute');
```
Final query will be like:
```sql
SELECT `column`, count() FROM `table` GROUP BY `attribute`
```
### Order By
```php
$builder->from('table')->orderBy('column', 'asc', 'fr');
```
*In the example above, third argument is optional*
```sql
SELECT * FROM `table` ORDER BY `column` ASC COLLATE 'fr'
```
Aliases:
```php
$builder->orderByAsc('column');
$builder->orderByDesc('column');
```
For column there are same behaviour like in select method.
### Limit
There are two types of limit. Limit and limit n by.
Limit n by:
```php
$builder->from('table')->limitBy(1, 'column1', 'column2');
```
Will produce:
```sql
SELECT * FROM `table` LIMIT 1 BY `column1`, `column2`
```
Simple limit:
```php
$builder->from('table')->limit(10, 100);
```
Will produce:
```sql
SELECT * FROM `table` LIMIT 100, 10
```
### Union ALL
In `unionAll` method can be passed closure or builder instance. In case of closure inside will be passed
builder instance.
```php
$builder->from('table')->unionAll(function($query) {
$query->select('column1')->from('table');
})->unionAll($builder->select('column2')->from('table'));
```
```sql
SELECT * FROM `table` UNION ALL SELECT `column1` FROM `table` UNION ALL SELECT `column2` FROM `table`
```
### Performing request and getting result.
After building request you must call `get()` method for sending request to the server.
Also there has opportunity to make asynchronous requests. Its works almost like `unionAll`.
```php
$builder->from('table')->asyncWithQuery(function($query) {
$query->from('table');
});
$builder->from('table')->asyncWithQuery($builder->from('table'));
$builder->from('table')->asyncWithQuery()->from('table');
```
This callings will produce the same behavior. Two queries which will be executed asynchronous.
Now, if you call `get()` method, as result will be returned array, where numeric index correspond to the result of
request with this number.
### Integrations
#### Laravel or Lumen < 5.5
You can use this builder in Laravel/Lumen applications.
**Laravel**
In `config/app.php` add:
```php
'providers' => [
...
\Tinderbox\ClickhouseBuilder\Integrations\Laravel\ClickhouseServiceProvider::class,
...
]
```
**Lumen**
In `bootstrap/app.php` add:
```php
$app->register(\Tinderbox\ClickhouseBuilder\Integrations\Laravel\ClickhouseServiceProvider::class);
```
Connection configures via `config/database.php`.
Example with alone server:
```php
'connections' => [
'clickhouse' => [
'driver' => 'clickhouse',
'host' => 'ch-00.domain.com',
'port' => '',
'database' => '',
'username' => '',
'password' => '',
'options' => [
'timeout' => 10,
'protocol' => 'https'
]
]
]
```
Get a new builder:
```php
DB::connection('clickhouse')->query();
```
or
```php
'connections' => [
'clickhouse' => [
'driver' => 'clickhouse',
'servers' => [
[
'host' => 'ch-00.domain.com',
'port' => '',
'database' => '',
'username' => '',
'password' => '',
'options' => [
'timeout' => 10,
'protocol' => 'https'
]
],
[
'host' => 'ch-01.domain.com',
'port' => '',
'database' => '',
'username' => '',
'password' => '',
'options' => [
'timeout' => 10,
'protocol' => 'https'
]
]
]
]
]
```
Example with cluster:
```php
'connections' => [
'clickhouse' => [
'driver' => 'clickhouse',
'clusters' => [
'cluster-name' => [
[
'host' => '',
'port' => '',
'database' => '',
'username' => '',
'password' => '',
'options' => [
'timeout' => 10,
'protocol' => 'https'
]
],
[
'host' => '',
'port' => '',
'database' => '',
'username' => '',
'password' => '',
'options' => [
'timeout' => 10,
'protocol' => 'https'
]
]
]
]
]
]
```
Example with server with tag:
```php
'connections' => [
'clickhouse' => [
'driver' => 'clickhouse',
'servers' => [
[
'host' => 'ch-00.domain.com',
'port' => '',
'database' => '',
'username' => '',
'password' => '',
'options' => [
'timeout' => 10,
'protocol' => 'https',
'tags' => [
'tag'
],
],
],
[
'host' => 'ch-01.domain.com',
'port' => '',
'database' => '',
'username' => '',
'password' => '',
'options' => [
'timeout' => 10,
'protocol' => 'https'
],
],
],
],
]
```
Choose server without cluster:
```php
DB::connection('clickhouse')->using('ch-01.domain.com')->select(...);
```
Or execute each new query on random server:
```php
DB::connection('clickhouse')->usingRandomServer()->select(...);
```
Choose cluster:
```php
DB::connection('clickhouse')->onCluster('test')->select(...);
```
Use server with tag:
```php
DB::connection('clickhouse')->usingServerWithTag('tag')->select(...);
```
You can use both `servers` and `clusters` config directives and choose on which server
query should be executed via `onCluster` and `using` methods. If you want to choose
server outside cluster, you should just call `onCluster(null)` and then call `using` method. You can
call `usingRandomServer` and `using` methods with selected cluster or not.