Configuration

Esix makes it easy to configure your database connection for different environments (local, test, and production) using environment variables. This approach helps keep your configuration flexible and secure.

Database Connection Options

Here are the environment variables you can use to configure your database connection:

`DB_ADAPTER`

The adapter handles the MongoDB connection. You can choose between:

default - Uses the official MongoDB package for production
mock - Uses mongo-mock which is perfect for testing

Default: default

`DB_URL`

The connection URL for your MongoDB database. Default: mongodb://127.0.0.1:27017/ Example:

DB_URL=mongodb://localhost:27017/
# or for MongoDB Atlas
DB_URL=mongodb+srv://username:password@cluster.mongodb.net/

`DB_MAX_POOL_SIZE`

The maximum number of connections in the connection pool. This helps manage database performance under load. Default: 10

`DB_DATABASE`

The name of the database to connect to. Default: (empty string) Example:

DB_DATABASE=myapp_production

`DB_LOG_QUERIES`

Enables the built-in query logger. When set to 1 or true, Esix logs every MongoDB operation to the console using console.debug, including the collection, operation, arguments, and duration. Default: (disabled) Example:

DB_LOG_QUERIES=true

Setting Up Environment Variables

For local development, we recommend using the dotenv package to manage your environment variables:

npm install dotenv

Create a .env file in your project root:

DB_URL=mongodb://localhost:27017/
DB_DATABASE=myapp_development
DB_MAX_POOL_SIZE=5

Then load it in your application:

import 'dotenv/config'
// Your Esix code here

⚠️ Security Note: Never commit secrets or production credentials to version control. Add .env to your .gitignore file!

Query Logging

Query logging is opt-in and has zero overhead when disabled. The quickest way to turn it on is the DB_LOG_QUERIES environment variable, which logs every MongoDB operation with console.debug:

esix blog-posts.findOne([{"_id":"5f3568f2a0cdd1c9ba411c43"}]) took 0.8ms

For full control over where the entries go, register a custom logger with setQueryLogger. The custom logger takes precedence over the built-in console logger:

import { setQueryLogger } from 'esix'

setQueryLogger((entry) => {
  console.log(
    `${entry.collectionName}.${entry.operation} took ${entry.durationMs.toFixed(1)}ms`
  )
})

Each entry contains:

args - the arguments passed to the driver method
collectionName - the collection the operation ran against
durationMs - how long the operation took, in milliseconds
error - the error the operation rejected with, if any
operation - the driver method that was invoked, e.g. find or updateOne

Pass null to clear the custom logger again:

setQueryLogger(null)

For Effect-managed connections and Config integration, see Effect configuration.

Getting Started

Models

Querying

Guides

Configuration

Database Connection Options

`DB_ADAPTER`

`DB_URL`

`DB_MAX_POOL_SIZE`

`DB_DATABASE`

`DB_LOG_QUERIES`

Setting Up Environment Variables

Query Logging

​Database Connection Options

​DB_ADAPTER

​DB_URL

​DB_MAX_POOL_SIZE

​DB_DATABASE

​DB_LOG_QUERIES

​Setting Up Environment Variables

​Query Logging

Database Connection Options

`DB_ADAPTER`

`DB_URL`

`DB_MAX_POOL_SIZE`

`DB_DATABASE`

`DB_LOG_QUERIES`

Setting Up Environment Variables

Query Logging