-= pgbouncer(5) =
-== NAME ==
+pgbouncer.ini
+#############
-pgbouncer - Lightweight connection pooler for PostgreSQL.
+Description
+===========
-== SYNOPSIS ==
+Config file is in "ini" format. Section names are between "[" and "]". Lines
+starting with ";" or "#" are taken as comments and ignored. The characters ";"
+and "#" are not recognized when they appear later in the line.
- [databases]
- db = ...
-
- [pgbouncer]
- ...
-
-== DESCRIPTION ==
-Config file is in "ini" format. Section names are between " and
-". Lines starting with ";" or "#" are taken as comments and
-ignored. The characters ";" and "#" are not recognized when they
-appear later in the line.
+Generic settings
+================
-== SECTION [pgbouncer] ==
+logfile
+-------
-=== Generic settings ===
-
-==== logfile ====
-
-Specifies log file. Log file is kept open so after rotation
-`kill -HUP` or on console `RELOAD;` should be done.
+Specifies log file. Log file is kept open so after rotation ``kill -HUP``
+or on console ``RELOAD;`` should be done.
Note: On Windows machines, the service must be stopped and started.
Default: not set.
-==== pidfile ====
+pidfile
+-------
Specifies the pid file. Without a pidfile, daemonization is not allowed.
Default: not set.
-==== listen_addr ====
+listen_addr
+-----------
Specifies list of addresses, where to listen for TCP connections.
-You may also use `*` meaning "listen on all addresses". When not set,
+You may also use ``*`` meaning "listen on all addresses". When not set,
only Unix socket connections are allowed.
Addresses can be specified numerically (IPv4/IPv6) or by name.
Default: not set
-==== listen_port ====
+listen_port
+-----------
Which port to listen on. Applies to both TCP and Unix sockets.
Default: 6432
-==== unix_socket_dir ====
+unix_socket_dir
+---------------
Specifies location for Unix sockets. Applies to both listening socket and
server connections. If set to an empty string, Unix sockets are disabled.
Required for online reboot (-R) to work.
Note: Not supported on Windows machines.
-Default: +/tmp+
+Default: /tmp
-==== unix_socket_mode ====
+unix_socket_mode
+----------------
Filesystem mode for unix socket.
Default: 0777
-==== unix_socket_group ====
+unix_socket_group
+-----------------
Group name to use for unix socket.
Default: not set
-==== user ====
+user
+----
If set, specifies the Unix user to change to after startup. Works only if
-PgBouncer is started as root or if `user` is the same as the current user.
+PgBouncer is started as root or if it's already running as given user.
+
Note: Not supported on Windows machines.
Default: not set
-==== auth_file ====
+auth_file
+---------
The name of the file to load user names and passwords from. The file format
is the same as the PostgreSQL 8.x pg_auth/pg_pwd file, so this setting can be
pointed directly to one of those backend files. Since version 9.0, PostgreSQL
-does not use such text file, so it must be generated manually. See section
-"AUTHENTICATION FILE FORMAT" below about details.
+does not use such text file, so it must be generated manually. See
+section `Authentication file format`_ below about details.
Default: not set.
-==== auth_hba_file ====
+auth_hba_file
+-------------
-HBA configuration file to use when `auth_type=hba`.
+HBA configuration file to use when `auth_type`_ is ``hba``.
Default: not set
-==== auth_type ====
+auth_type
+---------
How to authenticate users.
-hba::
- Actual auth type is loaded from `auth_hba_file`. This allows different
+``hba``
+ Actual auth type is loaded from `auth_hba_file`_. This allows different
authentication methods different access paths. Example: connection
- over unix socket use `peer` auth method, connection over TCP
+ over unix socket use ``peer`` auth method, connection over TCP
must use TLS.
-cert::
+``cert``
Client must connect over TLS connection with valid client cert.
Username is then taken from CommonName field from certificate.
-md5::
- Use MD5-based password check. `auth_file` may contain both MD5-encrypted
+``md5``
+ Use MD5-based password check. `auth_file`_ may contain both MD5-encrypted
or plain-text passwords. This is the default authentication method.
-crypt::
- Use crypt(3) based password check. `auth_file` must contain plain-text
+``crypt``
+ Use crypt(3) based password check. `auth_file`_ must contain plain-text
passwords. Deprecated, removed in PostgreSQL 8.4.
-plain::
+``plain``
Clear-text password is sent over wire. Deprecated.
-trust::
- No authentication is done. Username must still exist in `auth_file`.
+``trust``
+ No authentication is done. Username must still exist in `auth_file`_.
-any::
- Like the `trust` method, but the username given is ignored. Requires that all
+``any``
+ Like the ``trust`` method, but the username given is ignored. Requires that all
databases are configured to log in as specific user. Additionally, the console
database allows any user to log in as admin.
-==== auth_query ====
+auth_query
+----------
Query to load user's password from db.
-Default: SELECT usename, passwd FROM pg_shadow WHERE usename=$1
+Default: ``SELECT usename, passwd FROM pg_shadow WHERE usename=$1``
-==== pool_mode ====
+pool_mode
+---------
Specifies when a server connection can be reused by other clients.
-session::
+``session``
Server is released back to pool after client disconnects. Default.
-transaction::
+``transaction``
Server is released back to pool after transaction finishes.
-statement::
+``statement``
Server is released back to pool after query finishes. Long transactions
spanning multiple statements are disallowed in this mode.
-==== max_client_conn ====
+max_client_conn
+---------------
Maximum number of client connections allowed. When increased then the file
descriptor limits should also be increased. Note that actual number of file
-descriptors used is more than max_client_conn. Theoretical maximum used is:
+descriptors used is more than max_client_conn. Theoretical maximum used is::
max_client_conn + (max_pool_size * total_databases * total_users)
if each user connects under its own username to server. If a database user
is specified in connect string (all users connect under same username),
-the theoretical maximum is:
+the theoretical maximum is::
max_client_conn + (max_pool_size * total_databases)
crafts special load for it. Still, it means you should set the number of
file descriptors to a safely high number.
-Search for `ulimit` in your favourite shell man page.
-Note: `ulimit` does not apply in a Windows environment.
+Search for ``ulimit`` in your favourite shell man page.
+Note: ``ulimit`` does not apply in a Windows environment.
Default: 100
-==== default_pool_size ====
+default_pool_size
+-----------------
How many server connections to allow per user/database pair. Can be overridden in
the per-database configuration.
Default: 20
-==== min_pool_size ====
+min_pool_size
+-------------
Add more server connections to pool if below this number.
Improves behaviour when usual load comes suddenly back after period
of total inactivity.
-
Default: 0 (disabled)
-==== reserve_pool_size ====
+reserve_pool_size
+-----------------
How many additional connections to allow to a pool. 0 disables.
Default: 0 (disabled)
-==== reserve_pool_timeout ====
+reserve_pool_timeout
+--------------------
If a client has not been serviced in this many seconds, pgbouncer enables
use of additional connections from reserve pool. 0 disables.
Default: 5.0
-==== max_db_connections ====
+max_db_connections
+------------------
Do not allow more than this many connections per-database (regardless of pool - i.e.
user). It should be noted that when you hit the limit, closing a client connection
Default: unlimited
-==== max_user_connections ====
+max_user_connections
+--------------------
Do not allow more than this many connections per-user (regardless of pool - i.e.
user). It should be noted that when you hit the limit, closing a client connection
Once the server connection closes (due to idle timeout), a new server connection
will immediately be opened for the waiting pool.
-==== server_round_robin ====
+server_round_robin
+------------------
By default, pgbouncer reuses server connections in LIFO (last-in, first-out) manner,
so that few connections get the most load. This gives best performance if you have
Default: 0
-==== ignore_startup_parameters ====
+ignore_startup_parameters
+-------------------------
By default, PgBouncer allows only parameters it can keep track of in startup
-packets - `client_encoding`, `datestyle`, `timezone` and `standard_conforming_strings`.
+packets - ``client_encoding``, ``datestyle``, ``timezone`` and ``standard_conforming_strings``.
All others parameters will raise an error. To allow others parameters, they can be
specified here, so that pgbouncer knows that they are handled by admin and it can ignore them.
Default: empty
-==== disable_pqexec ====
+disable_pqexec
+--------------
Disable Simple Query protocol (PQexec). Unlike Extended Query protocol, Simple Query
allows multiple queries in one packet, which allows some classes of SQL-injection
Default: 0
-==== application_name_add_host ====
+application_name_add_host
+-------------------------
Add the client host address and port to the application name setting set on connection start.
This helps in identifying the source of bad queries etc. This logic applies
Default: 0
-==== conffile ====
+conffile
+--------
Show location of current config file. Changing it will make PgBouncer use another
-config file for next `RELOAD` / `SIGHUP`.
+config file for next ``RELOAD`` / ``SIGHUP``.
Default: file from command line.
-==== service_name ====
+service_name
+------------
Used on win32 service registration.
Default: pgbouncer
-==== job_name ====
+job_name
+--------
+
+Alias for `service_name`_.
-Alias for `service_name`.
-=== Log settings ===
+Log settings
+============
-==== syslog ====
+syslog
+------
Toggles syslog on/off
As for windows environment, eventlog is used instead.
Default: 0
-==== syslog_ident ====
+syslog_ident
+------------
Under what name to send logs to syslog.
Default: pgbouncer (program name)
-==== syslog_facility ====
+syslog_facility
+---------------
Under what facility to send logs to syslog.
-Possibilities: auth, authpriv, daemon, user, local0-7
+Possibilities: ``auth``, ``authpriv``, ``daemon``, ``user``, ``local0-7``.
Default: daemon
-==== log_connections ====
+log_connections
+---------------
Log successful logins.
Default: 1
-==== log_disconnections ====
+log_disconnections
+------------------
Log disconnections with reasons.
Default: 1
-==== log_pooler_errors ====
+log_pooler_errors
+-----------------
Log error messages pooler sends to clients.
Default: 1
-==== stats_period ====
+stats_period
+------------
Period for writing aggregated stats into log.
Default: 60
-==== verbose ====
+verbose
+-------
Increase verbosity. Mirrors "-v" switch on command line.
Using "-v -v" on command line is same as `verbose=2` in config.
Default: 0
-=== Console access control ===
-==== admin_users ====
+Console access control
+======================
+
+admin_users
+-----------
Comma-separated list of database users that are allowed to connect and
-run all commands on console. Ignored when `auth_mode=any`, in which case
-any username is allowed in as admin.
+run all commands on console. Ignored when `auth_type`_ is ``any``,
+in which case any username is allowed in as admin.
Default: empty
-==== stats_users ====
+stats_users
+-----------
Comma-separated list of database users that are allowed to connect and
run read-only queries on console. Thats means all SHOW commands except
Default: empty.
-=== Connection sanity checks, timeouts ===
-==== server_reset_query ====
+Connection sanity checks, timeouts
+==================================
+
+server_reset_query
+------------------
Query sent to server on connection release, before making it
available to other clients. At that moment no transaction is in
-progress so it should not include `ABORT` or `ROLLBACK`.
+progress so it should not include ``ABORT`` or ``ROLLBACK``.
-A good choice for Postgres 8.2 and below is:
+A good choice for Postgres 8.2 and below is::
server_reset_query = RESET ALL; SET SESSION AUTHORIZATION DEFAULT;
-for 8.3 and above its enough to do:
+for 8.3 and above its enough to do::
server_reset_query = DISCARD ALL;
-When transaction pooling is used, the `server_reset_query` should be empty,
+When transaction pooling is used, the `server_reset_query`_ should be empty,
as clients should not use any session features. If client does use session
features, then they will be broken as transaction pooling will not guarantee
that next query will be run on same connection.
Default: DISCARD ALL
-==== server_check_delay ====
+server_check_delay
+------------------
How long to keep released connections available for immediate re-use, without running
sanity-check queries on it. If 0 then the query is ran always.
Default: 30.0
-==== server_check_query ====
+server_check_query
+------------------
Simple do-nothing query to check if the server connection is alive.
Default: SELECT 1;
-==== server_lifetime ====
+server_lifetime
+---------------
The pooler will try to close server connections that have been connected longer
than this. Setting it to 0 means the connection is to be used only once,
Default: 3600.0
-==== server_idle_timeout ====
+server_idle_timeout
+-------------------
If a server connection has been idle more than this many seconds it will be dropped.
If 0 then timeout is disabled. [seconds]
Default: 600.0
-==== server_connect_timeout ====
+server_connect_timeout
+----------------------
If connection and login won't finish in this amount of time, the connection
will be closed. [seconds]
Default: 15.0
-==== server_login_retry ====
+server_login_retry
+------------------
If login failed, because of failure from connect() or authentication that
pooler waits this much before retrying to connect. [seconds]
Default: 15.0
-==== client_login_timeout ====
+client_login_timeout
+--------------------
If a client connects but does not manage to login in this amount of time, it
will be disconnected. Mainly needed to avoid dead connections stalling
Default: 60.0
-==== autodb_idle_timeout ====
+autodb_idle_timeout
+-------------------
If the automatically created (via "*") database pools have
been unused this many seconds, they are freed. The negative
Default: 3600.0
-==== dns_max_ttl ====
+dns_max_ttl
+-----------
How long the DNS lookups can be cached. If a DNS lookup returns
several answers, pgbouncer will robin-between them in the meantime.
Default: 15.0
-==== dns_nxdomain_ttl ====
+dns_nxdomain_ttl
+----------------
How long error and NXDOMAIN DNS lookups can be cached. [seconds]
Default: 15.0
-==== dns_zone_check_period ====
+dns_zone_check_period
+---------------------
Period to check if zone serial has changed.
are looked up again. If any host ip changes, it's connections
are invalidated.
-Works only with UDNS backend (`--with-udns` to configure).
+Works only with UDNS backend (``--with-udns`` to configure).
Default: 0.0 (disabled)
-=== TLS settings ===
-==== client_tls_sslmode ====
+TLS settings
+============
+
+client_tls_sslmode
+------------------
TLS mode to use for connections from clients. TLS connections
-are disabled by default. When enabled, `client_tls_key_file`
-and `client_tls_cert_file` must be also configures to set up
+are disabled by default. When enabled, `client_tls_key_file`_
+and `client_tls_cert_file`_ must be also configured to set up
key and cert PgBouncer uses to accept client connections.
-`disabled`::
- Plain TCP. If client requests TLS, it's ignored.
+``disabled``
+ Plain TCP. If client requests TLS, it's ignored. Default.
-`allow`::
+``allow``
If client requests TLS, it is used. If not, plain TCP is used.
If client uses client-certificate, it is not validated.
-`prefer`::
- Same as `allow`.
+``prefer``
+ Same as ``allow``.
-`require`::
+``require``
Client must use TLS. If not, client connection is rejected.
If client uses client-certificate, it is not validated.
-`verify-ca`::
+``verify-ca``
Client must use TLS with valid client certificate.
-`verify-full`::
- Same as `verify-ca`.
-
-Default: `disabled`
+``verify-full``
+ Same as ``verify-ca``.
-==== client_tls_key_file ====
+client_tls_key_file
+-------------------
Private key for PgBouncer to accept client connections.
Default: not set.
-==== client_tls_cert_file ====
+client_tls_cert_file
+--------------------
Certificate for private key. Clients can validate it.
Default: not set.
-==== client_tls_ca_file ====
+client_tls_ca_file
+------------------
Root certificate file to validate client certificates.
Default: unset.
-==== client_tls_protocols ====
+client_tls_protocols
+--------------------
-Which TLS protocol versions are allowed. Allowed values: `tlsv1.0`, `tlsv1.1`, `tlsv1.2`.
-Shortcuts: `all` (tlsv1.0,tlsv1.1,tlsv1.2), `secure` (tlsv1.2), `legacy` (all).
+Which TLS protocol versions are allowed. Allowed values: ``tlsv1.0``, ``tlsv1.1``, ``tlsv1.2``.
+Shortcuts: ``all`` (tlsv1.0,tlsv1.1,tlsv1.2), ``secure`` (tlsv1.2), ``legacy`` (all).
-Default: `all`
+Default: ``all``
-==== client_tls_ciphers ====
+client_tls_ciphers
+------------------
-Default: `fast`
+Default: ``fast``
-==== client_tls_ecdhcurve ====
+client_tls_ecdhcurve
+--------------------
Elliptic Curve name to use for ECDH key exchanges.
-Allowed values: `none` (DH is disabled), `auto` (256-bit ECDH), curve name.
+Allowed values: ``none`` (DH is disabled), ``auto`` (256-bit ECDH), curve name.
-Default: `auto`
+Default: ``auto``
-==== client_tls_dheparams ====
+client_tls_dheparams
+--------------------
DHE key exchange type.
-Allowed values: `none` (DH is disabled), `auto` (2048-bit DH), `legacy` (1024-bit DH).
+Allowed values: ``none`` (DH is disabled), ``auto`` (2048-bit DH), ``legacy`` (1024-bit DH).
-Default: `auto`
+Default: ``auto``
-==== server_tls_sslmode ====
+server_tls_sslmode
+------------------
TLS mode to use for connections to PostgreSQL servers.
TLS connections are disabled by default.
-`disabled`::
- Plain TCP. TCP is not event requested from server.
+``disabled``
+ Plain TCP. TCP is not event requested from server. Default.
-`allow`::
+``allow``
FIXME: if server rejects plain, try TLS?
-`prefer`::
+``prefer``
TLS connection is always requested first from PostgreSQL,
when refused connection will be establised over plain TCP.
Server certificate is not validated.
-`require`::
+``require``
Connection must go over TLS. If server rejects it,
plain TCP is not attempted. Server certificate is not validated.
-`verify-ca`::
+``verify-ca``
Connection must go over TLS and server certificate must be valid
- according to `server_tls_ca_file`. Server hostname is not checked
+ according to `server_tls_ca_file`_. Server hostname is not checked
against certificate.
-`verify-full`::
+``verify-full``
Connection must go over TLS and server certificate must be valid
- according to `server_tls_ca_file`. Server hostname must match
+ according to `server_tls_ca_file`_. Server hostname must match
certificate info.
-Default: `disabled`
-
-==== server_tls_ca_file ====
+server_tls_ca_file
+------------------
Root certificate file to validate PostgreSQL server certificates.
Default: unset.
-==== server_tls_key_file ====
+server_tls_key_file
+-------------------
Private key for PgBouncer to authenticate against PostgreSQL server.
Default: not set.
-==== server_tls_cert_file ====
+server_tls_cert_file
+--------------------
Certificate for private key. PostgreSQL server can validate it.
Default: not set.
-==== server_tls_protocols ====
+server_tls_protocols
+--------------------
-Which TLS protocol versions are allowed. Allowed values: `tlsv1.0`, `tlsv1.1`, `tlsv1.2`.
-Shortcuts: `all` (tlsv1.0,tlsv1.1,tlsv1.2), `secure` (tlsv1.2), `legacy` (all).
+Which TLS protocol versions are allowed. Allowed values: ``tlsv1.0``, ``tlsv1.1``, ``tlsv1.2``.
+Shortcuts: ``all`` (tlsv1.0,tlsv1.1,tlsv1.2), ``secure`` (tlsv1.2), ``legacy`` (all).
-Default: `all`
+Default: ``all``
-==== server_tls_ciphers ====
+server_tls_ciphers
+------------------
-Default: `fast`
+Default: ``fast``
-=== Dangerous timeouts ===
+
+Dangerous timeouts
+==================
Setting following timeouts cause unexpected errors.
-==== query_timeout ====
+query_timeout
+-------------
Queries running longer than that are canceled. This should be used only with
slightly smaller server-side statement_timeout, to apply only for network
Default: 0.0 (disabled)
-==== query_wait_timeout ====
+query_wait_timeout
+------------------
Maximum time queries are allowed to spend waiting for execution. If the query
is not assigned to a server during that time, the client is disconnected. This
Default: 0.0 (disabled)
-==== client_idle_timeout ====
+client_idle_timeout
+-------------------
Client connections idling longer than this many seconds are closed. This should
be larger than the client-side connection lifetime settings, and only used
Default: 0.0 (disabled)
-==== idle_transaction_timeout ====
+idle_transaction_timeout
+------------------------
If client has been in "idle in transaction" state longer,
it will be disconnected. [seconds]
Default: 0.0 (disabled)
-=== Low-level network settings ===
-==== pkt_buf ====
+Low-level network settings
+==========================
+
+pkt_buf
+-------
Internal buffer size for packets. Affects size of TCP packets sent and general
memory usage. Actual libpq packets can be larger than this so, no need to set it
Default: 2048
-==== max_packet_size ====
+max_packet_size
+---------------
Maximum size for Postgres packets that PgBouncer allows through. One packet
is either one query or one resultset row. Full resultset can be larger.
Default: 2147483647
-==== listen_backlog ====
+listen_backlog
+--------------
Backlog argument for listen(2). Determines how many new unanswered connection
attempts are kept in queue. When queue is full, further new connections are dropped.
Default: 128
-==== sbuf_loopcnt ====
+sbuf_loopcnt
+------------
How many times to process data on one connection, before proceeding.
Without this limit, one connection with a big resultset can stall
-PgBouncer for a long time. One loop processes one `pkt_buf` amount of data.
+PgBouncer for a long time. One loop processes one `pkt_buf`_ amount of data.
0 means no limit.
Default: 5
-==== suspend_timeout ====
+suspend_timeout
+---------------
How many seconds to wait for buffer flush during SUSPEND or reboot (-R).
Connection is dropped if flush does not succeed.
Default: 10
-==== tcp_defer_accept ====
+tcp_defer_accept
+----------------
-For details on this and other tcp options, please see `man 7 tcp`.
+For details on this and other tcp options, please see ``man 7 tcp``.
Default: 45 on Linux, otherwise 0
-==== tcp_socket_buffer ====
+tcp_socket_buffer
+-----------------
Default: not set
-==== tcp_keepalive ====
+tcp_keepalive
+--------------
Turns on basic keepalive with OS defaults.
-On Linux, the system defaults are tcp_keepidle=7200, tcp_keepintvl=75,
-tcp_keepcnt=9. They are probably similar on other OS-es.
+On Linux, the system defaults are **tcp_keepidle=7200**, **tcp_keepintvl=75**,
+**tcp_keepcnt=9**. They are probably similar on other OS-es.
Default: 1
-==== tcp_keepcnt ====
+tcp_keepcnt
+-----------
Default: not set
-==== tcp_keepidle ====
+tcp_keepidle
+------------
Default: not set
-==== tcp_keepintvl ====
+tcp_keepintvl
+-------------
Default: not set
-== SECTION [databases] ==
+
+Section [databases]
+===================
This contains key=value pairs where key will be taken as a database name and
value as a libpq connect-string style list of key=value pairs. As actual libpq is not
used, so not all features from libpq can be used (service=, .pgpass).
-Database name can contain characters [0-9A-Za-z_.-] without quoting.
+Database name can contain characters ``_0-9A-Za-z`` without quoting.
Names that contain other chars need to be quoted with standard SQL
ident quoting: double quotes where "" is taken as single quote.
"*" acts as fallback database: if the exact name does not exist,
its value is taken as connect string for requested database.
Such automatically created database entries are cleaned up
-if they stay idle longer then the time specified in
-`autodb_idle_timeout` parameter.
-
-=== Location parameters ===
+if they stay idle longer then the time specified in `autodb_idle_timeout`_
+parameter.
-==== dbname ====
+dbname
+------
Destination database name.
Default: same as client-side database name.
-==== host ====
+host
+----
Hostname or IP address to connect to. Hostnames are resolved
on connect time, the result is cached per +dns_max_ttl+ parameter.
Default: not set, meaning to use a Unix socket.
-==== port ====
+port
+----
Default: 5432
-==== user, password ====
+user, password
+--------------
If +user=+ is set, all connections to the destination database will be
done with the specified user, meaning that there will be only one pool
Otherwise PgBouncer tries to log into the destination database with client
username, meaning that there will be one pool per user.
-==== auth_user ====
+auth_user
+---------
If +auth_user+ is set, any user not specified in auth_file will be
queried from pg_shadow in the database using auth_user. Auth_user's
password will be taken from auth_file.
-=== Pool configuration ===
-
-==== pool_size ====
+pool_size
+---------
Set maximum size of pools for this database. If not set,
the default_pool_size is used.
-==== connect_query ====
+connect_query
+-------------
Query to be executed after a connection is established, but before
allowing the connection to be used by any clients. If the query raises errors,
they are logged but ignored otherwise.
-==== pool_mode ====
+pool_mode
+---------
Set the pool mode specific to this database. If not set,
the default pool_mode is used.
-==== max_db_connections ====
+max_db_connections
+------------------
Configure a database-wide maximum (i.e. all pools within the database will
not have more than this many server connections).
-=== Extra parameters ===
-
-They allow setting default parameters on server connection.
-
-Note that since version 1.1 PgBouncer tracks client
-changes for their values, so their use in pgbouncer.ini
-is deprecated now.
-
-==== client_encoding ====
+client_encoding
+---------------
Ask specific +client_encoding+ from server.
-==== datestyle ====
+datestyle
+---------
+
+Ask specific ``datestyle`` from server.
-Ask specific +datestyle+ from server.
+timezone
+--------
-==== timezone ====
+Ask specific **timezone** from server.
-Ask specific +timezone+ from server.
-== SECTION [users] ==
+Section [users]
+===============
This contains key=value pairs where key will be taken as a user name and
value as a libpq connect-string style list of key=value pairs. As actual libpq is not
used, so not all features from libpq can be used.
-=== Pool configuration ===
-==== pool_mode ====
+pool_mode
+---------
Set the pool mode to be used for all connections from this user. If not set, the
database or default pool_mode is used.
-== INCLUDE DIRECTIVE ==
+
+Include directive
+=================
The PgBouncer config file can contain include directives, which specify
another config file to read and process. This allows for splitting the
configuration file into physically separate parts. The include directives look
-like this:
+like this::
%include filename
If the file name is not absolute path it is taken as relative to current
working directory.
-== AUTHENTICATION FILE FORMAT ==
+Authentication file format
+==========================
PgBouncer needs its own user database. The users are loaded from a text
-file in following format:
+file in following format::
"username1" "password" ...
"username2" "md5abcdef012342345" ...
auth file needs to be generated. See `./etc/mkauth.py` for sample script
to generate auth file from `pg_shadow` table.
-PostgreSQL MD5-hidden password format:
+PostgreSQL MD5-hidden password format::
"md5" + md5(password + username)
So user `admin` with password `1234` will have MD5-hidden password
`md545f2603610af569b6155c45067268c6b`.
-== HBA FILE FORMAT ==
+HBA file format
+===============
It follows the format of PostgreSQL pg_hba.conf file:
http://www.postgresql.org/docs/9.4/static/auth-pg-hba-conf.html
Not supported: `gss`, `sspi`, `ident`, `ldap`, `radius`, `pam`.
Also username map (`map=`) parameter is not supported.
-== EXAMPLE ==
+Example
+=======
-=== Minimal config ===
+Minimal config::
[databases]
template1 = host=127.0.0.1 dbname=template1 auth_user=someuser
admin_users = someuser
stats_users = stat_collector
-=== Database defaults ===
+Database defaults::
[databases]
; access to destination database will go with single user
forcedb = host=127.0.0.1 port=300 user=baz password=foo client_encoding=UNICODE datestyle=ISO
-== SEE ALSO ==
+See also
+========
-pgbouncer(1) - manpage for general usage, console commands.
-http://wiki.postgresql.org/wiki/PgBouncer[]
+https://pgbouncer.github.io/
+
+https://wiki.postgresql.org/wiki/PgBouncer
+pgbouncer(1) - manpage for general usage, console commands.
-= pgbouncer(1) =
-== NAME ==
+pgbouncer
+#########
-pgbouncer - Lightweight connection pooler for PostgreSQL.
+Synopsis
+========
-== SYNOPSIS ==
+::
pgbouncer [-d][-R][-v][-u user] <pgbouncer.ini>
pgbouncer -V|-h
-On Windows computers, the options are:
+On Windows computers, the options are::
pgbouncer.exe [-v][-u user] <pgbouncer.ini>
pgbouncer.exe -V|-h
-Additional options for setting up a Windows service:
+Additional options for setting up a Windows service::
pgbouncer.exe --regservice <pgbouncer.ini>
pgbouncer.exe --unregservice <pgbouncer.ini>
-== DESCRIPTION ==
+DESCRIPTION
+===========
+pgbouncer+ is a PostgreSQL connection pooler. Any target application
can be connected to +pgbouncer+ as if it were a PostgreSQL server,
pooling, +pgbouncer+ supports several types of pooling when
rotating connections:
-Session pooling::
+Session pooling
Most polite method. When client connects, a server connection will
be assigned to it for the whole duration the client stays connected. When
the client disconnects, the server connection will be put back into the pool.
This is the default method.
-Transaction pooling::
+Transaction pooling
A server connection is assigned to client only during a transaction.
When PgBouncer notices that transaction is over, the server connection
will be put back into the pool.
-Statement pooling::
+Statement pooling
Most aggressive method. The server connection will be put back into
pool immediately after a query completes. Multi-statement
transactions are disallowed in this mode as they would break.
+SHOW+ commands available when connected to a special 'virtual'
database +pgbouncer+.
-== QUICK-START ==
+Quick-start
+===========
Basic setup and usage as following.
- 1. Create a pgbouncer.ini file. Details in +pgbouncer(5)+. Simple example:
+1. Create a pgbouncer.ini file. Details in +pgbouncer(5)+. Simple example::
[databases]
template1 = host=127.0.0.1 port=5432 dbname=template1
pidfile = pgbouncer.pid
admin_users = someuser
- 2. Create a users.txt file:
+2. Create a users.txt file::
"someuser" "same_password_as_in_server"
- 3. Launch +pgbouncer+:
+3. Launch +pgbouncer+::
$ pgbouncer -d pgbouncer.ini
- 4. Have your application (or the +psql+ client) connect to
- +pgbouncer+ instead of directly to PostgreSQL server.
+4. Have your application (or the +psql+ client) connect to
+ +pgbouncer+ instead of directly to PostgreSQL server::
$ psql -p 6543 -U someuser template1
- 5. Manage +pgbouncer+ by connecting to the special administration
- database +pgbouncer+ and issuing +show help;+ to begin:
+5. Manage +pgbouncer+ by connecting to the special administration
+ database +pgbouncer+ and issuing +show help;+ to begin::
$ psql -p 6543 -U someuser pgbouncer
pgbouncer=# show help;
RESUME
SHUTDOWN
- 6. If you made changes to the pgbouncer.ini file, you can reload it with:
+ 6. If you made changes to the pgbouncer.ini file, you can reload it with::
pgbouncer=# RELOAD;
-== COMMAND LINE SWITCHES ==
+Command line switches
+=====================
--d::
+``-d``
Run in background. Without it the process will run in foreground.
Note: Does not work on Windows, +pgbouncer+ need to run as service there.
--R::
+``-R``
Do an online restart. That means connecting to the running process,
loading the open sockets from it, and then using them. If there
is no active process, boot normally.
is not disabled in config. Does not work on Windows machines.
Does not work with TLS connections, they are dropped.
--u user::
+``-u user``
Switch to the given user on startup.
--v::
+``-v``
Increase verbosity. Can be used multiple times.
--q::
+``-q``
Be quiet - do not log to stdout. Note this does not affect
logging verbosity, only that stdout is not to be used.
For use in init.d scripts.
--V::
+``-V``
Show version.
--h::
+``-h``
Show short help.
---regservice::
+``--regservice``
Win32: Register pgbouncer to run as Windows service. The +service_name+
config parameter value is used as name to register under.
---unregservice::
+``--unregservice``
Win32: Unregister Windows service.
-== ADMIN CONSOLE ==
+Admin console
+=============
The console is available by connecting as normal to the
-database +pgbouncer+
+database +pgbouncer+::
$ psql -p 6543 pgbouncer
if the login comes via Unix socket and the client has same Unix user uid
as the running process.
-=== SHOW COMMANDS ===
+Show commands
+~~~~~~~~~~~~~
The +SHOW+ commands output information. Each command is described below.
-==== SHOW STATS; ====
+SHOW STATS;
+-----------
Shows statistics.
-database::
+``database``
Statistics are presented per database.
-total_requests::
+``total_requests``
Total number of +SQL+ requests pooled by +pgbouncer+.
-total_received::
+``total_received``
Total volume in bytes of network traffic received by +pgbouncer+.
-total_sent::
+``total_sent``
Total volume in bytes of network traffic sent by +pgbouncer+.
-total_query_time::
+``total_query_time``
Total number of microseconds spent by +pgbouncer+ when actively
connected to PostgreSQL.
-avg_req::
+``avg_req``
Average requests per second in last stat period.
-avg_recv::
+``avg_recv``
Average received (from clients) bytes per second.
-avg_sent::
+``avg_sent``
Average sent (to clients) bytes per second.
-avg_query::
+``avg_query``
Average query duration in microseconds.
-==== SHOW SERVERS; ====
+SHOW SERVERS;
+-------------
-type::
+``type``
S, for server.
-user::
+``user``
Username +pgbouncer+ uses to connect to server.
-database::
+``database``
Database name.
-state::
+``state``
State of the pgbouncer server connection, one of +active+, +used+ or
+idle+.
-addr::
+``addr``
IP address of PostgreSQL server.
-port::
+``port``
Port of PostgreSQL server.
-local_addr::
+``local_addr``
Connection start address on local machine.
-local_port::
+``local_port``
Connection start port on local machine.
-connect_time::
+``connect_time``
When the connection was made.
-request_time::
+``request_time``
When last request was issued.
-ptr::
+``ptr``
Address of internal object for this connection.
Used as unique ID.
-link::
+``link``
Address of client connection the server is paired with.
-remote_pid::
+``remote_pid``
Pid of backend server process. In case connection is made over
unix socket and OS supports getting process ID info, it's
OS pid. Otherwise it's extracted from cancel packet server sent,
which should be PID in case server is Postgres, but it's a random
number in case server it another PgBouncer.
-==== SHOW CLIENTS; ====
+SHOW CLIENTS;
+-------------
-type::
+``type``
C, for client.
-user::
+``user``
Client connected user.
-database::
+``database``
Database name.
-state::
+``state``
State of the client connection, one of +active+, +used+, +waiting+
or +idle+.
-addr::
+``addr``
IP address of client.
-port::
+``port``
Port client is connected to.
-local_addr::
+``local_addr``
Connection end address on local machine.
-local_port::
+``local_port``
Connection end port on local machine.
-connect_time::
+``connect_time``
Timestamp of connect time.
-request_time::
+``request_time``
Timestamp of latest client request.
-ptr::
+``ptr``
Address of internal object for this connection.
Used as unique ID.
-link::
+``link``
Address of server connection the client is paired with.
-remote_pid::
+``remote_pid``
Process ID, in case client connects over UNIX socket
and OS supports getting it.
-==== SHOW POOLS; ====
+SHOW POOLS;
+-----------
A new pool entry is made for each couple of (database, user).
-database::
+``database``
Database name.
-user::
+``user``
User name.
-cl_active::
+``cl_active``
Client connections that are linked to server connection and can process queries.
-cl_waiting::
+``cl_waiting``
Client connections have sent queries but have not yet got a server connection.
-sv_active::
+``sv_active``
Server connections that linked to client.
-sv_idle::
+``sv_idle``
Server connections that unused and immediately usable for client queries.
-sv_used::
+``sv_used``
Server connections that have been idle more than `server_check_delay`,
so they needs `server_check_query` to run on it before it can be used.
-sv_tested::
+``sv_tested``
Server connections that are currently running either `server_reset_query`
or `server_check_query`.
-sv_login::
+``sv_login``
Server connections currently in logging in process.
-maxwait::
+``maxwait``
How long the first (oldest) client in queue has waited, in seconds.
If this starts increasing, then the current pool of servers does
not handle requests quick enough. Reason may be either overloaded
server or just too small of a +pool_size+ setting.
-pool_mode::
+``pool_mode``
The pooling mode in use.
-==== SHOW LISTS; ====
+SHOW LISTS;
+-----------
Show following internal information, in columns (not rows):
-databases::
+``databases``
Count of databases.
-users::
+``users``
Count of users.
-pools::
+``pools``
Count of pools.
-free_clients::
+``free_clients``
Count of free clients.
-used_clients::
+``used_clients``
Count of used clients.
-login_clients::
+``login_clients``
Count of clients in +login+ state.
-free_servers::
+``free_servers``
Count of free servers.
-used_servers::
+``used_servers``
Count of used servers.
-==== SHOW USERS; ====
+SHOW USERS;
+-----------
-name::
+``name``
The user name
-pool_mode::
+``pool_mode``
The user's override pool_mode, or NULL if the default will be used instead.
-==== SHOW DATABASES; ====
+SHOW DATABASES;
+---------------
-name::
+``name``
Name of configured database entry.
-host::
+``host``
Host pgbouncer connects to.
-port::
+``port``
Port pgbouncer connects to.
-database::
+``database``
Actual database name pgbouncer connects to.
-force_user::
+``force_user``
When user is part of the connection string, the connection between
pgbouncer and PostgreSQL is forced to the given user, whatever the
client user.
-pool_size::
+``pool_size``
Maximum number of server connections.
-pool_mode::
+``pool_mode``
The database's override pool_mode, or NULL if the default will be used instead.
-==== SHOW FDS; ====
+SHOW FDS;
+---------
Internal command - shows list of fds in use with internal state attached to them.
This command also blocks internal event loop, so it should not be used
while PgBouncer is in use.
-fd::
+``fd``
File descriptor numeric value.
-task::
+``task``
One of +pooler+, +client+ or +server+.
-user::
+``user``
User of the connection using the FD.
-database::
+``database``
Database of the connection using the FD.
-addr::
+``addr``
IP address of the connection using the FD, +unix+ if a unix socket
is used.
-port::
+``port``
Port used by the connection using the FD.
-cancel::
+``cancel``
Cancel key for this connection.
-link::
+``link``
fd for corresponding server/client. NULL if idle.
-==== SHOW CONFIG; ====
+SHOW CONFIG;
+------------
Show the current configuration settings, one per row, with following
columns:
-key::
+``key``
Configuration variable name
-value::
+``value``
Configuration value
-changeable::
+``changeable``
Either +yes+ or +no+, shows if the variable can be changed while running.
If +no+, the variable can be changed only boot-time.
-==== SHOW DNS_HOSTS ====
+SHOW DNS_HOSTS;
+---------------
Show hostnames in DNS cache.
-hostname::
+``hostname``
Host name.
-ttl::
+``ttl``
How meny seconds until next lookup.
-addrs::
+``addrs``
Comma separated list of addresses.
-==== SHOW DNS_ZONES ====
+SHOW DNS_ZONES
+--------------
Show DNS zones in cache.
-zonename::
+``zonename``
Zone name.
-serial::
+``serial``
Current serial.
-count::
+``count``
Hostnames belonging to this zone.
-=== PROCESS CONTROLLING COMMANDS ===
+Process controlling commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-==== PAUSE [db]; ====
+PAUSE [db];
+-----------
PgBouncer tries to disconnect from all servers, first waiting for all queries
to complete. The command will not return before all queries are finished. To be used
If database name is given, only that database will be paused.
-==== DISABLE db; ====
+DISABLE db;
+-----------
Reject all new client connections on the given database.
-==== ENABLE db; ====
+ENABLE db;
+----------
Allow new client connections after a previous +DISABLE+ command.
-==== KILL db; ====
+KILL db;
+--------
Immediately drop all client and server connections on given database.
-==== SUSPEND; ====
+SUSPEND;
+--------
All socket buffers are flushed and PgBouncer stops listening for data on them.
The command will not return before all buffers are empty. To be used at the time
of PgBouncer online reboot.
-==== RESUME [db]; ====
+RESUME [db];
+------------
Resume work from previous +PAUSE+ or +SUSPEND+ command.
-==== SHUTDOWN; ====
+SHUTDOWN;
+---------
The PgBouncer process will exit.
-==== RELOAD; ====
+RELOAD;
+-------
The PgBouncer process will reload its configuration file and update
changeable settings.
-=== SIGNALS ===
+Signals
+~~~~~~~
-SIGHUP::
+``SIGHUP``
Reload config. Same as issuing command +RELOAD;+ on console.
-SIGINT::
+``SIGINT``
Safe shutdown. Same as issuing +PAUSE;+ and +SHUTDOWN;+ on console.
-SIGTERM::
+``SIGTERM``
Immediate shutdown. Same as issuing +SHUTDOWN;+ on console.
-=== LIBEVENT SETTINGS ===
+Libevent settings
+~~~~~~~~~~~~~~~~~
-From libevent docs:
+From libevent docs::
It is possible to disable support for epoll, kqueue, devpoll, poll
or select by setting the environment variable EVENT_NOEPOLL,
By setting the environment variable EVENT_SHOW_METHOD, libevent
displays the kernel notification method that it uses.
-== SEE ALSO ==
+See also
+========
pgbouncer(5) - manpage of configuration settings descriptions.
-http://wiki.postgresql.org/wiki/PgBouncer[]
+https://pgbouncer.github.io/
+
+https://wiki.postgresql.org/wiki/PgBouncer
projects / pgbouncer / commitdiff