Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/cubejs-clickhouse-driver/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
data
11 changes: 11 additions & 0 deletions packages/cubejs-clickhouse-driver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ Pure Javascript ClickHouse driver.

[Learn more](https://github.com/statsbotco/cube.js#getting-started)

### Testing

To test follow the following steps

```
$ yarn
$ docker-compose up -d
$ yarn test
$ docker-compose stop
```

### License

Cube.js ClickHouse Database Driver is [Apache 2.0 licensed](./LICENSE).
31 changes: 19 additions & 12 deletions packages/cubejs-clickhouse-driver/driver/ClickHouseDriver.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const ClickHouse = require('clickhouse');
const ClickHouse = require('@apla/clickhouse');
const genericPool = require('generic-pool');
const BaseDriver = require('@cubejs-backend/query-orchestrator/driver/BaseDriver');

Expand All @@ -8,9 +8,9 @@ class ClickHouseDriver extends BaseDriver {
this.config = {
host: process.env.CUBEJS_DB_HOST,
port: process.env.CUBEJS_DB_PORT,
auth: process.env.CUBEJS_DB_USER + ":" + process.env.CUBEJS_DB_PASS,
auth: process.env.CUBEJS_DB_USER || process.env.CUBEJS_DB_PASS ? process.env.CUBEJS_DB_USER + ":" + process.env.CUBEJS_DB_PASS : '',
queryOptions: {
database: process.env.CUBEJS_DB_NAME
database: process.env.CUBEJS_DB_NAME || config.database
},
...config
};
Expand Down Expand Up @@ -76,21 +76,16 @@ class ClickHouseDriver extends BaseDriver {
return promise;
}

async testConnection() {
const conn = await this.pool._factory.create();
try {
return await conn.querying('SELECT 1');
} finally {
await this.pool._factory.destroy(conn);
}
testConnection() {
return this.query("SELECT 1")
}

query(query, values) {
// TODO: handle values
const self = this;
return this.withConnection(connection => {
return connection.querying(query)
.then(res => res);
return connection.querying(query, {dataObjects:true})
.then(res => res.data);
});
}

Expand All @@ -109,6 +104,18 @@ class ClickHouseDriver extends BaseDriver {
WHERE database = '${this.config.database}'
`;
}

async createSchemaIfNotExists(schemaName) {
let schemas = await this.query(`SELECT name FROM system.databases WHERE name = '${schemaName}'`)
if (schemas.length === 0) {
await this.query(`CREATE DATABASE ${schemaName}`);
}
}

getTablesQuery(schemaName) {
return this.query(`SELECT name as table_name FROM system.tables WHERE database = '${schemaName}'`)
}

}

module.exports = ClickHouseDriver;
7 changes: 6 additions & 1 deletion packages/cubejs-clickhouse-driver/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,10 @@
"@cubejs-backend/query-orchestrator": "^0.0.21",
"generic-pool": "^3.6.0"
},
"license": "Apache-2.0"
"license": "Apache-2.0",
"devDependencies": {
"should": "^13.2.3",
"mocha": "^5.2.0",
"testcontainers": "^1.1.10"
}
}
107 changes: 107 additions & 0 deletions packages/cubejs-clickhouse-driver/test/ClickHouseDriverTest.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
const ClickHouseDriver = require('../driver/ClickHouseDriver');
require('should');
const { GenericContainer } = require("testcontainers");


describe('ClickHouseDriver', () => {


let container, config
before(async function() {
this.timeout(20000);

container = await new GenericContainer("yandex/clickhouse-server")
.withExposedPorts(8123)
.start();

config = {
host:'localhost',
port:container.getMappedPort(8123),
}

})

after(async ()=>{
if (container) {
await container.stop()
}
})

async function doWithDriver(callback) {
let driver = new ClickHouseDriver(config)
try {
await callback(driver)
}
finally {
await driver.release()
}
}

it('should construct', async () => {
await doWithDriver(driver=>{})
})
it('should test connection', async () => {
await doWithDriver(async (driver) => {
await driver.testConnection()
})
})
it('should select raw sql', async () => {
await doWithDriver(async (driver) => {
let numbers = await driver.query("SELECT number FROM system.numbers LIMIT 10")
numbers.should.be.deepEqual([
{ number: '0' },
{ number: '1' },
{ number: '2' },
{ number: '3' },
{ number: '4' },
{ number: '5' },
{ number: '6' },
{ number: '7' },
{ number: '8' },
{ number: '9' },
])
})
})
it('should select raw sql multiple times', async () => {
await doWithDriver(async (driver) => {
let numbers = await driver.query("SELECT number FROM system.numbers LIMIT 5")
numbers.should.be.deepEqual([
{ number: '0' },
{ number: '1' },
{ number: '2' },
{ number: '3' },
{ number: '4' },
])
numbers = await driver.query("SELECT number FROM system.numbers LIMIT 5")
numbers.should.be.deepEqual([
{ number: '0' },
{ number: '1' },
{ number: '2' },
{ number: '3' },
{ number: '4' },
])
})
})
it('should get tables', async () => {
await doWithDriver(async (driver) => {
let tables = await driver.getTablesQuery("system")
tables.should.containDeep([
{table_name:"numbers"},
])
})
})

it('should create schema if not exists', async () => {
await doWithDriver(async (driver) => {
let name = `temp_${Date.now()}`
try {
await driver.createSchemaIfNotExists(name)
}
finally {
await driver.query(`drop database ${name}`)
}
})
})


})
Loading