20 Commits

Author SHA1 Message Date
87c3548f91 2.0.5 2022-07-27 22:42:09 +02:00
af3d461593 fix(core): update 2022-07-27 22:42:08 +02:00
bd9b3bb985 2.0.4 2022-07-27 08:32:55 +02:00
169e49b93d fix(core): update 2022-07-27 08:32:55 +02:00
2db4010648 2.0.3 2022-07-27 08:29:59 +02:00
b4ae49b604 fix(core): update 2022-07-27 08:29:59 +02:00
9bdd9484f1 2.0.2 2022-05-13 08:52:15 +02:00
1dcfbe7f5d fix(core): update 2022-05-13 08:52:14 +02:00
e644fed03c 2.0.1 2022-03-14 20:00:04 +01:00
b67acc1b78 fix(TimeDataTable options): switch to better options 2022-03-14 20:00:03 +01:00
51e76623f9 2.0.0 2022-03-14 14:29:23 +01:00
f792bd1907 BREAKING CHANGE(core): switch to esm 2022-03-14 14:29:23 +01:00
0139634902 1.0.12 2022-03-14 13:54:10 +01:00
100cba8d74 fix(core): update 2022-03-14 13:54:09 +01:00
2af84de938 1.0.11 2022-03-14 13:52:42 +01:00
f5ba97aa3d fix(core): update 2022-03-14 13:52:42 +01:00
73529b353c 1.0.10 2022-03-08 18:55:00 +01:00
88d1b6596f fix(TimDataTable): cleanup 2022-03-08 18:55:00 +01:00
6ef8812a79 1.0.9 2022-03-08 18:54:10 +01:00
3034ef2edd fix(TTL): tables now have a default TTL for data of 1 MONTH 2022-03-08 18:54:10 +01:00
11 changed files with 5858 additions and 18132 deletions

View File

@ -22,5 +22,6 @@
}
}
}
]
],
"typescript.tsdk": "node_modules/typescript/lib"
}

