clickhouse-clickhouse

Namespace

clickhouse-clickhouse

Description:

  • Unlock real-time data insights effortlessly with ClickHouse, the lightning-fast, open-source columnar database. Elevate your analytics and make data-driven decisions with speed and precision like never before!

Author:
Copyright:
  • 2025 Eyevinn Technology AB
See:

Methods

(async, static) createClickhouseClickhouseInstance(context, body) → {ClickhouseClickhouse}

Description:

  • Create a new ClickHouse Server instance

Example
import { Context } from '@osaas/client-core';
import { createClickhouseClickhouseInstance } from '@osaas/client-services';

const ctx = new Context();
const body: ClickhouseClickhouseConfig = { name: 'myinstance', ... };
const instance = await createClickhouseClickhouseInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body ClickhouseClickhouseConfig

Service instance configuration
Returns:
  • Service instance
Type
ClickhouseClickhouse

(async, static) getClickhouseClickhouseInstance(context, name) → {ClickhouseClickhouse}

Description:

  • Get a ClickHouse Server instance

Example
import { Context } from '@osaas/client-core';
import { getClickhouseClickhouseInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getClickhouseClickhouseInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the clickhouse-server to be retrieved
Returns:
  • Service instance
Type
ClickhouseClickhouse

(async, static) removeClickhouseClickhouseInstance(context, name)

Description:

  • Remove a ClickHouse Server instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the clickhouse-server to be removed