.\" Title: pgbouncer
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: 11/23/2007
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\" Date: 04/09/2008
.\" Manual:
.\" Source:
.\"
-.TH "PGBOUNCER" "1" "11/23/2007" "" ""
+.TH "PGBOUNCER" "1" "04/09/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-pgbouncer \- Lightweight connection pooler for PostgreSQL.
+pgbouncer - Lightweight connection pooler for PostgreSQL.
.SH "SYNOPSIS"
.sp
.RS 4
.nf
-pgbouncer [\-d][\-R][\-v] <pgbouncer.ini>
+pgbouncer [\-d][\-R][\-v][\-u user] <pgbouncer\.ini>
pgbouncer \-V|\-h
.fi
.RE
.SH "DESCRIPTION"
-pgbouncer is a PostgreSQL connection pooler. Any target application can be connected to pgbouncer as if it were a PostgreSQL server, and pgbouncer will manage to connect to the server, or to reuse one of its existing connections.
+pgbouncer is a PostgreSQL connection pooler\. Any target application can be connected to pgbouncer as if it were a PostgreSQL server, and pgbouncer will manage to connect to the server, or to reuse one of its existing connections\.
.sp
-The aim of pgbouncer is to lower the performance impact of opening new connections to PostgreSQL.
+The aim of pgbouncer is to lower the performance impact of opening new connections to PostgreSQL\.
.sp
In order not to compromise transaction semantics for connection pooling, pgbouncer supports several levels of brutality when rotating connections:
-.sp
.PP
Session pooling
.RS 4
-Most polite method. When client connects, a server connection will be assigned to it for the whole duration it stays connected. When client disconnects, the server connection will be put back into pool.
+Most polite method\. When client connects, a server connection will be assigned to it for the whole duration it stays connected\. When client disconnects, the server connection will be put back into pool\.
.RE
.PP
Transaction pooling
.RS 4
-Server connection is assigned to client only during a transaction. When PgBouncer notices that transaction is over, the server will be put back into pool.
+Server connection is assigned to client only during a transaction\. When PgBouncer notices that transaction is over, the server will be put back into pool\.
.RE
.PP
Statement pooling
.RS 4
-Most aggressive method. The server connection will be put back into pool immidiately after a query completes. Multi\-statement transactions are disallowed in this mode as they would break.
+Most aggressive method\. The server connection will be put back into pool immidiately after a query completes\. Multi\-statement transactions are disallowed in this mode as they would break\.
.RE
.sp
-The administration interface of pgbouncer consists of some new SHOW commands available when connected to a special \fIvirtual\fR database pgbouncer.
+The administration interface of pgbouncer consists of some new SHOW commands available when connected to a special \fIvirtual\fR database pgbouncer\.
+.sp
+.SH "QUICK-START"
+Basic setup and usage as following\.
.sp
-.SH "QUICK\-START"
-Basic setup and usage as following.
.sp
-.TP 4
-1.
-Create config file. Details in
-pgbouncer(5). Simplest:
+.RS 4
+\h'-04' 1.\h'+02'Create config file\. Details in
+pgbouncer(5)\. Simplest:
.sp
.RS 4
.nf
[databases]
-template1 = host=127.0.0.1 port=5432 dbname=template1
+template1 = host=127\.0\.0\.1 port=5432 dbname=template1
.fi
.RE
.sp
.nf
[pgbouncer]
listen_port = 6543
-listen_addr = 127.0.0.1
+listen_addr = 127\.0\.0\.1
auth_type = md5
-auth_file = users.txt
-logfile = pgbouncer.log
-pidfile = pgbouncer.pid
+auth_file = users\.txt
+logfile = pgbouncer\.log
+pidfile = pgbouncer\.pid
admin_users = someuser
.fi
.RE
-.TP 4
-2.
-Create users.txt file:
+.RE
+.sp
+.RS 4
+\h'-04' 2.\h'+02'Create users\.txt file:
.sp
.RS 4
.nf
"someuser" "same_password_as_in_server"
.fi
.RE
-.TP 4
-3.
-Launch
+.RE
+.sp
+.RS 4
+\h'-04' 3.\h'+02'Launch
pgbouncer:
.sp
.RS 4
.nf
-$ pgbouncer \-d pgbouncer.ini
+$ pgbouncer \-d pgbouncer\.ini
.fi
.RE
-.TP 4
-4.
-have your application (or the
+.RE
+.sp
+.RS 4
+\h'-04' 4.\h'+02'have your application (or the
psql
client) connect to
pgbouncer
-instead of directly to PostgreSQL server.
+instead of directly to PostgreSQL server\.
.sp
.RS 4
.nf
-$ psql \-h 127.0.0.1 \-p 6543 \-U someuser template1
+$ psql \-h 127\.0\.0\.1 \-p 6543 \-U someuser template1
.fi
.RE
-.TP 4
-5.
-manage
+.RE
+.sp
+.RS 4
+\h'-04' 5.\h'+02'manage
pgbouncer
by connecting to special administration database
pgbouncer
.sp
.RS 4
.nf
-$ psql \-h 127.0.0.1 \-p 6543 \-U someuser pgbouncer
+$ psql \-h 127\.0\.0\.1 \-p 6543 \-U someuser pgbouncer
pgbouncer=# show help;
NOTICE: Console usage
DETAIL:
SHUTDOWN
.fi
.RE
-.TP 4
-6.
-If you change some changeable configuration settings in the configuration file, you can reload the file with:
+.RE
+.sp
+.RS 4
+\h'-04' 6.\h'+02'If you change some changeable configuration settings in the configuration file, you can reload the file with:
.sp
.RS 4
.nf
pgbouncer=# RELOAD;
.fi
.RE
+.RE
.SH "COMMAND LINE SWITCHES"
.PP
\-d
.RS 4
-Run in background. Without it the process will run in foreground.
+Run in background\. Without it the process will run in foreground\.
.RE
.PP
\-R
.RS 4
-Do a online restart. That means connecting to running process, loading open sockets from it and using them.
+Do a online restart\. That means connecting to running process, loading open sockets from it and using them\.
+.RE
+.PP
+\-u
+.RS 4
+Switch to user on startup\.
.RE
.PP
\-v
.RS 4
-Increase verbosity.
+Increase verbosity\. Can be used multiple time\.
+.RE
+.PP
+\-q
+.RS 4
+Be quiet \- don\'t log to stdout\.
.RE
.PP
\-V
.RS 4
-Show version.
+Show version\.
.RE
.PP
\-h
.RS 4
-Show short help.
+Show short help\.
.RE
.SH "ADMIN CONSOLE"
-Console is available by connecting into standard listen_addr/listen_port and specifying string pgbouncer as database.
+Console is available by connecting into standard listen_addr/listen_port and specifying string pgbouncer as database\.
.sp
.sp
.RS 4
.nf
-$ psql \-h 127.0.0.1 \-p 6543 pgbouncer
+$ psql \-h 127\.0\.0\.1 \-p 6543 pgbouncer
.fi
.RE
.sp
-Only users listed in configuration parameters admin_users or stats_users are allowed to login to the console.
+Only users listed in configuration parameters admin_users or stats_users are allowed to login to the console\.
.sp
-Additionally, username pgbouncer is allowed to log in without password, if the login comes via UNIX socket and the client has same UNIX user uid as the running process.
+Additionally, username pgbouncer is allowed to log in without password, if the login comes via UNIX socket and the client has same UNIX user uid as the running process\.
.sp
.SS "SHOW COMMANDS"
-The SHOW commands output some rows, the columns contained are described here.
+The SHOW commands output some rows, the columns contained are described here\.
.sp
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW STATS;\fR
+SHOW STATS;
.RS
-Shows statistics.
-.sp
+Shows statistics\.
.PP
database
.RS 4
-Statistics are presented per database.
+Statistics are presented per database\.
.RE
.PP
total_requests
Total number of
SQL
requests pooled by
-pgbouncer.
+pgbouncer\.
.RE
.PP
total_received
.RS 4
Total volume in bytes of network traffic received by
-pgbouncer.
+pgbouncer\.
.RE
.PP
total_sent
.RS 4
Total volume in bytes of network traffic sent by
-pgbouncer.
+pgbouncer\.
.RE
.PP
total_query_time
.RS 4
Total number of milliseconds spent by
pgbouncer
-when actively connected to PostgreSQL.
+when actively connected to PostgreSQL\.
.RE
.PP
avg_req
.RS 4
-Average requests per second in last stat period.
+Average requests per second in last stat period\.
.RE
.PP
avg_recv
.RS 4
-Average received (from clients) bytes per second.
+Average received (from clients) bytes per second\.
.RE
.PP
avg_sent
.RS 4
-Average sent (to clients) bytes per second.
+Average sent (to clients) bytes per second\.
.RE
.PP
avg_query
.RS 4
-Average query duration in milliseconds.
+Average query duration in milliseconds\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW SERVERS;\fR
+SHOW SERVERS;
.RS
.PP
type
.RS 4
-S, for server.
+S, for server\.
.RE
.PP
user
.RS 4
Username
pgbouncer
-uses to connect to server.
+uses to connect to server\.
.RE
.PP
database
.RS 4
-database name on server.
+database name on server\.
.RE
.PP
state
active,
used
or
-idle.
+idle\.
.RE
.PP
addr
.RS 4
-IP address of PostgreSQL server.
+IP address of PostgreSQL server\.
.RE
.PP
port
.RS 4
-Port of PostgreSQL server.
+Port of PostgreSQL server\.
.RE
.PP
local_addr
.RS 4
-Connection start address on local machine.
+Connection start address on local machine\.
.RE
.PP
local_port
.RS 4
-Connection start port on local machine.
+Connection start port on local machine\.
.RE
.PP
connect_time
.RS 4
-When the connection was made.
+When the connection was made\.
.RE
.PP
request_time
.RS 4
-When last request was issued.
+When last request was issued\.
.RE
.PP
ptr
.RS 4
-Address of internal object for this connection. Used as unique ID.
+Address of internal object for this connection\. Used as unique ID\.
.RE
.PP
link
.RS 4
-Address of client connection the server is paired with.
+Address of client connection the server is paired with\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW CLIENTS;\fR
+SHOW CLIENTS;
.RS
.PP
type
.RS 4
-C, for client.
+C, for client\.
.RE
.PP
user
.RS 4
-Client connected user.
+Client connected user\.
.RE
.PP
database
.RS 4
-database name.
+database name\.
.RE
.PP
state
used,
waiting
or
-idle.
+idle\.
.RE
.PP
addr
.RS 4
-IP address of client.
+IP address of client\.
.RE
.PP
port
.RS 4
-port client is connected to.
+port client is connected to\.
.RE
.PP
local_addr
.RS 4
-Connection end address on local machine.
+Connection end address on local machine\.
.RE
.PP
local_port
.RS 4
-Connection end port on local machine.
+Connection end port on local machine\.
.RE
.PP
connect_time
.RS 4
-Timestamp of later client connection.
+Timestamp of later client connection\.
.RE
.PP
request_time
.RS 4
-Timestamp of later client request.
+Timestamp of later client request\.
.RE
.PP
ptr
.RS 4
-Address of internal object for this connection. Used as unique ID.
+Address of internal object for this connection\. Used as unique ID\.
.RE
.PP
link
.RS 4
-Address of server connection the client is paired with.
+Address of server connection the client is paired with\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW POOLS;\fR
+SHOW POOLS;
.RS
-A new pool entry is made for each couple of (database, user).
-.sp
+A new pool entry is made for each couple of (database, user)\.
.PP
database
.RS 4
-database name.
+database name\.
.RE
.PP
user
.RS 4
-username.
+username\.
.RE
.PP
cl_active
.RS 4
Count of currently
active
-client connections.
+client connections\.
.RE
.PP
cl_waiting
.RS 4
Count of currently
waiting
-client connections.
+client connections\.
.RE
.PP
sv_active
.RS 4
Count of currently
active
-server connections.
+server connections\.
.RE
.PP
sv_idle
.RS 4
Count of currently
idle
-server connections.
+server connections\.
.RE
.PP
sv_used
.RS 4
Count of currently
used
-server connections.
+server connections\.
.RE
.PP
sv_tested
.RS 4
Count of currently
tested
-server connections.
+server connections\.
.RE
.PP
sv_login
.RS 4
Count of server connections currently
login
-to PostgreSQL.
+to PostgreSQL\.
.RE
.PP
maxwait
.RS 4
-How long has first (oldest) client in queue waited, in second. If this start increasing, then current pool of servers does not handle requests quick enough. Reason may be either overloaded server or just too small pool_size.
+How long has first (oldest) client in queue waited, in second\. If this start increasing, then current pool of servers does not handle requests quick enough\. Reason may be either overloaded server or just too small pool_size\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW LISTS;\fR
+SHOW LISTS;
.RS
Show following internal information, in columns (not rows):
-.sp
.PP
databases
.RS 4
-Count of databases.
+Count of databases\.
.RE
.PP
users
.RS 4
-Count of users.
+Count of users\.
.RE
.PP
pools
.RS 4
-Count of pools.
+Count of pools\.
.RE
.PP
free_clients
.RS 4
-Count of free clients.
+Count of free clients\.
.RE
.PP
used_clients
.RS 4
-Count of used clients.
+Count of used clients\.
.RE
.PP
login_clients
.RS 4
Count of clients in
login
-state.
+state\.
.RE
.PP
free_servers
.RS 4
-Count of free servers.
+Count of free servers\.
.RE
.PP
used_servers
.RS 4
-Count of used servers.
+Count of used servers\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW USERS;\fR
+SHOW USERS;
.RS
-Show one line per user, under the name column name.
+Show one line per user, under the name column name\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW DATABASES;\fR
+SHOW DATABASES;
.RS
.PP
name
.RS 4
-name of configured database entry.
+name of configured database entry\.
.RE
.PP
host
.RS 4
-Host pgbouncer connects to.
+Host pgbouncer connects to\.
.RE
.PP
port
.RS 4
-Port pgbouncer connects to.
+Port pgbouncer connects to\.
.RE
.PP
database
.RS 4
-Actual database name pgbouncer connects to.
+Actual database name pgbouncer connects to\.
.RE
.PP
force_user
.RS 4
-When user is part of the connection string, the connection between pgbouncer and PostgreSQL is forced to the given user, whatever the client 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\.
.RE
.PP
pool_size
.RS 4
-Maximum number of server connections.
+Maximum number of server connections\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW FDS;\fR
+SHOW FDS;
.RS
-Shows list of fds in use. When the connected user has username "pgbouncer", connects thru unix socket and has same UID as running process, the actual fds are passed over connection. This mechanism is used to do online restart.
-.sp
+Shows list of fds in use\. When the connected user has username "pgbouncer", connects thru unix socket and has same UID as running process, the actual fds are passed over connection\. This mechanism is used to do online restart\.
.PP
fd
.RS 4
-File descriptor numeric value.
+File descriptor numeric value\.
.RE
.PP
task
pooler,
client
or
-server.
+server\.
.RE
.PP
user
.RS 4
-User of the connection using the FD.
+User of the connection using the FD\.
.RE
.PP
database
.RS 4
-database of the connection using the FD.
+database of the connection using the FD\.
.RE
.PP
addr
.RS 4
IP address of the connection using the FD,
unix
-if a unix socket is used.
+if a unix socket is used\.
.RE
.PP
port
.RS 4
-port used by the connection using the FD.
+port used by the connection using the FD\.
.RE
.PP
cancel
.RS 4
-cancel key for this connection.
+cancel key for this connection\.
.RE
.PP
link
.RS 4
-fd for corresponding server/client. NULL if idle.
+fd for corresponding server/client\. NULL if idle\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHOW CONFIG;\fR
+SHOW CONFIG;
.RS
Show the current configuration settings, one per row, with following columns:
-.sp
.PP
key
.RS 4
Either
yes
or
-no, shows if the variable is changeable when running. If
-no, the variable can be changed only boot\-time.
+no, shows if the variable is changeable when running\. If
+no, the variable can be changed only boot\-time\.
.RE
.RE
.SS "PROCESS CONTROLLING COMMANDS"
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBPAUSE;\fR
+PAUSE;
.RS
-PgBouncer tries to disconnect from all servers, first waiting for all queries to complete. The command will not return before all is done.
+PgBouncer tries to disconnect from all servers, first waiting for all queries to complete\. The command will not return before all is done\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSUSPEND;\fR
+SUSPEND;
.RS
-All socket buffers are flushed and PgBouncer stops listening data on them. The command will not return before all is done.
+All socket buffers are flushed and PgBouncer stops listening data on them\. The command will not return before all is done\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBRESUME;\fR
+RESUME;
.RS
-Resume work from previous PAUSE or SUSPEND command.
+Resume work from previous PAUSE or SUSPEND command\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBSHUTDOWN;\fR
+SHUTDOWN;
.RS
-The PgBouncer process will exit.
+The PgBouncer process will exit\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBRELOAD;\fR
+RELOAD;
.RS
-The PgBouncer process will reload its configuration file and update changeable settings.
+The PgBouncer process will reload its configuration file and update changeable settings\.
.sp
.RE
.SS "SIGNALS"
.PP
SIGHUP
.RS 4
-Reload config. Same as issuing command
+Reload config\. Same as issuing command
RELOAD;
-on console.
+on console\.
.RE
.PP
SIGINT
.RS 4
-Safe shutdown. Same as issuing
+Safe shutdown\. Same as issuing
PAUSE;
and
SHUTDOWN;
-on console.
+on console\.
.RE
.PP
SIGTERM
.RS 4
-Immediate shutdown. Same as issuing
+Immediate shutdown\. Same as issuing
SHUTDOWN;
-on console.
+on console\.
.RE
.SS "LIBEVENT SETTINGS"
From libevent docs:
It is possible to disable support for epoll, kqueue, devpoll, poll
or select by setting the environment variable EVENT_NOEPOLL,
EVENT_NOKQUEUE, EVENT_NODEVPOLL, EVENT_NOPOLL or EVENT_NOSELECT,
-respectively.
+respectively\.
.fi
.RE
.sp
.RS 4
.nf
By setting the environment variable EVENT_SHOW_METHOD, libevent
-displays the kernel notification method that it uses.
+displays the kernel notification method that it uses\.
.fi
.RE
.SS "AUTHENTICATION FILE FORMAT"
-PgBouncer needs its own user database. The users are loaded from text file that should be in same format as PostgreSQL's pg_auth/pg_pwd file.
+PgBouncer needs its own user database\. The users are loaded from text file that should be in same format as PostgreSQL\'s pg_auth/pg_pwd file\.
.sp
.sp
.RS 4
.nf
-"username1" "password" ...
-"username2" "md12342345234" ...
+"username1" "password" \.\.\.
+"username2" "md12342345234" \.\.\.
.fi
.RE
.sp
-There shoud be at least 2 fields, surrounded by double quotes. First is username and second either plain\-text or md5\-hashed password. PgBouncer ignores rest of the line.
+There shoud be at least 2 fields, surrounded by double quotes\. First is username and second either plain\-text or md5\-hashed password\. PgBouncer ignores rest of the line\.
.sp
-Such file format allows to direct PgBouncer directly to PostgreSQL user file under data directory.
+Such file format allows to direct PgBouncer directly to PostgreSQL user file under data directory\.
.sp
.SH "SEE ALSO"
-pgbouncer(5) \- configuration settings descriptions.
+pgbouncer(5) \- configuration settings descriptions\.
.sp
-\fIhttps://developer.skype.com/SkypeGarage/DbProjects/PgBouncer\fR
+\fIhttps://developer\.skype\.com/SkypeGarage/DbProjects/PgBouncer\fR
.sp
.\" Title: pgbouncer
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: 11/23/2007
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\" Date: 04/09/2008
.\" Manual:
.\" Source:
.\"
-.TH "PGBOUNCER" "5" "11/23/2007" "" ""
+.TH "PGBOUNCER" "5" "04/09/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-pgbouncer \- Lightweight connection pooler for PostgreSQL.
+pgbouncer - Lightweight connection pooler for PostgreSQL.
.SH "SYNOPSIS"
.sp
.RS 4
.nf
[databases]
-db = ...
+db = \.\.\.
.fi
.RE
.sp
.RS 4
.nf
[pgbouncer]
-...
+\.\.\.
.fi
.RE
.SH "DESCRIPTION"
-Config file is in "ini" format. Section names are between " and ". Lines starting with ";" or "" are taken as comment and ignored. The characters ";" and "" are not recognized when they appear later in the line.
+Config file is in "ini" format\. Section names are between " and "\. Lines starting with ";" or "" are taken as comment and ignored\. The characters ";" and "" are not recognized when they appear later in the line\.
.sp
.SH "SECTION [PGBOUNCER]"
.SS "Generic settings"
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBlogfile\fR
+logfile
.RS
-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\.
.sp
-Default: not set.
+Default: not set\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBpidfile\fR
+pidfile
.RS
-Specifies pid file. Without pidfile, the daemonization is not allowed.
+Specifies pid file\. Without pidfile, the daemonization is not allowed\.
.sp
-Default: not set.
+Default: not set\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBlisten_addr\fR
+listen_addr
.RS
-Specifies IPv4 address, where to listen for TCP connections. Or * meaning "listen on all addresses". When not set, only unix socket connections are allowed.
+Specifies IPv4 address, where to listen for TCP connections\. Or * meaning "listen on all addresses"\. When not set, only unix socket connections are allowed\.
.sp
Default: not set
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBlisten_port\fR
+listen_port
.RS
-On which port to listen on. Applies to both TCP and Unix sockets.
+On which port to listen on\. Applies to both TCP and Unix sockets\.
.sp
Default: 6000
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBunix_socket_dir\fR
+unix_socket_dir
.RS
-Specifies location for Unix sockets. Applies to both listening socket and server connections. If set to empty string, Unix sockets are disabled.
+Specifies location for Unix sockets\. Applies to both listening socket and server connections\. If set to empty string, Unix sockets are disabled\.
.sp
Default: /tmp
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBauth_file\fR
+user
.RS
-Load user names and passwords from this file. File format used is same as for PostgreSQL pg_auth/pg_pwd file, so can be pointed directly to backend file.
+If set, specifies UNIX user to change to\. Work only if started as root or user is same as current user\.
.sp
-Default: not set.
+Default: not set
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBauth_type\fR
+auth_file
.RS
-How to authenticate users.
+Load user names and passwords from this file\. File format used is same as for PostgreSQL pg_auth/pg_pwd file, so can be pointed directly to backend file\.
+.sp
+Default: not set\.
.sp
+.RE
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+auth_type
+.RS
+How to authenticate users\.
.PP
md5
.RS 4
-Use MD5\-based password check.
+Use MD5\-based password check\.
auth_file
-may contain both md5\-encrypted or plain\-text passwords. Default.
+may contain both md5\-encrypted or plain\-text passwords\. Default\.
.RE
.PP
crypt
.RS 4
-Use crypt(3) based bassword check.
+Use crypt(3) based bassword check\.
auth_file
-must contain plain\-text passwords.
+must contain plain\-text passwords\.
.RE
.PP
plain
.RS 4
-Clear\-text password is sent over wire.
+Clear\-text password is sent over wire\.
.RE
.PP
trust
.RS 4
-No authentication is done. Username must still exists in
-auth_file.
+No authentication is done\. Username must still exists in
+auth_file\.
.RE
.PP
any
.RS 4
Like
trust
-but username given is ignored. Requires that all databases have configured to log in as specific user.
+but username given is ignored\. Requires that all databases have configured to log in as specific user\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBpool_mode\fR
+pool_mode
.RS
-Specifies when server connection is tagged as reusable for other clients.
-.sp
+Specifies when server connection is tagged as reusable for other clients\.
.PP
session
.RS 4
-Server is released back to pool after client disconnects. Default.
+Server is released back to pool after client disconnects\. Default\.
.RE
.PP
transaction
.RS 4
-Server is released back to pool after transaction finishes.
+Server is released back to pool after transaction finishes\.
.RE
.PP
statement
.RS 4
-Server is released back to pool after query finishes. Long transactions spanning multiple statements are disallowed in this mode.
+Server is released back to pool after query finishes\. Long transactions spanning multiple statements are disallowed in this mode\.
.RE
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBmax_client_conn\fR
+max_client_conn
.RS
-Maximum number of client connections allowed. When increased then the file descriptor limits should also be increased. Note that actual number of file descriptiors used is more that max_client_conn. Theoretical maximum used is:
+Maximum number of client connections allowed\. When increased then the file descriptor limits should also be increased\. Note that actual number of file descriptiors used is more that max_client_conn\. Theoretical maximum used is:
.sp
.sp
.RS 4
.fi
.RE
.sp
-if each user connects under it's own username to server. If database user is specified in connect string (all users connect under same username), the theoretical maximum is:
+if each user connects under it\'s own username to server\. If database user is specified in connect string (all users connect under same username), the theoretical maximum is:
.sp
.sp
.RS 4
.fi
.RE
.sp
-The theoretical maximum should be never reached, unless somebody deliberately crafts special load for it. Still, it means you should give fds liberately.
+The theoretical maximum should be never reached, unless somebody deliberately crafts special load for it\. Still, it means you should give fds liberately\.
.sp
-Search for ulimit in your favourite shell man page.
+Search for ulimit in your favourite shell man page\.
.sp
Default: 100
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBdefault_pool_size\fR
+default_pool_size
.RS
-How many server connection to allow per user/database pair. Can be overrided in per\-database config.
+How many server connection to allow per user/database pair\. Can be overrided in per\-database config\.
.sp
Default: 20
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBserver_round_robin\fR
+server_round_robin
.RS
-By default, pgbouncer reuses server connections in LIFO manner, so that few connections get the most load. This gives best performance if you have single server serving a database. But if there is TCP round\-robin behind a database IP then it's better if pgbouncer also uses connections in that manner, thus achieving uniform load.
+By default, pgbouncer reuses server connections in LIFO manner, so that few connections get the most load\. This gives best performance if you have single server serving a database\. But if there is TCP round\-robin behind a database IP then it\'s better if pgbouncer also uses connections in that manner, thus achieving uniform load\.
.sp
Default: 0
.sp
.RE
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+ignore_startup_parameters
+.RS
+By default, PgBouncer allows only parameters it can keep track of in startup packets \- client_encoding, datestyle, timezone and standard_conforming_strings\.
+.sp
+All others raise error\. To allow others too, they can be specified here, so that pgbouncer knows that they have handled by admin and it can ignore them\.
+.sp
+Default: empty
+.sp
+.RE
.SS "Log settings"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBlog_connections\fR
+log_connections
.RS
-Log successful logins.
+Log successful logins\.
.sp
Default: 1
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBlog_disconnections\fR
+log_disconnections
.RS
-Log disconnections with reasons.
+Log disconnections with reasons\.
.sp
Default: 1
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBlog_pooler_errors\fR
+log_pooler_errors
.RS
-Log error messaged pooler sends to clients.
+Log error messaged pooler sends to clients\.
.sp
Default: 1
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBadmin_users\fR
+admin_users
.RS
-List of users that are allowed to run all commands on console.
+List of users that are allowed to run all commands on console\.
.sp
Default: empty
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBstats_users\fR
+stats_users
.RS
-List of users that are allowed to run read\-only queries on console. Thats means all SHOW commands except SHOW FDS.
+List of users that are allowed to run read\-only queries on console\. Thats means all SHOW commands except SHOW FDS\.
.sp
-Default: empty.
+Default: empty\.
.sp
.RE
.SS "Connection sanity checks, timeouts"
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBserver_reset_query\fR
+server_reset_query
.RS
-Query send 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.
+Query send 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\.
.sp
-Good choice for 8.2 and below is:
+Good choice for 8\.2 and below is:
.sp
.sp
.RS 4
.fi
.RE
.sp
-for 8.3 and above its enough to do:
+for 8\.3 and above its enough to do:
.sp
.sp
.RS 4
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBserver_check_delay\fR
+server_check_delay
.RS
-How long to keep released immidiately available, without running sanity\-check query on it. If 0 then the query is ran always.
+How long to keep released immidiately available, without running sanity\-check query on it\. If 0 then the query is ran always\.
.sp
Default: 30
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBserver_check_query\fR
+server_check_query
.RS
-Simple do\-nothing query to check if server connection is alive.
+Simple do\-nothing query to check if server connection is alive\.
.sp
-If empty string, then sanity checking is disabled.
+If empty string, then sanity checking is disabled\.
.sp
Default: SELECT 1;
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBserver_lifetime\fR
+server_lifetime
.RS
-Pooler tries to close server connections that are been connected longer than this.
+Pooler tries to close server connections that are been connected longer than this\.
.sp
Default: 3600
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBserver_idle_timeout\fR
+server_idle_timeout
.RS
-If server connection has been idle more than this then there's too many connections in the pool and this one can be dropped.
+If server connection has been idle more than this then there\'s too many connections in the pool and this one can be dropped\.
.sp
Default: 600
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBserver_connect_timeout\fR
+server_connect_timeout
.RS
-If connection and login wont finish in this time, the connection will be closed.
+If connection and login wont finish in this time, the connection will be closed\.
.sp
Default: 15
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBserver_login_retry\fR
+server_login_retry
.RS
-If login failed, because of failure from connect() or authentication that pooler waits this much before retrying to connect.
+If login failed, because of failure from connect() or authentication that pooler waits this much before retrying to connect\.
.sp
Default: 15
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBclient_login_timeout\fR
+client_login_timeout
.RS
-If client connect but does not manage to login in this time, it will be disconnected. Mainly needed to avoid dead connections stalling SUSPEND and thus online restart.
+If client connect but does not manage to login in this time, it will be disconnected\. Mainly needed to avoid dead connections stalling SUSPEND and thus online restart\.
.sp
Default: 60
.sp
.RE
.SS "Dangerous timeouts"
-Setting following timeouts cause unexcpected errors.
+Setting following timeouts cause unexcpected errors\.
.sp
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBquery_timeout\fR
+query_timeout
.RS
-Queries running longer than that are canceled. This should be used only with slightly smaller server\-side statement_timeout, to apply only for network problems.
+Queries running longer than that are canceled\. This should be used only with slightly smaller server\-side statement_timeout, to apply only for network problems\.
.sp
Default: 0 (disabled)
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBclient_idle_timeout\fR
+client_idle_timeout
.RS
-Client connections idling longer than that are closed. This should be larger then client\-side connection lifetime settings, to apply only for network problems.
+Client connections idling longer than that are closed\. This should be larger then client\-side connection lifetime settings, to apply only for network problems\.
.sp
Default: 0 (disabled)
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBpkt_buf\fR
+pkt_buf
.RS
-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 large.
+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 large\.
.sp
Default: 2048
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBtcp_defer_accept\fR
+tcp_defer_accept
.RS
Details about following options shouldbe looked from man 7 tcp
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBtcp_socket_buffer\fR
+tcp_socket_buffer
.RS
Default: not set
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBtcp_keepalive\fR
+tcp_keepalive
.RS
Default: Not set
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBtcp_keepcnt\fR
+tcp_keepcnt
.RS
Default: not set
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBtcp_keepidle\fR
+tcp_keepidle
.RS
Default: not set
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBtcp_keepintvl\fR
+tcp_keepintvl
.RS
Default: not set
.sp
.RE
.SH "SECTION [DATABASES]"
-This contains key=value pairs where key will be taken as database name and value as libpq\-connstring style list of key=value pairs. As actual libpq is not used, so not all features from libpq can be used (service=, quoting).
+This contains key=value pairs where key will be taken as database name and value as libpq\-connstring style list of key=value pairs\. As actual libpq is not used, so not all features from libpq can be used (service=, quoting)\.
.sp
.SS "Location parameters"
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBdbname\fR
+dbname
.RS
-Destination database name.
+Destination database name\.
.sp
-Default: same as client\-side database name.
+Default: same as client\-side database name\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBhost\fR
+host
.RS
-IP\-address to connect to.
+IP\-address to connect to\.
.sp
-Default: not set, meaning to use unix\-socket.
+Default: not set, meaning to use unix\-socket\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBport\fR
+port
.RS
Default: 5432
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBuser, password\fR
+user, password
.RS
-If user= is set, all connections to destination database will be done with that user, meaning that there will be only one pool for this database.
+If user= is set, all connections to destination database will be done with that user, meaning that there will be only one pool for this database\.
.sp
-Otherwise pgbouncer tries to log into destination database with client username, meaning that there will be one pool per user.
+Otherwise pgbouncer tries to log into destination database with client username, meaning that there will be one pool per user\.
.sp
.RE
.SS "Per\-database pool Size"
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBpool_size\fR
+pool_size
.RS
-Set maximum size of pools for this database. If not set, the default_pool_size is used.
+Set maximum size of pools for this database\. If not set, the default_pool_size is used\.
.sp
.RE
.SS "Extra parameters"
-They allow setting default parameters on server connection.
+They allow setting default parameters on server connection\.
.sp
-Note that since version 1.1 PgBouncer tracks client changes for their values, so their use in pgbouncer.ini is deprecated now.
+Note that since version 1\.1 PgBouncer tracks client changes for their values, so their use in pgbouncer\.ini is deprecated now\.
.sp
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBclient_encoding\fR
+client_encoding
.RS
-Ask specific client_encoding from server.
+Ask specific client_encoding from server\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBdatestyle\fR
+datestyle
.RS
-Ask specific datestyle from server.
+Ask specific datestyle from server\.
.sp
.RE
.sp
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBtimezone\fR
+timezone
.RS
-Ask specific timezone from server.
+Ask specific timezone from server\.
.sp
.RE
.SH "EXAMPLE"
.RS 4
.nf
[databases]
-template1 = host=127.0.0.1 dbname=template1
+template1 = host=127\.0\.0\.1 dbname=template1
.fi
.RE
.sp
[pgbouncer]
pool_mode = session
listen_port = 6543
-listen_addr = 127.0.0.1
+listen_addr = 127\.0\.0\.1
auth_type = md5
-auth_file = users.txt
-logfile = pgbouncer.log
-pidfile = pgbouncer.pid
+auth_file = users\.txt
+logfile = pgbouncer\.log
+pidfile = pgbouncer\.pid
admin_users = someuser
stats_users = stat_collector
.fi
.RS 4
.nf
; redirect bardb to bazdb on localhost
-bardb = host=127.0.0.1 dbname=bazdb
+bardb = host=127\.0\.0\.1 dbname=bazdb
.fi
.RE
.sp
.RS 4
.nf
; acceess to dest database will go with single user
-forcedb = host=127.0.0.1 port=300 user=baz password=foo client_encoding=UNICODE datestyle=ISO
+forcedb = host=127\.0\.0\.1 port=300 user=baz password=foo client_encoding=UNICODE datestyle=ISO
.fi
.RE
.SH "SEE ALSO"
pgbouncer(1)
.sp
-\fIhttps://developer.skype.com/SkypeGarage/DbProjects/PgBouncer\fR
+\fIhttps://developer\.skype\.com/SkypeGarage/DbProjects/PgBouncer\fR
.sp
projects / pgbouncer.git / commitdiff