Database
Database settings
Primary
Primary database settings
Database host
Database host address.
| ID | db.host |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_HOST |
| Deprecated environment variables | PGHOST |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Environment variables |
| Hot reload | false — setting requires system restart |
Database port
Database port.
| ID | db.port |
| Type | Int |
| Default value | 5432 |
| Environment variable | BOX_DB_PORT |
| Deprecated environment variables | PGPORT |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Environment variables |
| Hot reload | false — setting requires system restart |
Database name
The database name. postgres name is not allowed.
| ID | db.database |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_DATABASE |
| Deprecated environment variables | PGDATABASE |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Environment variables |
| Hot reload | false — setting requires system restart |
Database user
The database username.
| ID | db.user |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_USER |
| Deprecated environment variables | PGUSER |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Environment variables |
| Hot reload | false — setting requires system restart |
Database password
A password of database role name.
| ID | db.password |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_PASSWORD |
| Deprecated environment variables | PGPASSWORD |
| Sensitive | true — value will be masked in Admin UI |
| Set via | Environment variables |
| Hot reload | false — setting requires system restart |
Install PostgreSQL extensions at startup
Automatically installs PostgreSQL extensions (pgcrypto, unaccent, pg_trgm, fuzzystrmatch) during server startup.
| ID | db.install-pg-extensions |
| Type | Bool |
| Default value | true |
| Environment variable | BOX_DB_INSTALL_PG_EXTENSIONS |
| Deprecated environment variables | AIDBOX_INSTALL_PG_EXTENSIONS |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Environment variables |
| Hot reload | false — setting requires system restart |
Database extension schema
Schema for PostgreSQL extensions. Default is current schema.
| ID | db.extension-schema |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_EXTENSION_SCHEMA |
| Deprecated environment variables | AIDBOX_EXTENSION_SCHEMA , AIDBOX_DB_PARAM_CURRENT_SCHEMA |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
ViewDefinition materialization schema
Schema for storing ViewDefinition materialization. Changing this setting does not affect already materialized views; it applies only to new ones. It is recommended to use a dedicated schema for ViewDefinition to avoid potential collisions.
| ID | db.view-definition-schema |
| Type | String |
| Default value | sof |
| Environment variable | BOX_VIEW_DEFINITION_SCHEMA |
| Available from | 2508 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | true — setting can be changed at runtime |
Pool connection timeout
Maximum wait time (in milliseconds) for a database connection from the pool before timing out.
| ID | db.pool.connection-timeout |
| Type | Int |
| Default value | 30000 |
| Environment variable | BOX_DB_POOL_CONNECTION_TIMEOUT |
| Deprecated environment variables | BOX_DB_POOL_CONNECTION__TIMEOUT |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Pool connection init SQL
Specifies a SQL statement that will be executed after every new connection creation before adding it to the pool.
| ID | db.pool.connection-init-sql |
| Type | String |
| Default value | select 1 |
| Environment variable | BOX_DB_POOL_CONNECTION_INIT_SQL |
| Deprecated environment variables | BOX_DB_POOL_CONNECTION__INIT__SQL |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Pool idle timeout
Maximum timeout (in milliseconds) to close idle connection.
| ID | db.pool.idle-timeout |
| Type | Int |
| Default value | 10000 |
| Environment variable | BOX_DB_POOL_IDLE_TIMEOUT |
| Deprecated environment variables | BOX_DB_POOL_IDLE__TIMEOUT |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Pool minimum idle
Minimum number of connections.
| ID | db.pool.minimum-idle |
| Type | Int |
| Default value | 0 |
| Environment variable | BOX_DB_POOL_MINIMUM_IDLE |
| Deprecated environment variables | BOX_DB_POOL_MINIMUM__IDLE |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Pool size
Maximum number of simultaneous database connections.
| ID | db.pool.maximum-pool-size |
| Type | Int |
| Default value | 8 |
| Environment variable | BOX_DB_POOL_MAXIMUM_POOL_SIZE |
| Deprecated environment variables | BOX_DB_POOL_MAXIMUM__POOL__SIZE |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Read-only replica
Read-only database replica settings
Read-only replica enable
Enable options to process requests to read-only db replica. If enabled you should define: db.ro-replica.database, db.ro-replica.host, db.ro-replica.port, db.ro-replica.user, and db.ro-replica.password.
| ID | db.ro-replica.enabled |
| Type | Bool |
| Default value | false |
| Environment variable | BOX_DB_RO_REPLICA_ENABLED |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Database name
The database name. postgres name is not allowed.
| ID | db.ro-replica.database |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_RO_REPLICA_DATABASE |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Database host
AidboxDB host address.
| ID | db.ro-replica.host |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_RO_REPLICA_HOST |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Database port
The database port number.
| ID | db.ro-replica.port |
| Type | Int |
| Default value | (no default) |
| Environment variable | BOX_DB_RO_REPLICA_PORT |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Database user
The database username.
| ID | db.ro-replica.user |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_RO_REPLICA_USER |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Database password
The database password.
| ID | db.ro-replica.password |
| Type | String |
| Default value | (no default) |
| Environment variable | BOX_DB_RO_REPLICA_PASSWORD |
| Available from | 2507 |
| Sensitive | true — value will be masked in Admin UI |
| Set via | Environment variables |
| Hot reload | false — setting requires system restart |
Database extension schema
The database extension schema.
| ID | db.ro-replica.extension-schema |
| Type | String |
| Default value | (no default) |
| Environment variable | AIDBOX_EXTENSION_SCHEMA |
| Deprecated environment variables | AIDBOX_DB_PARAM_CURRENT_SCHEMA |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Maximum wait time
Maximum wait time (in milliseconds) for a database connection from the pool before timing out.
| ID | db.ro-replica.pool.connection-timeout |
| Type | Int |
| Default value | 30000 |
| Environment variable | BOX_DB_RO_REPLICA_POOL_CONNECTION_TIMEOUT |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Pool idle timeout
Maximum timeout (in milliseconds) to close idle connection.
| ID | db.ro-replica.pool.idle-timeout |
| Type | Int |
| Default value | 10000 |
| Environment variable | BOX_DB_RO_REPLICA_POOL_IDLE_TIMEOUT |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Pool minimum idle
Minimum number of connections.
| ID | db.ro-replica.pool.minimum-idle |
| Type | Int |
| Default value | 0 |
| Environment variable | BOX_DB_RO_REPLICA_POOL_MINIMUM_IDLE |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Pool size
Maximum number of simultaneous database connections.
| ID | db.ro-replica.pool.maximum-pool-size |
| Type | Int |
| Default value | 8 |
| Environment variable | BOX_DB_RO_REPLICA_POOL_MAXIMUM_POOL_SIZE |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Pool connection init SQL
The pool connection initialization SQL statement.
| ID | db.ro-replica.pool.connection-init-sql |
| Type | String |
| Default value | select 1 |
| Environment variable | BOX_DB_RO_REPLICA_POOL_CONNECTION_INIT_SQL |
| Available from | 2507 |
| Sensitive | false — value will be visible in plaintext in Admin UI |
| Set via | Admin UI → Settings Environment variables |
| Hot reload | false — setting requires system restart |
Last updated 2025-08-20T07:06:47Z