Skip to main content

Connect to the Aiven for ClickHouse® service with Node.js

Learn how to connect to your Aiven for ClickHouse® service with Node.js using the official Node.js client for connecting to ClickHouse and the HTTPS port.

Prerequisites​

tip

You can install the Node.js client for connecting to ClickHouse using

npm i @clickhouse/client

Identify connection information​

To run the code for connecting to your service, first identify values of the following variables:

VariableDescription
CLICKHOUSE_HOSThttps://HOST:HTTPS_PORT, where Host and Port for the ClickHouse connection are available in the Aiven console: Service Overview > Connection information > ClickHouse HTTPS & JDBC
CLICKHOUSE_USERUser for the ClickHouse connection available in the Aiven console: Service Overview > Connection information > ClickHouse HTTPS & JDBC
CLICKHOUSE_PASSWORDPassword for the ClickHouse connection available in the Aiven console: Service Overview > Connection information > ClickHouse HTTPS & JDBC

Connect to the service​

Replace the placeholders in the code with meaningful information on your service connection and run the code.

import { createClient } from '@clickhouse/client'
const client = createClient({
    host: "CLICKHOUSE_HOST",
    username: "CLICKHOUSE_USER",
    password: "CLICKHOUSE_PASSWORD",
    database: "default",
})
const response = await client.query({
    query : "SELECT 1",
    format: "JSONEachRow",
    wait_end_of_query: 1,
})
const data = await response.json()
console.log(data)

Now you have your service connection set up and you can proceed to uploading data into your database.

For information on how to connect to the Aiven for Clickhouse service with the ClickHouse client, see Connect with the ClickHouse client.