pg-pconnect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: jvenegasperu Status: ready -->
<!-- Reviewed: no -->

<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry xml:id="function.pg-pconnect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_pconnect</refname>
  <refpurpose>Abre una conexión persistente a PostgreSQL</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>pg_pconnect</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_pconnect</function> Abre una conexión con una base de datos PostgreSQL. Devuelve un recurso de conexión que es necesario por otras funciones para PostgreSQL.
  </para>
  <para>
   Si se hace una segunda llamada a la función <function>pg_pconnect</function>
   con la misma <parameter>connection_string</parameter> y hay una conexión existente,
   la conexión existente será devuelta a menos que pase la constante <constant>PGSQL_CONNECT_FORCE_NEW</constant>
   como <parameter>connect_type</parameter>.
  </para>
  <para>
   Para habilitar la conexión persistente,
   la directiva de &php.ini; <link linkend="ini.pgsql.allow-persistent">pgsql.allow_persistent
   </link> se debe establecer en &quot;On&quot; (que es el predeterminado).
   El número máximo de conexiones persistentes se pueden definir con la directiva de &php.ini;
   <link linkend="ini.pgsql.max-persistent">pgsql.max_persistent</link>
   (por defecto es -1 para sin límite). El número total de conexiones se pueden establecer con la directiva de 
   &php.ini; <link linkend="ini.pgsql.max-links">pgsql.max_links</link>.
  </para>
  <para>
   <function>pg_close</function> no cerrará enlaces persistentes
    generados por <function>pg_pconnect</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection_string</parameter></term>
     <listitem>
      <para>
       El parametro <parameter>connection_string</parameter> puede estar vacío para usar todos los parámetros por defecto, o puede contener uno o más parámetros separados por espacios en blanco.
Cada ajuste de parámetros se encuentra en la forma <literal>keyword = value</literal>. Los espacios alrededor del signo igual son opcionales. Para escribir un valor vacío o un valor que contiene espacios, hay que encerrarlo entre comillas simples, por ejemplo, <literal>keyword = 'a value'</literal>. Las comillas simples y barras invertidas en el valor se pueden colocar utilizando el caracter de escapado barra invertida, es decir, \'y \\.       
      </para>
      <para>
       Las palabras clave reconocidas actualmente como parámetros son:       
       <parameter>host</parameter>, <parameter>hostaddr</parameter>, <parameter>port</parameter>,
       <parameter>dbname</parameter>, <parameter>user</parameter>,
       <parameter>password</parameter>, <parameter>connect_timeout</parameter>,
       <parameter>options</parameter>, <parameter>tty</parameter> (ignored), <parameter>sslmode</parameter>,
       <parameter>requiressl</parameter> (obsoleto a favor de <parameter>sslmode</parameter>), y
       <parameter>service</parameter>. Cada uno de estos argumentos existen dependiendo
        de su versión de PostgreSQL.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>connect_type</parameter></term>
     <listitem>
      <para>
       Si <constant>PGSQL_CONNECT_FORCE_NEW</constant> es pasado, entonces una nueva conexión
       es creada, inclusive si la <parameter>connection_string</parameter> es idéntica a la de la conexión existente.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Recurso de conexión PostgreSQL en caso de éxito, &false; en caso de fallo.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Usando <function>pg_pconnect</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_pconnect("dbname=mary");
//conectar a la base de datos llamada "mary"

$dbconn2 = pg_pconnect("host=localhost port=5432 dbname=mary");
// conectar a la base de datos llamada "mary" en "localhost" en el puerto "5432"

$dbconn3 = pg_pconnect("host=sheep port=5432 dbname=mary user=lamb password=foo");
//conectar a la base de datos llamada "mary" en el host "sheep" con usuario y password

$conn_string = "host=sheep port=5432 dbname=test user=lamb password=bar";
$dbconn4 = pg_pconnect($conn_string);
//conectar a la base de datos llamada "test" en el host "sheep" con usuario y password
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_connect</function></member>
    <member>
     <link linkend="features.persistent-connections">
     Conexiones Persistentes a Bases de Datos</link>
    </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
-->