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.
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 |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CLIENT_MAX_BODY_SIZE=40M
CLIENT_MAX_BODY_SIZE=8096K
CLIENT_MAX_BODY_SIZE=1048576
DBCONNECTOR_EXTENDED_QUERY_TIMEOUT_ENABLED_RESOURCES
A list of resource types that use the extended query timeout period defined with `DBCONNECTOR_EXTENDED_QUERY_TIMEOUT_MS
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
DBCONNECTOR_EXTENDED_QUERY_TIMEOUT_ENABLED_RESOURCES=postgresql,mysql
DBCONNECTOR_EXTENDED_QUERY_TIMEOUT_MS
The extended timeout period for queries of specific resource types, in milliseconds.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 600000 |
Examples
DBCONNECTOR_EXTENDED_QUERY_TIMEOUT_MS=10000
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 |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 0 |
Examples
DBCONNECTOR_NUM_WORKERS=4
DBCONNECTOR_POSTGRES_POOL_MAX_SIZE
The PostgreSQL connection pool maximum size.
| Type | number |
| Format | Integer |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 10 |
Examples
DBCONNECTOR_POSTGRES_POOL_MAX_SIZE=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 |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 120000 |
| Units | ms |
Examples
DBCONNECTOR_QUERY_TIMEOUT_MS=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 |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | false |
Examples
ENABLE_CUSTOM_PLATFORM_LEVEL_AUTH_STEPS=true
HIDE_ALL_HEADERS_IN_AUDIT_LOG_EVENTS
Whether to prevent all query headers and cookies from being added to audit log entries.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | false |
Examples
HIDE_ALL_HEADERS_IN_AUDIT_LOG_EVENTS=true
KEEPALIVE_TIMEOUT
The keep alive timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 0 |
Examples
KEEPALIVE_TIMEOUT=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 |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 0 |
Examples
PROXY_CONNECT_TIMEOUT=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 |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 0 |
Examples
PROXY_READ_TIMEOUT=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 |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 0 |
Examples
PROXY_SEND_TIMEOUT=1000
RETOOL_CLIENT_MAX_BODY_SIZE
The maximum body size, in megabytes, for Retool client requests. Any uploads that exceed this limit, or if this limit is set to 0, result in a 413 HTTP error.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 100mb |
Examples
RETOOL_CLIENT_MAX_BODY_SIZE=20mb