blob: 9c300a18c2134963aae9a83104f5868c1feed5d9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>34.15. Environment Variables</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="libpq-events.html" title="34.14. Event System" /><link rel="next" href="libpq-pgpass.html" title="34.16. The Password File" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">34.15. Environment Variables</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="libpq-events.html" title="34.14. Event System">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="libpq.html" title="Chapter 34. libpq — C Library">Up</a></td><th width="60%" align="center">Chapter 34. <span class="application">libpq</span> — C Library</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="libpq-pgpass.html" title="34.16. The Password File">Next</a></td></tr></table><hr /></div><div class="sect1" id="LIBPQ-ENVARS"><div class="titlepage"><div><div><h2 class="title" style="clear: both">34.15. Environment Variables <a href="#LIBPQ-ENVARS" class="id_link">#</a></h2></div></div></div><a id="id-1.7.3.22.2" class="indexterm"></a><p>
The following environment variables can be used to select default
connection parameter values, which will be used by
<a class="xref" href="libpq-connect.html#LIBPQ-PQCONNECTDB"><code class="function">PQconnectdb</code></a>, <a class="xref" href="libpq-connect.html#LIBPQ-PQSETDBLOGIN"><code class="function">PQsetdbLogin</code></a> and
<a class="xref" href="libpq-connect.html#LIBPQ-PQSETDB"><code class="function">PQsetdb</code></a> if no value is directly specified by the calling
code. These are useful to avoid hard-coding database connection
information into simple client applications, for example.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.1.1.1" class="indexterm"></a>
<code class="envar">PGHOST</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-HOST">host</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.2.1.1" class="indexterm"></a>
<code class="envar">PGHOSTADDR</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-HOSTADDR">hostaddr</a> connection parameter.
This can be set instead of or in addition to <code class="envar">PGHOST</code>
to avoid DNS lookup overhead.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.3.1.1" class="indexterm"></a>
<code class="envar">PGPORT</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-PORT">port</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.4.1.1" class="indexterm"></a>
<code class="envar">PGDATABASE</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-DBNAME">dbname</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.5.1.1" class="indexterm"></a>
<code class="envar">PGUSER</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-USER">user</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.6.1.1" class="indexterm"></a>
<code class="envar">PGPASSWORD</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-PASSWORD">password</a> connection parameter.
Use of this environment variable
is not recommended for security reasons, as some operating systems
allow non-root users to see process environment variables via
<span class="application">ps</span>; instead consider using a password file
(see <a class="xref" href="libpq-pgpass.html" title="34.16. The Password File">Section 34.16</a>).
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.7.1.1" class="indexterm"></a>
<code class="envar">PGPASSFILE</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-PASSFILE">passfile</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.8.1.1" class="indexterm"></a>
<code class="envar">PGREQUIREAUTH</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-REQUIRE-AUTH">require_auth</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.9.1.1" class="indexterm"></a>
<code class="envar">PGCHANNELBINDING</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-CHANNEL-BINDING">channel_binding</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.10.1.1" class="indexterm"></a>
<code class="envar">PGSERVICE</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SERVICE">service</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.11.1.1" class="indexterm"></a>
<code class="envar">PGSERVICEFILE</code> specifies the name of the per-user
connection service file
(see <a class="xref" href="libpq-pgservice.html" title="34.17. The Connection Service File">Section 34.17</a>).
Defaults to <code class="filename">~/.pg_service.conf</code>, or
<code class="filename">%APPDATA%\postgresql\.pg_service.conf</code> on
Microsoft Windows.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.12.1.1" class="indexterm"></a>
<code class="envar">PGOPTIONS</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-OPTIONS">options</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.13.1.1" class="indexterm"></a>
<code class="envar">PGAPPNAME</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-APPLICATION-NAME">application_name</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.14.1.1" class="indexterm"></a>
<code class="envar">PGSSLMODE</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLMODE">sslmode</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.15.1.1" class="indexterm"></a>
<code class="envar">PGREQUIRESSL</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-REQUIRESSL">requiressl</a> connection parameter.
This environment variable is deprecated in favor of the
<code class="envar">PGSSLMODE</code> variable; setting both variables suppresses the
effect of this one.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.16.1.1" class="indexterm"></a>
<code class="envar">PGSSLCOMPRESSION</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLCOMPRESSION">sslcompression</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.17.1.1" class="indexterm"></a>
<code class="envar">PGSSLCERT</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLCERT">sslcert</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.18.1.1" class="indexterm"></a>
<code class="envar">PGSSLKEY</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLKEY">sslkey</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.19.1.1" class="indexterm"></a>
<code class="envar">PGSSLCERTMODE</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLCERTMODE">sslcertmode</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.20.1.1" class="indexterm"></a>
<code class="envar">PGSSLROOTCERT</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLROOTCERT">sslrootcert</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.21.1.1" class="indexterm"></a>
<code class="envar">PGSSLCRL</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLCRL">sslcrl</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.22.1.1" class="indexterm"></a>
<code class="envar">PGSSLCRLDIR</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLCRLDIR">sslcrldir</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.23.1.1" class="indexterm"></a>
<code class="envar">PGSSLSNI</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSLSNI">sslsni</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.24.1.1" class="indexterm"></a>
<code class="envar">PGREQUIREPEER</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-REQUIREPEER">requirepeer</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.25.1.1" class="indexterm"></a>
<code class="envar">PGSSLMINPROTOCOLVERSION</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSL-MIN-PROTOCOL-VERSION">ssl_min_protocol_version</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.26.1.1" class="indexterm"></a>
<code class="envar">PGSSLMAXPROTOCOLVERSION</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-SSL-MAX-PROTOCOL-VERSION">ssl_max_protocol_version</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.27.1.1" class="indexterm"></a>
<code class="envar">PGGSSENCMODE</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-GSSENCMODE">gssencmode</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.28.1.1" class="indexterm"></a>
<code class="envar">PGKRBSRVNAME</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-KRBSRVNAME">krbsrvname</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.29.1.1" class="indexterm"></a>
<code class="envar">PGGSSLIB</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-GSSLIB">gsslib</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.30.1.1" class="indexterm"></a>
<code class="envar">PGGSSDELEGATION</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-GSSDELEGATION">gssdelegation</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.31.1.1" class="indexterm"></a>
<code class="envar">PGCONNECT_TIMEOUT</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-CONNECT-TIMEOUT">connect_timeout</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.32.1.1" class="indexterm"></a>
<code class="envar">PGCLIENTENCODING</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-CLIENT-ENCODING">client_encoding</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.33.1.1" class="indexterm"></a>
<code class="envar">PGTARGETSESSIONATTRS</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-TARGET-SESSION-ATTRS">target_session_attrs</a> connection parameter.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.3.4.34.1.1" class="indexterm"></a>
<code class="envar">PGLOADBALANCEHOSTS</code> behaves the same as the <a class="xref" href="libpq-connect.html#LIBPQ-CONNECT-LOAD-BALANCE-HOSTS">load_balance_hosts</a> connection parameter.
</p></li></ul></div><p>
</p><p>
The following environment variables can be used to specify default
behavior for each <span class="productname">PostgreSQL</span> session. (See
also the <a class="xref" href="sql-alterrole.html" title="ALTER ROLE"><span class="refentrytitle">ALTER ROLE</span></a>
and <a class="xref" href="sql-alterdatabase.html" title="ALTER DATABASE"><span class="refentrytitle">ALTER DATABASE</span></a>
commands for ways to set default behavior on a per-user or per-database
basis.)
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<a id="id-1.7.3.22.4.4.1.1.1" class="indexterm"></a>
<code class="envar">PGDATESTYLE</code> sets the default style of date/time
representation. (Equivalent to <code class="literal">SET datestyle TO
...</code>.)
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.4.4.2.1.1" class="indexterm"></a>
<code class="envar">PGTZ</code> sets the default time zone. (Equivalent to
<code class="literal">SET timezone TO ...</code>.)
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.4.4.3.1.1" class="indexterm"></a>
<code class="envar">PGGEQO</code> sets the default mode for the genetic query
optimizer. (Equivalent to <code class="literal">SET geqo TO ...</code>.)
</p></li></ul></div><p>
Refer to the <acronym class="acronym">SQL</acronym> command <a class="xref" href="sql-set.html" title="SET"><span class="refentrytitle">SET</span></a>
for information on correct values for these
environment variables.
</p><p>
The following environment variables determine internal behavior of
<span class="application">libpq</span>; they override compiled-in defaults.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<a id="id-1.7.3.22.5.2.1.1.1" class="indexterm"></a>
<code class="envar">PGSYSCONFDIR</code> sets the directory containing the
<code class="filename">pg_service.conf</code> file and in a future version
possibly other system-wide configuration files.
</p></li><li class="listitem"><p>
<a id="id-1.7.3.22.5.2.2.1.1" class="indexterm"></a>
<code class="envar">PGLOCALEDIR</code> sets the directory containing the
<code class="literal">locale</code> files for message localization.
</p></li></ul></div><p>
</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="libpq-events.html" title="34.14. Event System">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="libpq.html" title="Chapter 34. libpq — C Library">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="libpq-pgpass.html" title="34.16. The Password File">Next</a></td></tr><tr><td width="40%" align="left" valign="top">34.14. Event System </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 34.16. The Password File</td></tr></table></div></body></html>
|
