6 Commits

Author SHA1 Message Date
eae7300439 2.0.8 2022-07-28 17:36:08 +02:00
7753e58036 fix(core): update 2022-07-28 17:36:08 +02:00
333e9c1316 2.0.7 2022-07-28 16:53:08 +02:00
479e0725e6 fix(core): update 2022-07-28 16:53:07 +02:00
fbf177b482 2.0.6 2022-07-27 23:11:03 +02:00
3272b87e10 fix(core): update 2022-07-27 23:11:03 +02:00
8 changed files with 227 additions and 326 deletions

347
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{
"name": "@pushrocks/smartclickhouse",
"version": "2.0.5",
"version": "2.0.8",
"private": false,
"description": "an odm for talking to clickhouse",
"main": "dist_ts/index.js",
@ -19,16 +19,16 @@
"@gitzone/tsbundle": "^2.0.6",
"@gitzone/tstest": "^1.0.72",
"@pushrocks/tapbundle": "^5.0.4",
"@types/node": "^18.6.1",
"@types/node": "^18.6.2",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.15.0"
},
"dependencies": {
"@depyronick/clickhouse-client": "^1.0.14",
"@pushrocks/smartdelay": "^2.0.13",
"@pushrocks/smartobject": "^1.0.10",
"@pushrocks/smartpromise": "^3.1.7",
"@pushrocks/smarturl": "^3.0.1"
"@pushrocks/smarturl": "^3.0.2",
"@pushrocks/webrequest": "^3.0.9"
},
"browserslist": [
"last 1 chrome versions"

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@pushrocks/smartclickhouse',
version: '2.0.5',
version: '2.0.8',
description: 'an odm for talking to clickhouse'
}

View File

@ -0,0 +1,5 @@
import * as plugins from './smartclickhouse.plugins.js';
export class ClickhouseDb {
}

View File

@ -0,0 +1,93 @@
import * as plugins from './smartclickhouse.plugins.js';
export interface IClickhouseHttpClientOptions {
username?: string;
password?: string;
url: string;
}
export class ClickhouseHttpClient {
// STATIC
public static async createAndStart(optionsArg: IClickhouseHttpClientOptions) {
const clickhouseHttpInstance = new ClickhouseHttpClient(optionsArg);
await clickhouseHttpInstance.start();
return clickhouseHttpInstance;
}
// INSTANCE
public options: IClickhouseHttpClientOptions;
public webrequestInstance = new plugins.webrequest.WebRequest({
logging: false
});
public computedProperties: {
connectionUrl: string;
parsedUrl: plugins.smarturl.Smarturl;
} = {
connectionUrl: null,
parsedUrl: null,
};
constructor(optionsArg: IClickhouseHttpClientOptions) {
this.options = optionsArg;
}
public async start() {
this.computedProperties.parsedUrl = plugins.smarturl.Smarturl.createFromUrl(this.options.url);
console.log(this.computedProperties.parsedUrl);
this.computedProperties.connectionUrl = this.computedProperties.parsedUrl.toString();
}
public async ping() {
const ping = await this.webrequestInstance.request(this.computedProperties.connectionUrl.toString(), {
method: 'GET',
timeoutMs: 1000,
});
return ping.status === 200 ? true : false;
}
public async queryPromise(queryArg: string) {
const returnArray = [];
const response = await this.webrequestInstance.request(`${this.computedProperties.connectionUrl}?query=${encodeURIComponent(queryArg)}`, {
method: 'POST',
headers: this.getHeaders(),
});
// console.log('===================');
// console.log(this.computedProperties.connectionUrl);
// console.log(queryArg);
// console.log((await response.clone().text()).split(/\r?\n/))
if (response.headers.get('X-ClickHouse-Format') === 'JSONEachRow') {
const jsonList = await response.text();
const jsonArray = jsonList.split('\n');
for (const jsonArg of jsonArray) {
if (!jsonArg) {
continue;
}
returnArray.push(JSON.parse(jsonArg));
}
} else {
}
return returnArray
}
public async insertPromise(databaseArg: string, tableArg: string, documents: any[]) {
const queryArg = `INSERT INTO ${databaseArg}.${tableArg} FORMAT JSONEachRow`;
const response = await this.webrequestInstance.request(`${this.computedProperties.connectionUrl}?query=${encodeURIComponent(queryArg)}`, {
method: 'POST',
body: documents.map(docArg => JSON.stringify(docArg)).join('\n'),
headers: this.getHeaders()
});
return response;
}
private getHeaders() {
const headers: {[key: string]: string} = {}
if (this.options.username) {
headers['X-ClickHouse-User'] = this.options.username;
}
if (this.options.password) {
headers['X-ClickHouse-Key'] = this.options.password;
}
return headers;
}
}

