Alpha

These pages are built from turborel-js’s main, turborel 0.0.0. Anything may change from one build to the next: SQL, API, protocol and files alike.

Appendix C: Settings

Every connection setting: its name, the same in a program's Options, a URI's query and a service file; its environment variable, if it has one; what it says; and its default. Then a pool's settings.

Setting Variable What it says Default
host TURBOREL_HOST The servers, comma-separated; each may carry its port as name:port, an IPv6 address as [address]:port, and a path names a Unix socket (on Windows, a named pipe) localhost
port TURBOREL_PORT The port of each host that carries none: one for all, or one each 7422
user TURBOREL_USER The user to connect as none: it must be given
password TURBOREL_PASSWORD The user's password the password file's
tls_mode TURBOREL_TLS_MODE disable, prefer, require, verify-ca or verify-full prefer
channel_binding disable, prefer or require prefer
application_name TURBOREL_APPLICATION_NAME The program's name, sent as the connection attribute application none
connect_timeout TURBOREL_CONNECT_TIMEOUT Whole seconds each step of connecting waits; 0 for no limit 30
service TURBOREL_SERVICE The section of the service file to read none
service_file TURBOREL_SERVICE_FILE The service file ~/.turborel_service.conf
passfile TURBOREL_PASSFILE The password file ~/.turborel_pass
target any, read-write or read-only any
load_balance disable, the hosts tried in order, or random disable
tls_roots A PEM file of the certificate authorities trusted none
tls_system_roots true to trust the platform's authorities too false
tls_certificate A PEM file of the client's certificate chain, to present none
tls_key A PEM file of its private key none
server_name The name the server's certificate is checked against the host's

The layers, each setting taken from the first that has it: the program's options or URI; the service file's section; the environment; the defaults. A variable set but empty gives nothing. The home directory is Node.js's os.homedir().

A pool's settings

A PoolConfig's fields, each in milliseconds where it is a time.

Setting What it says Default
max The most connections made at once 10
maxIdle The most kept idle 10
idleTimeout How long one may stay idle; undefined for as long as it lives 600,000, ten minutes
maxLifetime How long one lives from when it was made; undefined for no limit 3,600,000, an hour
wait How long get waits for one to come back 30,000, 30 seconds
check Whether an idle connection is checked to answer before it is handed out true
reset Statements run as each comes back, after the pool's own none