<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>pg_connect</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 7.4.1 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="pgtcl Command Reference"
HREF="libpgtcl-ref.html"><LINK
REL="PREVIOUS"
TITLE="pgtcl Command Reference"
HREF="libpgtcl-ref.html"><LINK
REL="NEXT"
TITLE="pg_disconnect"
HREF="pgtcl-pgdisconnect.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
NAME="creation"
CONTENT="2003-12-22T03:48:47"></HEAD
><BODY
CLASS="REFENTRY"
><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 7.4.1 Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="libpgtcl-ref.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="libpgtcl-ref.html#LIBPGTCL-REF"
>Fast Backward</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="top"
><A
HREF="pgtcl-pgdisconnect.html"
>Fast Forward</A
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="top"
><A
HREF="pgtcl-pgdisconnect.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="PGTCL-PGCONNECT"
></A
>pg_connect</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN22330"
></A
><H2
>Name</H2
>pg_connect -- open a connection to the server<A
NAME="IX-PGTCL-PGCONNECT-2"
></A
></DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN22335"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>pg_connect -conninfo <VAR
CLASS="PARAMETER"
>connectOptions</VAR
>
pg_connect <VAR
CLASS="PARAMETER"
>dbName</VAR
> ?<SPAN
CLASS="OPTIONAL"
>-host <VAR
CLASS="PARAMETER"
>hostName</VAR
></SPAN
>? ?<SPAN
CLASS="OPTIONAL"
>-port <VAR
CLASS="PARAMETER"
>portNumber</VAR
></SPAN
>? ?<SPAN
CLASS="OPTIONAL"
>-tty <VAR
CLASS="PARAMETER"
>tty</VAR
></SPAN
>? ?<SPAN
CLASS="OPTIONAL"
>-options <VAR
CLASS="PARAMETER"
>serverOptions</VAR
></SPAN
>?</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN22347"
></A
><H2
>Description</H2
><P
> <CODE
CLASS="FUNCTION"
>pg_connect</CODE
> opens a connection to the
<SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> server.
</P
><P
> Two syntaxes are available. In the older one, each possible option
has a separate option switch in the <TT
CLASS="COMMAND"
>pg_connect</TT
>
command. In the newer form, a single option string is supplied
that can contain multiple option values.
<CODE
CLASS="FUNCTION"
>pg_conndefaults</CODE
> can be used to retrieve
information about the available options in the newer syntax.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN22355"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><P
><B
>New style</B
></P
><DL
><DT
><VAR
CLASS="PARAMETER"
>connectOptions</VAR
></DT
><DD
><P
> A string of connection options, each written in the form
<TT
CLASS="LITERAL"
>keyword = value</TT
>. A list of valid options can be
found in the description of the <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> function
<CODE
CLASS="FUNCTION"
>PQconnectdb</CODE
>.
</P
></DD
></DL
></DIV
><P
></P
><DIV
CLASS="VARIABLELIST"
><P
><B
>Old style</B
></P
><DL
><DT
><VAR
CLASS="PARAMETER"
>dbName</VAR
></DT
><DD
><P
> The name of the database to connect to.
</P
></DD
><DT
><VAR
CLASS="OPTION"
>-host <VAR
CLASS="PARAMETER"
>hostName</VAR
></VAR
></DT
><DD
><P
> The host name of the database server to connect to.
</P
></DD
><DT
><VAR
CLASS="OPTION"
>-port <VAR
CLASS="PARAMETER"
>portNumber</VAR
></VAR
></DT
><DD
><P
> The TCP port number of the database server to connect to.
</P
></DD
><DT
><VAR
CLASS="OPTION"
>-tty <VAR
CLASS="PARAMETER"
>tty</VAR
></VAR
></DT
><DD
><P
> A file or <ACRONYM
CLASS="ACRONYM"
>TTY</ACRONYM
> for optional debug output from
the server.
</P
></DD
><DT
><VAR
CLASS="OPTION"
>-options <VAR
CLASS="PARAMETER"
>serverOptions</VAR
></VAR
></DT
><DD
><P
> Additional configuration options to pass to the server.
</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN22399"
></A
><H2
>Return Value</H2
><P
> If successful, a handle for a database connection is returned.
Handles start with the prefix <TT
CLASS="LITERAL"
>pgsql</TT
>.
</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="libpgtcl-ref.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="pgtcl-pgdisconnect.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><SPAN
CLASS="APPLICATION"
>pgtcl</SPAN
> Command Reference</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="libpgtcl-ref.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>pg_disconnect</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