View File

@ -1,16 +1,17 @@
import * as plugins from './smartclickhouse.plugins.js';
import { TimeDataTable } from './smartclickhouse.classes.timedatatable.js';
import { ClickhouseHttpClient } from './smartclickhouse.classes.httpclient.js';
export interface IClickhouseConstructorOptions {
url: string;
database: string;
username?: string;
password?: string;
}
export class SmartClickHouseDb {
public options: IClickhouseConstructorOptions;
public defaultClient: plugins.clickhouse.ClickHouseClient;
public clickhouseClient: plugins.clickhouse.ClickHouseClient;
public clickhouseClient: ClickhouseHttpClient;
constructor(optionsArg: IClickhouseConstructorOptions) {
this.options = optionsArg;
@ -21,43 +22,24 @@ export class SmartClickHouseDb {
*/
public async start(dropOld = false) {
console.log(`Connecting to default database first.`);
const defaultOptions: {[keyArg: string]: string} = {};
// the protocol, url and host
const parsedUrl = plugins.smarturl.Smarturl.createFromUrl(this.options.url);
parsedUrl.protocol === 'https' ? defaultOptions.protocol = plugins.clickhouse.ClickHouseConnectionProtocol.HTTPS : null;
parsedUrl.protocol === 'http' ? defaultOptions.protocol = plugins.clickhouse.ClickHouseConnectionProtocol.HTTP : null;
defaultOptions.host = parsedUrl.hostname;
defaultOptions.port = parsedUrl.port;
// the database
defaultOptions.database = this.options.database;
// the password
this.options.password ? defaultOptions.password = this.options.password : null;
// lets connect
this.defaultClient = new plugins.clickhouse.ClickHouseClient({
...defaultOptions,
database: 'default',
});
this.clickhouseClient = await ClickhouseHttpClient.createAndStart(this.options);
await this.pingDatabaseUntilAvailable();
console.log(`Create database ${this.options.database}, if it does not exist...`);
await this.createDatabase(dropOld);
console.log(`Ensured database. Now connecting to wanted database: ${this.options.database}`);
this.clickhouseClient = new plugins.clickhouse.ClickHouseClient({
...defaultOptions
});
}
public async createDatabase(dropOld: boolean = false) {
if (dropOld) {
await this.defaultClient.queryPromise(`DROP DATABASE IF EXISTS ${this.options.database}`);
await this.clickhouseClient.queryPromise(`DROP DATABASE IF EXISTS ${this.options.database}`);
}
await this.defaultClient.queryPromise(`CREATE DATABASE IF NOT EXISTS ${this.options.database}`);
await this.clickhouseClient.queryPromise(`CREATE DATABASE IF NOT EXISTS ${this.options.database}`);
}
public async pingDatabaseUntilAvailable() {
let available = false;
while(!available) {
available = await this.defaultClient.ping().catch(err => {
available = await this.clickhouseClient.ping().catch(err => {
return false;
});
if (!available) {

View File

@ -38,29 +38,7 @@ export class TimeDataTable {
retainDataForDays: 30
});
// create table in clickhouse
await smartClickHouseDbRefArg.clickhouseClient
.queryPromise(`
CREATE TABLE IF NOT EXISTS ${newTable.options.tableName} (
timestamp DateTime64(3, 'Europe/Berlin'),
message String
) ENGINE=MergeTree() ORDER BY timestamp`);
// lets adjust the TTL
await smartClickHouseDbRefArg.clickhouseClient
.queryPromise(`
ALTER TABLE ${newTable.options.tableName} MODIFY TTL toDateTime(timestamp) + INTERVAL ${newTable.options.retainDataForDays} DAY
`);
await newTable.updateColumns();
console.log(`=======================`)
console.log(
`table with name "${newTable.options.tableName}" in databse ${newTable.smartClickHouseDbRef.options.database} has the following columns:`
);
for (const column of newTable.columns) {
console.log(`>> ${column.name}: ${column.type}`);
}
console.log('^^^^^^^^^^^^^^\n');
await newTable.setup();
return newTable;
}
@ -75,6 +53,32 @@ export class TimeDataTable {
this.options = optionsArg;
}
public async setup() {
// create table in clickhouse
await this.smartClickHouseDbRef.clickhouseClient
.queryPromise(`
CREATE TABLE IF NOT EXISTS ${this.smartClickHouseDbRef.options.database}.${this.options.tableName} (
timestamp DateTime64(3, 'Europe/Berlin'),
message String
) ENGINE=MergeTree() ORDER BY timestamp`);
// lets adjust the TTL
await this.smartClickHouseDbRef.clickhouseClient
.queryPromise(`
ALTER TABLE ${this.smartClickHouseDbRef.options.database}.${this.options.tableName} MODIFY TTL toDateTime(timestamp) + INTERVAL ${this.options.retainDataForDays} DAY
`);
await this.updateColumns();
console.log(`=======================`)
console.log(
`table with name "${this.options.tableName}" in database ${this.smartClickHouseDbRef.options.database} has the following columns:`
);
for (const column of this.columns) {
console.log(`>> ${column.name}: ${column.type}`);
}
console.log('^^^^^^^^^^^^^^\n');
}
public columns: IColumnInfo[] = [];
/**
@ -84,7 +88,7 @@ export class TimeDataTable {
this.columns = await this.smartClickHouseDbRef.clickhouseClient.queryPromise(`
SELECT * FROM system.columns
WHERE database LIKE '${this.smartClickHouseDbRef.options.database}'
AND table LIKE '${this.options.tableName}'
AND table LIKE '${this.options.tableName}' FORMAT JSONEachRow
`);
return this.columns;
}
@ -130,7 +134,7 @@ export class TimeDataTable {
await checkPath(pathArg, typeArg, true);
return;
}
const alterString = `ALTER TABLE ${this.options.tableName} ADD COLUMN ${pathArg} ${typeArg} FIRST`
const alterString = `ALTER TABLE ${this.smartClickHouseDbRef.options.database}.${this.options.tableName} ADD COLUMN ${pathArg} ${typeArg} FIRST`
try {
await this.smartClickHouseDbRef.clickhouseClient.queryPromise(`
${alterString}
@ -164,7 +168,7 @@ export class TimeDataTable {
storageJson[key] = value;
}
const result = await this.smartClickHouseDbRef.clickhouseClient.insertPromise(this.options.tableName, [
const result = await this.smartClickHouseDbRef.clickhouseClient.insertPromise(this.smartClickHouseDbRef.options.database, this.options.tableName, [
storageJson,
]).catch(async () => {
if (this.healingDeferred) {
@ -174,6 +178,7 @@ export class TimeDataTable {
console.log(`Ran into an error. Trying to set up things properly again.`);
await this.smartClickHouseDbRef.pingDatabaseUntilAvailable();
await this.smartClickHouseDbRef.createDatabase();
await this.setup();
this.columns = [];
this.healingDeferred.resolve();
this.healingDeferred = null;

View File

@ -3,15 +3,12 @@ import * as smartdelay from '@pushrocks/smartdelay';
import * as smartobject from '@pushrocks/smartobject';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smarturl from '@pushrocks/smarturl';
import * as webrequest from '@pushrocks/webrequest';
export {
smartdelay,
smartobject,
smartpromise,
smarturl
smarturl,
webrequest,
}
// thirdparty
import * as clickhouse from '@depyronick/clickhouse-client';
export { clickhouse };