Skip to main content

Queries environment variables

Reference documentation for query-related environment variables.

Queries environment variables available for use with Self-hosted Retool deployments.

Only configure environment variables when needed. You can configure many environment variables from your organization's Settings rather than directly editing your deployment's configuration file.

You must restart your instance after setting any variables for them to take effect.

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

CLIENT_MAX_BODY_SIZE

On the https-portal container, specify the maximum request body size, in bytes, megabytes (M), or kilobytes (K). Any upload that exceeds this limit results in a 413 HTTP error. Set to 0 to allow bodies of any size.

Type string
Format Plain Text
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Examples
40M
8096K
1048576

DBCONNECTOR_NUM_WORKERS

The number of worker threads for the db-connector container. The default value is Math.min(Math.max(1, numCPUs), 3), where numCPUs is the number of logical CPU cores on the machine determined by Node.js.

Type number
Format Integer
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Examples
4

DBCONNECTOR_POSTGRES_POOL_MAX_SIZE

The PostgreSQL connection pool maximum size.

Type number
Format Integer
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Examples
20

DBCONNECTOR_QUERY_TIMEOUT_MS

The duration, in milliseconds, for queries to run before timing out. If your Retool deployment is behind a load balancer, increase the load balancer's timeout by a proportionate amount.

Type number
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Unitsms
Examples
120000

ENABLE_CUSTOM_PLATFORM_LEVEL_AUTH_STEPS

Whether to allow configuration of custom authentication steps for users to perform whenever they log into Retool.

Type boolean
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Examples
true

KEEPALIVE_TIMEOUT

The keep alive timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.

Type number
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Examples
1000

PROXY_CONNECT_TIMEOUT

The proxy connect timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.

Type number
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Examples
1000

PROXY_READ_TIMEOUT

The proxy read timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.

Type number
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Examples
1000

PROXY_SEND_TIMEOUT

The proxy send timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.

Type number
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Examples
1000

RETOOL_CLIENT_MAX_BODY_SIZE

The maximum body size, in megabytes, for Retool client requests. Any upload that exceeds this limit results in a 413 HTTP error. Set to 0 to allow bodies of any size.

Type string
Format Plain Text
Mutability
ControlUsage
ConfigurationUpdate the deployment's configuration file.
Default
100mb
Examples
20mb