clickhouse-ts

clickhouse-ts

TS client for clickhouse database with using redis/nodejs caching rows for bulk insertion

import { Clickhouse } from 'clickhouse-ts'
import fs from 'fs'
import { serializeError } from 'serialize-error'

const client = new Clickhouse(
  {
    url: 'url',
    port: 8443,
    user: 'user',
    password: 'password',
    database: 'database',
    ca: fs.readFileSync('cert.crt')
  },
  {
    /*
      cacheClient: 'system' | 'redis' | undefined
      if 'system', Node.js will accumulate insert rows filtered by table name and insert by interval or overflowing
      if 'redis' Redis client will do the same
      if nothing package will not use caching
    */
    cacheClient: 'system',
    defaultResponseFormat: 'JSON',
    clickhouseOptions: {
      /*
        any clickhouse options
        https://clickhouse.tech/docs/en/operations/settings/settings/
      */
      send_progress_in_http_headers: '1'
    }
  }
)

client
  .query('WITH now() as t SELECT t', {
    responseFormat: 'TSV',
    // ...another query options
  })
  .then(result => result.data.data)
  .catch(e => serializeError(e))

client
  .insert(
    'strings',
    [{ date: '2021-01-01', string: 'string' }],
    {
      responseFormat: 'CSVWithNames' // or another format
      // another query options
    }
  )
  .then(response => response)
  .catch(e => serializeError(e))