Doctrine DBAL driver for ClickHouse -- an open-source column-oriented database management system by Yandex (https://clickhouse.yandex/)
Driver is suitable for Symfony or any other framework using Doctrine.
composer require friendsofdoctrine/dbal-clickhouse
$connectionParams = [
'host' => 'localhost',
'port' => 8123,
'user' => 'default',
'password' => '',
'dbname' => 'default',
'driverClass' => 'FOD\DBALClickHouse\Driver',
'wrapperClass' => 'FOD\DBALClickHouse\Connection',
'driverOptions' => [
'extremes' => false,
'readonly' => true,
'max_execution_time' => 30,
'enable_http_compression' => 0,
'https' => false,
],
];
$conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams, new \Doctrine\DBAL\Configuration());
driverOptions
are special smi2/phpclickhouse
client settings
configure...
# app/config/config.yml
doctrine:
dbal:
connections:
clickhouse:
host: localhost
port: 8123
user: default
password: ""
dbname: default
driver_class: FOD\DBALClickHouse\Driver
wrapper_class: FOD\DBALClickHouse\Connection
options:
enable_http_compression: 1
max_execution_time: 60
#mysql:
# ...
...and get from the service container
$conn = $this->get('doctrine.dbal.clickhouse_connection');
// ***quick start***
$fromSchema = $conn->getSchemaManager()->createSchema();
$toSchema = clone $fromSchema;
// create new table object
$newTable = $toSchema->createTable('new_table');
// add columns
$newTable->addColumn('id', 'integer', ['unsigned' => true]);
$newTable->addColumn('payload', 'string', ['notnull' => false]);
// *option 'notnull' in false mode allows you to insert NULL into the column;
// in this case, the column will be represented in the ClickHouse as Nullable(String)
$newTable->addColumn('hash', 'string', ['length' => 32, 'fixed' => true]);
// *option 'fixed' sets the fixed length of a string column as specified;
// if specified, the type of the column is FixedString
//set primary key
$newTable->setPrimaryKey(['id']);
// execute migration SQLs to create table in ClickHouse
$sqlArray = $fromSchema->getMigrateToSql($toSchema, $conn->getDatabasePlatform());
foreach ($sqlArray as $sql) {
$conn->exec($sql);
}
// ***more options (optional)***
//specify table engine
$newTable->addOption('engine', 'MergeTree');
// *if not specified -- default engine 'ReplacingMergeTree' will be used
// add Date column for partitioning
$newTable->addColumn('event_date', 'date', ['default' => 'toDate(now())']);
$newTable->addOption('eventDateColumn', 'event_date');
// *if not specified -- default Date column named EventDate will be added
$newTable->addOption('eventDateProviderColumn', 'updated_at');
// *if specified -- event date column will be added with default value toDate(updated_at);
// if the type of the provider column is `string`, the valid format of provider column values must be either `YYYY-MM-DD` or `YYYY-MM-DD hh:mm:ss`
// if the type of provider column is neither `string`, nor `date`, nor `datetime`, provider column values must contain a valid UNIX Timestamp
$newTable->addOption('samplingExpression', 'intHash32(id)');
// samplingExpression -- a tuple that defines the table's primary key, and the index granularity
//specify index granularity
$newTable->addOption('indexGranularity', 4096);
// *if not specified -- default value 8192 will be used
// 1
$conn->exec("INSERT INTO new_table (id, payload) VALUES (1, 'dummyPayload1')");
// 2
$conn->insert('new_table', ['id' => 2, 'payload' => 'dummyPayload2']);
// INSERT INTO new_table (id, payload) VALUES (?, ?) [2, 'dummyPayload2']
// 3 via QueryBuilder
$qb = $conn->createQueryBuilder();
$qb
->insert('new_table')
->setValue('id', ':id')
->setValue('payload', ':payload')
->setParameter('id', 3, \PDO::PARAM_INT) // need to explicitly set param type to `integer`, because default type is `string` and ClickHouse doesn't like types mismatchings
->setParameter('payload', 'dummyPayload3');
$qb->execute();
echo $conn->fetchColumn('SELECT SUM(views) FROM articles');
$stmt = $conn->prepare('SELECT authorId, SUM(views) AS total_views FROM articles WHERE category_id = :categoryId AND publish_date = :publishDate GROUP BY authorId');
$stmt->bindValue('categoryId', 123);
$stmt->bindValue('publishDate', new \DateTime('2017-02-29'), 'datetime');
$stmt->execute();
while ($row = $stmt->fetch()) {
echo $row['authorId'] . ': ' . $row['total_views'] . PHP_EOL;
}
If you want to use Array(T) type, register additional DBAL types in your code:
// register all custom DBAL Array types
ArrayType::registerArrayTypes($conn->getDatabasePlatform());
// register one custom DBAL Array(Int8) type
Type::addType('array(int8)', 'FOD\DBALClickHouse\Types\ArrayInt8Type');
or register them in Symfony configuration file:
# app/config/config.yml
doctrine:
dbal:
connections:
...
types:
array(int8): FOD\DBALClickHouse\Types\ArrayInt8Type
array(int16): FOD\DBALClickHouse\Types\ArrayInt16Type
array(int32): FOD\DBALClickHouse\Types\ArrayInt32Type
array(int64): FOD\DBALClickHouse\Types\ArrayInt64Type
array(uint8): FOD\DBALClickHouse\Types\ArrayUInt8Type
array(uint16): FOD\DBALClickHouse\Types\ArrayUInt16Type
array(uint32): FOD\DBALClickHouse\Types\ArrayUInt32Type
array(uint64): FOD\DBALClickHouse\Types\ArrayUInt64Type
array(float32): FOD\DBALClickHouse\Types\ArrayFloat32Type
array(float64): FOD\DBALClickHouse\Types\ArrayFloat64Type
array(string): FOD\DBALClickHouse\Types\ArrayStringType
array(datetime): FOD\DBALClickHouse\Types\ArrayDateTimeType
array(date): FOD\DBALClickHouse\Types\ArrayDateType
If you want to use numeric types, register additional DBAL types in your Symfony configuration file:
# app/config/config.yml
doctrine:
dbal:
connections:
...
types:
int8: FOD\DBALClickHouse\Types\Int8Type
int16: FOD\DBALClickHouse\Types\Int16Type
int32: FOD\DBALClickHouse\Types\Int32Type
int64: FOD\DBALClickHouse\Types\Int64Type
float32: FOD\DBALClickHouse\Types\Float32Type
float64: FOD\DBALClickHouse\Types\Float64Type
decimal: FOD\DBALClickHouse\Types\DecimalType
or you can override DBAL type in your code:
Type::overrideType(Type::BIGINT, 'FOD\DBALClickHouse\Types\Int64Type');
Type::overrideType(Type::DECIMAL, 'FOD\DBALClickHouse\Types\DecimalType');