Skip to main content

ZTeraDB Configuration Guide

This guide explains how to configure the ZTeraDB Node.js client using the ZTeraDBConfig object.

🎯 What is ZTeraDBConfig?

ZTeraDBConfig is a JavaScript object that contains all the authentication and environment settings required to connect your application to ZTeraDB Server.

It is required for every ZTeraDB connection.

🧩 Full Structure

const ZTeraDBConfig = {
  clientKey: "string",
  accessKey: "string",
  secretKey: "string",
  databaseID: "string",
  env: "dev | staging | qa | prod",
  responseDataType: "json",
  options: {
    connectionPool: {
      min: 0,
      max: 0
    }
  }
};

🔎 Field-by-field Explanation

🔑 clientKey​

  • Your unique ZTeraDB account key.
  • Get it from: Dashboard → Security Credentials.

🔐 accessKey​

  • Required for authenticating outgoing requests.
  • You can create multiple accessKeys.
  • Only one active access key is allowed at a time.

🧩 secretKey​

  • Secret signature key used to verify request authenticity.
  • You will only see it once when creating it.
  • Keep it safe and never commit it to Git.

🗄 databaseID​

  • Unique ID of your ZTeraDB database.
  • Example: "7K3WHGOJKJJEJ3PFJM407QO25F".

🌍 env​

Defines which ZTeraDB environment your database belongs to.

Allowed values:

  • dev -> Development Environment
  • staging -> Staging Environment
  • qa -> QA Environment
  • prod -> Production Environment

📦 responseDataType​

  • Currently only "json" is supported.
  • More formats may be added later.

⚙️ options.connectionPool​

You can control automatic connection pooling:

FieldMeaning
minMinimum number of connections ZTeraDB keeps open
maxMaximum number of connections allowed

If not set → ZTeraDB manages connections automatically.

options: {
  connectionPool: {
    min: 2,
    max: 10
  }
}

🧪 Complete Example

const ZTeraDBConfig = {
  clientKey: "<Your ZTeraDB client key>",
  accessKey: "<Your ZTeraDB access key>",
  secretKey: "<Your ZTeraDB secret key>",
  databaseID: "<Your ZTeraDB database id>",
  env: "dev",
  responseDataType: "json",
  options: {
    connectionPool: {
      min: 1,
      max: 5
    }
  }
};

⚠️ Common Mistakes (Read This!)

❌ Using wrong environment name
✔ Use only: "dev", "staging", "qa", "prod"

❌ Missing secretKey
✔ Ensure .env contains all required fields

❌ Storing keys in GitHub
✔ Put all keys in .env only

🎉 You are ready to create a connection!

Continue to:
👉 zteradb-connection.md