Skip to main content

ZTeraDB Node.js Client Driver

Welcome!
This documentation will walk you through ZTeraDB step-by-step, using simple language and practical examples.


๐Ÿ“˜ What Is ZTeraDB?

ZTeraDB helps you connect to your existing databases (PostgreSQL, MySQL, MSSQL, etc.) through a single unified platform.
You write one query language (ZQL) instead of different SQL dialects.


๐Ÿง  Architecture (Simple Explanation)

Your App โ†’ ZTeraDB Node Client โ†’ ZTeraDB Server โ†’ Your Databases

You never connect to the database directly.
ZTeraDB does that for you.


โญ Features

  • ๐Ÿš€ Unified Query Language (ZQL)
  • ๐Ÿ”Œ Easy integration with any Node.js app
  • ๐Ÿงต Async/await support
  • โš™๏ธ Auto-managed connections
  • ๐Ÿ” Secure key-based authentication
  • ๐ŸŽฏ Clean query builder (insert, select, update, delete)
  • ๐Ÿงฎ Advanced math and logical filters
  • ๐Ÿ“– Beginner-friendly workflows

๐Ÿ›  Requirements

  • Node.js 18.20.7+
  • Basic JavaScript knowledge
  • ZTeraDB account (for clientKeys)

๐Ÿ“ฆ Install

npm install zteradb

Or Yarn:

yarn add zteradb

๐Ÿš€ Quick Start (Hello World)

import { ZTeraDBConnect, ZTeraDBQuery } from "zteradb";

const config = JSON.parse(process.env.ZTERADB_CONFIG);

const db = ZTeraDBConnect(config, "db1.zteradb.com", 7777);

const query = new ZTeraDBQuery("user").select();

const users = await db.run(query);

for await (const row of users) {
console.log(row);
}

db.close();

๐Ÿ—‚ Documentation Sections