Skip to content

Native NodeJS bindings for chDB, an in-process SQL OLAP Engine powered by ClickHouse

License

Notifications You must be signed in to change notification settings

chdb-io/chdb-node

Repository files navigation

npm version

chdb-node

chDB nodejs bindings.

Install

npm i chdb

Usage

const { query, Session } = require("chdb");

var ret;

// Test standalone query
ret = query("SELECT version(), 'Hello chDB', chdb()", "CSV");
console.log("Standalone Query Result:", ret);

// Test session query
// Create a new session instance
const session = new Session("./chdb-node-tmp");
ret = session.query("SELECT 123", "CSV")
console.log("Session Query Result:", ret);
ret = session.query("CREATE DATABASE IF NOT EXISTS testdb;" +
    "CREATE TABLE IF NOT EXISTS testdb.testtable (id UInt32) ENGINE = MergeTree() ORDER BY id;");

session.query("USE testdb; INSERT INTO testtable VALUES (1), (2), (3);")

ret = session.query("SELECT * FROM testtable;")
console.log("Session Query Result:", ret);

// If an error occurs, it will be thrown
try {
    session.query("SELECT * FROM non_existent_table;", "CSV");
}
catch (e) {
    console.log("Error:", e.message);
}

// Clean up the session
session.cleanup();

Build from source

npm run libchdb
npm install
npm run test