Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > bab02a23fa9f3df8d66a9a3231b50245 > files > 342

postgresql8.3-docs-8.3.6-2mdv2008.1.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Environment Variables</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 8.3.6 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="libpq - C Library"
HREF="libpq.html"><LINK
REL="PREVIOUS"
TITLE="Notice Processing"
HREF="libpq-notice-processing.html"><LINK
REL="NEXT"
TITLE="The Password File"
HREF="libpq-pgpass.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2009-02-03T04:34:16"></HEAD
><BODY
CLASS="SECT1"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
>PostgreSQL 8.3.6 Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="libpq-notice-processing.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="libpq.html"
>Fast Backward</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
>Chapter 30. <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> - C Library</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="top"
><A
HREF="libpq.html"
>Fast Forward</A
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="top"
><A
HREF="libpq-pgpass.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="LIBPQ-ENVARS"
>30.12. Environment Variables</A
></H1
><A
NAME="AEN32530"
></A
><P
>   The following environment variables can be used to select default
   connection parameter values, which will be used by
   <CODE
CLASS="FUNCTION"
>PQconnectdb</CODE
>, <CODE
CLASS="FUNCTION"
>PQsetdbLogin</CODE
> and
   <CODE
CLASS="FUNCTION"
>PQsetdb</CODE
> 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
></P
></P><UL
><LI
><P
>      <A
NAME="AEN32539"
></A
>
      <TT
CLASS="ENVAR"
>PGHOST</TT
> sets the database server name.
      If this begins with a slash, it specifies Unix-domain communication
      rather than TCP/IP communication; the value is then the name of the
      directory in which the socket file is stored (in a default installation
      setup this would be <TT
CLASS="FILENAME"
>/tmp</TT
>).
     </P
></LI
><LI
><P
>      <A
NAME="AEN32546"
></A
>
      <TT
CLASS="ENVAR"
>PGHOSTADDR</TT
> specifies the numeric IP address of the database
      server.  This can be set instead of or in addition to <TT
CLASS="ENVAR"
>PGHOST</TT
>
      to avoid DNS lookup overhead. See the documentation of
      these parameters, under <CODE
CLASS="FUNCTION"
>PQconnectdb</CODE
> above, for details
      on their interaction.
     </P
><P
>      When neither <TT
CLASS="ENVAR"
>PGHOST</TT
> nor <TT
CLASS="ENVAR"
>PGHOSTADDR</TT
> is set,
      the default behavior is to connect using a local Unix-domain socket; or on
      machines without Unix-domain sockets, <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> will
      attempt to connect to <TT
CLASS="LITERAL"
>localhost</TT
>.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32559"
></A
>
      <TT
CLASS="ENVAR"
>PGPORT</TT
> sets the TCP port number or Unix-domain socket
      file extension for communicating with the
      <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> server.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32566"
></A
>
      <TT
CLASS="ENVAR"
>PGDATABASE</TT
>  sets the
      <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> database name.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32573"
></A
>
      <TT
CLASS="ENVAR"
>PGUSER</TT
> sets the user name used to connect to the
      database.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32579"
></A
>
      <TT
CLASS="ENVAR"
>PGPASSWORD</TT
> sets the password used if the server
      demands password authentication.  Use of this environment variable
      is not recommended for security reasons (some operating systems
      allow non-root users to see process environment variables via
      <SPAN
CLASS="APPLICATION"
>ps</SPAN
>); instead consider using  the
      <TT
CLASS="FILENAME"
>~/.pgpass</TT
> file (see <A
HREF="libpq-pgpass.html"
>Section 30.13</A
>).
     </P
></LI
><LI
><P
>      <A
NAME="AEN32588"
></A
>
      <TT
CLASS="ENVAR"
>PGPASSFILE</TT
> specifies the name of the password file to
      use for lookups.  If not set, it defaults to <TT
CLASS="FILENAME"
>~/.pgpass</TT
>
      (see <A
HREF="libpq-pgpass.html"
>Section 30.13</A
>).
     </P
></LI
><LI
><P
>      <A
NAME="AEN32596"
></A
>
      <TT
CLASS="ENVAR"
>PGSERVICE</TT
>
      sets the service name to be looked up in
      <TT
CLASS="FILENAME"
>pg_service.conf</TT
>.  This offers a shorthand way
      of setting all the parameters.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32603"
></A
>
      <TT
CLASS="ENVAR"
>PGREALM</TT
> sets the Kerberos realm to  use  with
      <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
>, if  it is different from the
      local realm.  If <TT
CLASS="ENVAR"
>PGREALM</TT
> is set,
      <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> applications  will  attempt
      authentication  with  servers for this realm and use separate ticket
      files to avoid conflicts with  local ticket  files.   This
      environment  variable is only used if Kerberos authentication is
      selected by the server.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32612"
></A
>
      <TT
CLASS="ENVAR"
>PGOPTIONS</TT
> sets additional run-time  options  for the
      <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> server.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32619"
></A
>
      <TT
CLASS="ENVAR"
>PGSSLMODE</TT
> determines whether and with what priority
      an <ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
> connection will be negotiated with the server.
      There are four modes: <TT