23753
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,10 +1,11 @@
{
"name": "@pushrocks/smartclickhouse",
"version": "1.0.8",
"version": "2.0.5",
"private": false,
"description": "an odm for talking to clickhouse",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH",
"license": "MIT",
"scripts": {
@ -14,17 +15,20 @@
"createClickhouse": "docker run --name some-clickhouse-server --ulimit nofile=262144:262144 -p 8123:8123 -p 9000:9000 --volume=$PWD/.nogit/testdatabase:/var/lib/clickhouse yandex/clickhouse-server"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.25",
"@gitzone/tsbundle": "^1.0.78",
"@gitzone/tstest": "^1.0.44",
"@pushrocks/tapbundle": "^4.0.8",
"@types/node": "^17.0.21",
"@gitzone/tsbuild": "^2.1.63",
"@gitzone/tsbundle": "^2.0.6",
"@gitzone/tstest": "^1.0.72",
"@pushrocks/tapbundle": "^5.0.4",
"@types/node": "^18.6.1",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.15.0"
},
"dependencies": {
"@depyronick/clickhouse-client": "^1.0.12",
"@pushrocks/smartobject": "^1.0.9"
"@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"
},
"browserslist": [
"last 1 chrome versions"

View File

@ -1,11 +1,11 @@
import { expect, expectAsync, tap } from '@pushrocks/tapbundle';
import * as smartclickhouse from '../ts/index';
import * as smartclickhouse from '../ts/index.js';
let testClickhouseDb: smartclickhouse.SmartClickHouseDb;
tap.test('first test', async () => {
testClickhouseDb = new smartclickhouse.SmartClickHouseDb({
host: 'localhost',
url: 'http://localhost:8123',
database: 'test2',
});
});
@ -14,10 +14,10 @@ tap.test('should start the clickhouse db', async () => {
await testClickhouseDb.start(true);
});
tap.test('should create a timedatatable', async () => {
tap.test('should create a timedatatable', async (toolsArg) => {
const table = await testClickhouseDb.getTable('analytics');
let i = 0;
while(i < 10) {
while(i < 5000) {
await table.addData({
timestamp: Date.now(),
message: `hello this is a message ${i}`,
@ -28,6 +28,8 @@ tap.test('should create a timedatatable', async () => {
}
});
i++;
console.log(`logged ${i} of 5000 lines.`);
await toolsArg.delayFor(1);
}
});

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@pushrocks/smartclickhouse',
version: '2.0.5',
description: 'an odm for talking to clickhouse'
}

View File

@ -1,2 +1,2 @@
export * from './smartclickhouse.classes.smartclickhouse';
export * from './smartclickhouse.classes.timedatatable';
export * from './smartclickhouse.classes.smartclickhouse.js';
export * from './smartclickhouse.classes.timedatatable.js';

View File

@ -1,14 +1,15 @@
import * as plugins from './smartclickhouse.plugins';
import { TimeDataTable } from './smartclickhouse.classes.timedatatable';
import * as plugins from './smartclickhouse.plugins.js';
import { TimeDataTable } from './smartclickhouse.classes.timedatatable.js';
export interface IClickhouseConstructorOptions {
host: string;
url: string;
database: string;
password?: string;
}
export class SmartClickHouseDb {
public options: IClickhouseConstructorOptions;
public defaultClient: plugins.clickhouse.ClickHouseClient;
public clickhouseClient: plugins.clickhouse.ClickHouseClient;
constructor(optionsArg: IClickhouseConstructorOptions) {
@ -20,23 +21,50 @@ export class SmartClickHouseDb {
*/
public async start(dropOld = false) {
console.log(`Connecting to default database first.`);
const defaultClient = new plugins.clickhouse.ClickHouseClient({
...this.options,
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',
});
await this.pingDatabaseUntilAvailable();
console.log(`Create database ${this.options.database}, if it does not exist...`);
if (dropOld) {
await defaultClient.queryPromise(`DROP DATABASE IF EXISTS ${this.options.database}`);
}
await defaultClient.queryPromise(`CREATE DATABASE IF NOT EXISTS ${this.options.database}`);
await this.createDatabase(dropOld);
console.log(`Ensured database. Now connecting to wanted database: ${this.options.database}`);
this.clickhouseClient = new plugins.clickhouse.ClickHouseClient({
...this.options,
...defaultOptions
});
console.log(`trying to ping database...`);
const result = await this.clickhouseClient.ping();
console.log(`Ping successfull?: ${result}`);
}
public async createDatabase(dropOld: boolean = false) {
if (dropOld) {
await this.defaultClient.queryPromise(`DROP DATABASE IF EXISTS ${this.options.database}`);
}
await this.defaultClient.queryPromise(`CREATE DATABASE IF NOT EXISTS ${this.options.database}`);
}
public async pingDatabaseUntilAvailable() {
let available = false;
while(!available) {
available = await this.defaultClient.ping().catch(err => {
return false;
});
if (!available) {
console.log(`NOT OK: tried pinging ${this.options.url}... Trying again in 5 seconds.`);
await plugins.smartdelay.delayFor(5000);
}
}
}
/**

View File

@ -1,5 +1,5 @@
import * as plugins from './smartclickhouse.plugins';
import { SmartClickHouseDb } from './smartclickhouse.classes.smartclickhouse';
import * as plugins from './smartclickhouse.plugins.js';
import { SmartClickHouseDb } from './smartclickhouse.classes.smartclickhouse.js';
export type TClickhouseColumnDataType = 'String' | "DateTime64(3, 'Europe/Berlin')" | 'Float64' | 'Array(String)' | 'Array(Float64)';
export interface IColumnInfo {
@ -26,21 +26,36 @@ export interface IColumnInfo {
datetime_precision: '3';
}
export interface ITimeDataTableOptions {
tableName: string;
retainDataForDays: number;
}
export class TimeDataTable {
public static async getTable(smartClickHouseDbRefArg: SmartClickHouseDb, tableNameArg: string) {
const newTable = new TimeDataTable(smartClickHouseDbRefArg, tableNameArg);
const newTable = new TimeDataTable(smartClickHouseDbRefArg, {
tableName: tableNameArg,
retainDataForDays: 30
});
// create table in clickhouse
await smartClickHouseDbRefArg.clickhouseClient
.queryPromise(`CREATE TABLE IF NOT EXISTS ${newTable.tableName} (
.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.tableName}" in databse ${newTable.smartClickHouseDbRef.options.database} has the following columns:`
`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}`);
@ -51,16 +66,16 @@ export class TimeDataTable {
}
// INSTANCE
public healingDeferred: plugins.smartpromise.Deferred<any>;
public smartClickHouseDbRef: SmartClickHouseDb;
public tableName: string;
public options: ITimeDataTableOptions;
constructor(smartClickHouseDbRefArg: SmartClickHouseDb, tableNameArg: string) {
constructor(smartClickHouseDbRefArg: SmartClickHouseDb, optionsArg: ITimeDataTableOptions) {
this.smartClickHouseDbRef = smartClickHouseDbRefArg;
this.tableName = tableNameArg;
this.options = optionsArg;
}
public columns: IColumnInfo[] = [];
public seenPaths: { pathName: string; type: TClickhouseColumnDataType }[] = [];
/**
* updates the columns
@ -69,7 +84,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.tableName}'
AND table LIKE '${this.options.tableName}'
`);
return this.columns;
}
@ -78,6 +93,7 @@ export class TimeDataTable {
* stores a json and tries to map it to the nested syntax
*/
public async addData(dataArg: any) {
// the storageJson
let storageJson: { [key: string]: any } = {};
@ -114,7 +130,7 @@ export class TimeDataTable {
await checkPath(pathArg, typeArg, true);
return;
}
const alterString = `ALTER TABLE ${this.tableName} ADD COLUMN ${pathArg} ${typeArg} FIRST`
const alterString = `ALTER TABLE ${this.options.tableName} ADD COLUMN ${pathArg} ${typeArg} FIRST`
try {
await this.smartClickHouseDbRef.clickhouseClient.queryPromise(`
${alterString}
@ -148,9 +164,20 @@ export class TimeDataTable {
storageJson[key] = value;
}
const result = await this.smartClickHouseDbRef.clickhouseClient.insertPromise(this.tableName, [
const result = await this.smartClickHouseDbRef.clickhouseClient.insertPromise(this.options.tableName, [
storageJson,
]);
]).catch(async () => {
if (this.healingDeferred) {
return;
}
this.healingDeferred = plugins.smartpromise.defer();
console.log(`Ran into an error. Trying to set up things properly again.`);
await this.smartClickHouseDbRef.pingDatabaseUntilAvailable();
await this.smartClickHouseDbRef.createDatabase();
this.columns = [];
this.healingDeferred.resolve();
this.healingDeferred = null;
});
return result;
}
}

View File

@ -1,8 +1,14 @@
// @pushrocks scope
import * as smartdelay from '@pushrocks/smartdelay';
import * as smartobject from '@pushrocks/smartobject';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smarturl from '@pushrocks/smarturl';
export {
smartobject
smartdelay,
smartobject,
smartpromise,
smarturl
}
// thirdparty

10
tsconfig.json Normal file
View File

@ -0,0 +1,10 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true
}
}

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}