Skip to main content

ZTeraDB Configuration Guide

This guide explains how to configure the ZTeraDB Python client using the ZTeraDBConfig class.

🎯 What is ZTeraDBConfig?

ZTeraDBConfig is a PHP configuration object that contains all authentication details, environment settings, and optional connection settings required to connect your application to ZTeraDB Server.

It is required for every ZTeraDB connection.

🧩 Full Structure

from zteradb.zteradb_config import (
    ZTeraDBConfig,
    ENVS,
    ResponseDataTypes,
    Options
)

config = ZTeraDBConfig(
    client_key="string",
    access_key="string",
    secret_key="string",
    database_id="string",
    env=ENVS("dev | staging | qa | prod"),
    response_data_type=ResponseDataTypes("json"),
    options=Options(connection_pool=dict(
        min=0,
        max=0
    ))
)

🔎 Field-by-field Explanation

🔑 client_key​

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

🔐 access_key​

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

🧩 secret_key​

  • Secret signature key used to verify request authenticity.
  • You will only see it once when creating it.
  • Never share it or commit it to Git.

🗄 database_id​

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

🌍 env​

Defines which ZTeraDB environment you want to connect to.

Allowed values:

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

Usage example:

env=ENVS("dev")

📦 response_data_type​

  • Currently supports only "json":
response_data_type=ResponseDataTypes("json")
  • Future formats may be added later.

⚙️ options.connection_pool​

You can control automatic connection pooling:

FieldMeaning
minMinimum connections ZTeraDB should maintain
maxMaximum number of allowed connections

Example:

options=Options(connection_pool=dict(
    min=2,
    max=10
))

If omitted → ZTeraDB automatically manages the pool.

🧪 Complete Example

from zteradb.zteradb_config import (
    ZTeraDBConfig,
    Options,
    ENVS,
    ResponseDataTypes
)

config = ZTeraDBConfig(
    client_key="<Your ZTeraDB client key>",
    access_key="<Your ZTeraDB access key>",
    secret_key="<Your ZTeraDB secret key>",
    database_id="<Your ZTeraDB database id>",
    env=ENVS("dev"),
    response_data_type=ResponseDataTypes("json"),
    options=Options(connection_pool=dict(min=1, max=5))
)

⚠️ Common Mistakes (Read This!)

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

❌ Missing secret key
✔ Ensure all fields are present in environment variables

❌ Credentials stored inside code
✔ Always use .env variables to store keys

❌ No connection pool in high-traffic apps
✔ Set min and max based on workload

🎉 You are ready to create a connection!

Continue to:
👉 zteradb-connection.md