php-doc-en/reference/pgsql/functions/pg-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry xml:id="function.pg-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_connect</refname>
  <refpurpose>Open a PostgreSQL connection</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>pg_connect</methodname>
   <methodparam><type>string</type><parameter>connection_string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>connect_type</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_connect</function> opens a connection to a
   PostgreSQL database specified by the
   <parameter>connection_string</parameter>.
  </para>
  <para>
   If a second call is made to <function>pg_connect</function> with
   the same <parameter>connection_string</parameter> as an existing connection, the
   existing connection will be returned unless you pass
   <constant>PGSQL_CONNECT_FORCE_NEW</constant> as
   <parameter>connect_type</parameter>.
  </para>
  <para>
   The old syntax with multiple parameters
   <command>$conn = pg_connect("host", "port", "options", "tty", "dbname")
   </command> has been deprecated.
  </para>
 </refsect1>

<refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection_string</parameter></term>
     <listitem>
      <para>
       The <parameter>connection_string</parameter> can be empty to use all default parameters, or it 
       can contain one or more parameter settings separated by whitespace. 
       Each parameter setting is in the form <literal>keyword = value</literal>. Spaces around 
       the equal sign are optional. To write an empty value or a value 
       containing spaces, surround it with single quotes, e.g., <literal>keyword = 
       'a value'</literal>. Single quotes and backslashes within the value must be 
       escaped with a backslash, i.e., \' and \\.  
      </para>
      <para>
       The currently recognized parameter keywords are:
       <parameter>host</parameter>, <parameter>hostaddr</parameter>, <parameter>port</parameter>,
       <parameter>dbname</parameter> (defaults to value of <parameter>user</parameter>),
       <parameter>user</parameter>,
       <parameter>password</parameter>, <parameter>connect_timeout</parameter>,
       <parameter>options</parameter>, <parameter>tty</parameter> (ignored), <parameter>sslmode</parameter>,
       <parameter>requiressl</parameter> (deprecated in favor of <parameter>sslmode</parameter>), and
       <parameter>service</parameter>.  Which of these arguments exist depends
       on your PostgreSQL version.
      </para>
      <para>
       The <parameter>options</parameter> parameter can be used to set command line parameters 
       to be invoked by the server.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>connect_type</parameter></term>
     <listitem>
      <para>
       If <constant>PGSQL_CONNECT_FORCE_NEW</constant> is passed, then a new connection
       is created, even if the <parameter>connection_string</parameter> is identical to
       an existing connection.
      </para>
      <para>
       If <constant>PGSQL_CONNECT_ASYNC</constant> is given, then the
       connection is established asynchronously. The state of the connection
       can then be checked via <function>pg_connect_poll</function> or
       <function>pg_connection_status</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   PostgreSQL connection resource on success, &false; on failure.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.6.0</entry>
       <entry>
        Support for giving the <constant>PGSQL_CONNECT_ASYNC</constant>
        constant as the <parameter>connect_type</parameter> was added.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>pg_connect</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=mary");
//connect to a database named "mary"

$dbconn2 = pg_connect("host=localhost port=5432 dbname=mary");
// connect to a database named "mary" on "localhost" at port "5432"

$dbconn3 = pg_connect("host=sheep port=5432 dbname=mary user=lamb password=foo");
//connect to a database named "mary" on the host "sheep" with a username and password

$conn_string = "host=sheep port=5432 dbname=test user=lamb password=bar";
$dbconn4 = pg_connect($conn_string);
//connect to a database named "test" on the host "sheep" with a username and password

$dbconn5 = pg_connect("host=localhost options='--client_encoding=UTF8'");
//connect to a database on "localhost" and set the command line parameter which tells the encoding is in UTF-8
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_pconnect</function></member>
    <member><function>pg_close</function></member>
    <member><function>pg_host</function></member>
    <member><function>pg_port</function></member>
    <member><function>pg_tty</function></member>
    <member><function>pg_options</function></member>
    <member><function>pg_dbname</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->