CLASS="LITERAL"
>disable</TT
> will attempt only an
      unencrypted <ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
> connection; <TT
CLASS="LITERAL"
>allow</TT
> will
      negotiate, trying first a non-<ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
> connection, then if
      that fails, trying an <ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
> connection; <TT
CLASS="LITERAL"
>prefer</TT
>
      (the default) will negotiate, trying first an <ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
>
      connection, then if that fails, trying a regular non-<ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
>
      connection; <TT
CLASS="LITERAL"
>require</TT
> will try only an <ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
>
      connection. If <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> is compiled without SSL
      support, using option <TT
CLASS="LITERAL"
>require</TT
> will cause an error, while
      options <TT
CLASS="LITERAL"
>allow</TT
> and <TT
CLASS="LITERAL"
>prefer</TT
> will be accepted
      but <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> will not in fact attempt an <ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
>
      connection.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32642"
></A
>
      <TT
CLASS="ENVAR"
>PGREQUIRESSL</TT
> sets whether or not the connection must
      be made over <ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
>. If set to <SPAN
CLASS="QUOTE"
>"1"</SPAN
>,
      <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> will refuse to connect if the server does not
      accept an <ACRONYM
CLASS="ACRONYM"
>SSL</ACRONYM
> connection (equivalent to
      <TT
CLASS="LITERAL"
>sslmode</TT
> <TT
CLASS="LITERAL"
>prefer</TT
>).  This option is deprecated
      in favor of the <TT
CLASS="LITERAL"
>sslmode</TT
> setting, and is only available
      if <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> is compiled with SSL support.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32656"
></A
>
      <TT
CLASS="ENVAR"
>PGSSLKEY</TT
> specifies the hardware token that stores the
      secret key for the client certificate. The value of this variable
      should consist of a colon-separated engine name (engines are
      <SPAN
CLASS="PRODUCTNAME"
>OpenSSL</SPAN
> loadable modules) and an engine-specific key
      identifier.  If this is not set, the secret key must be kept in a
      file.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32663"
></A
>
      <TT
CLASS="ENVAR"
>PGKRBSRVNAME</TT
> sets the Kerberos service name to use
      when authenticating with Kerberos 5 or GSSAPI.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32669"
></A
>
      <TT
CLASS="ENVAR"
>PGGSSLIB</TT
> sets the GSS library to use for GSSAPI
      authentication.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32675"
></A
>
      <TT
CLASS="ENVAR"
>PGCONNECT_TIMEOUT</TT
> sets the maximum number of seconds
      that <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> will wait when attempting to
      connect to the <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> server.  If
      unset or set to zero, <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> will wait
      indefinitely.  It is not recommended to set the timeout to less than
      2 seconds.
     </P
></LI
></UL
><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
HREF="sql-alteruser.html"
><I
>ALTER USER</I
></A
>
   and <A
HREF="sql-alterdatabase.html"
><I
>ALTER DATABASE</I
></A
>
   commands for ways to set default behavior on a per-user or per-database
   basis.)

   <P
></P
></P><UL
><LI
><P
>      <A
NAME="AEN32689"
></A
>
      <TT
CLASS="ENVAR"
>PGDATESTYLE</TT
> sets the default style of date/time
      representation.  (Equivalent to <TT
CLASS="LITERAL"
>SET datestyle TO
      ...</TT
>.)
     </P
></LI
><LI
><P
>      <A
NAME="AEN32696"
></A
>
      <TT
CLASS="ENVAR"
>PGTZ</TT
> sets the default time zone.  (Equivalent to
      <TT
CLASS="LITERAL"
>SET timezone TO ...</TT
>.)
     </P
></LI
><LI
><P
>      <A
NAME="AEN32703"
></A
>
      <TT
CLASS="ENVAR"
>PGCLIENTENCODING</TT
> sets the default client character
      set encoding.  (Equivalent to <TT
CLASS="LITERAL"
>SET client_encoding TO
      ...</TT
>.)
     </P
></LI
><LI
><P
>      <A
NAME="AEN32710"
></A
>
      <TT
CLASS="ENVAR"
>PGGEQO</TT
> sets the default mode for the genetic query
      optimizer.  (Equivalent to <TT
CLASS="LITERAL"
>SET geqo TO ...</TT
>.)
     </P
></LI
></UL
><P>

   Refer to the <ACRONYM
CLASS="ACRONYM"
>SQL</ACRONYM
> command <A
HREF="sql-set.html"
><I
>SET</I
></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
></P
></P><UL
><LI
><P
>      <A
NAME="AEN32722"
></A
>
      <TT
CLASS="ENVAR"
>PGSYSCONFDIR</TT
> sets the directory containing the
      <TT
CLASS="FILENAME"
>pg_service.conf</TT
> file.
     </P
></LI
><LI
><P
>      <A
NAME="AEN32729"
></A
>
      <TT
CLASS="ENVAR"
>PGLOCALEDIR</TT
> sets the directory containing the
      <TT
CLASS="LITERAL"
>locale</TT
> files for message internationalization.
     </P
></LI
></UL
><P>
  </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="libpq-notice-processing.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="libpq-pgpass.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Notice Processing</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="libpq.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>The Password File</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional