Database

Database settings

Database host

Database host address.

ID	db.host
Type	String
Default value	(no default)
Environment variables	BOX_DB_HOST , 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 variables	BOX_DB_PORT , 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 variables	BOX_DB_DATABASE , 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 variables	BOX_DB_USER , 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 variables	BOX_DB_PASSWORD , 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 variables	BOX_DB_INSTALL_PG_EXTENSIONS , 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 variables	BOX_DB_EXTENSION_SCHEMA , AIDBOX_EXTENSION_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

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 variables	BOX_DB_POOL_CONNECTION_TIMEOUT , 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 variables	BOX_DB_POOL_CONNECTION_INIT_SQL , 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 variables	BOX_DB_POOL_IDLE_TIMEOUT , 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 variables	BOX_DB_POOL_MINIMUM_IDLE , 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 variables	BOX_DB_POOL_MAXIMUM_POOL_SIZE , 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