Kylin

A small PHP client for the Apache Kylin REST API.

Quick start

use Erikwang2013\BigData\BigData;

$kylin = BigData::driver('kylin', [
    'host' => '127.0.0.1',
    'port' => 7070,
    'username' => 'admin',
    'password' => 'KYLIN',
    'project' => 'learn_kylin',
]);

foreach ($kylin->query('SELECT ID FROM KYLIN_SALES LIMIT 10')->rows() as $row) {
    echo $row[0], PHP_EOL;
}

Direct instantiation:

use Erikwang2013\BigData\Driver\Kylin\KylinClient;
use Erikwang2013\BigData\Driver\Kylin\KylinConfig;

$kylin = new KylinClient(KylinConfig::fromArray([
    'host' => '127.0.0.1',
    'port' => 7070,
    'username' => 'admin',
    'password' => 'KYLIN',
]));
// Optional HTTP client and PSR-3 logger: new KylinClient($config, $http, $logger)

Configuration

KylinConfig::fromArray() accepts:

The config can also be constructed directly with camelCase properties.

Querying

query() sends POST /kylin/api/query with {sql, project, limit, offset} and returns a ResultSet:

$result = $kylin->query(
    'SELECT ID FROM KYLIN_SALES',
    project: 'learn_kylin',
    limit: 100,
    offset: 0,
);

$result->columns(); // columnMeta entries: [['name' => 'ID', 'label' => 'ID', 'dataType' => 'integer']]
$result->rows();    // [[1], [2]]
$result->count();   // number of rows
$result->raw();     // raw responses returned by Kylin

When project is omitted the configured default is used. A response with isException = true raises Erikwang2013\BigData\Exception\RequestException whose message is the server's exceptionMessage.

Metadata

$kylin->cubes(offset: 0, limit: 100);   // GET /kylin/api/cubes
$kylin->models(offset: 0, limit: 100);  // GET /kylin/api/models
$kylin->jobs(['status' => 'RUNNING']);  // GET /kylin/api/jobs, filters as query params

Each method returns the list under the response's cubes / models / jobs key (or the decoded payload when the server returns a bare list). The configured project is sent as the project query parameter unless a filter overrides it.

Start a cube build:

$kylin->buildCube(
    'kylin_sales_cube',
    '2026-01-01 00:00:00',
    '2026-01-02 00:00:00',
    buildType: 'BUILD',
);

This sends PUT /kylin/api/cubes/{cube}/rebuild with {startTime, endTime, buildType} (buildType defaults to BUILD) and returns the decoded response.

Logging

KylinClient accepts an optional PSR-3 logger as its third constructor argument and defaults to Psr\Log\NullLogger. Debug records contain the HTTP method and URI only — SQL and the Authorization header are never logged.

Errors

Transport failures throw Erikwang2013\BigData\Exception\ConnectionException. Any non-2xx HTTP response, invalid JSON, or a Kylin isException response raises Erikwang2013\BigData\Exception\RequestException, which exposes public $statusCode and $body when available. Both extend Erikwang2013\BigData\Exception\BigDataException.

Notes

• Basic auth is mandatory (username and password are required).
• No automatic retries are performed.