Skip to content

Commit

Permalink
pg_pconnect(): Various minor fixes (#4429)
Browse files Browse the repository at this point in the history
- Typos
- Add various literal tags
- Remove personalization
  • Loading branch information
pereorga authored Feb 6, 2025
1 parent 65c5581 commit 3b2503b
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions reference/pgsql/functions/pg-pconnect.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</methodsynopsis>
<para>
<function>pg_pconnect</function> opens a connection to a
PostgreSQL database. It returns an <classname>PgSql\Connection</classname> instance that is
PostgreSQL database. It returns a <classname>PgSql\Connection</classname> instance that is
needed by other PostgreSQL functions.
</para>
<para>
Expand All @@ -27,11 +27,14 @@
<parameter>flags</parameter>.
</para>
<para>
To enable persistent connection, the <link linkend="ini.pgsql.allow-persistent">pgsql.allow_persistent</link>
&php.ini; directive must be set to &quot;On&quot; (which is the default).
The maximum number of persistent connection can be defined with the <link linkend="ini.pgsql.max-persistent">pgsql.max_persistent</link>
&php.ini; directive (defaults to -1 for no limit). The total number
of connections can be set with the <link linkend="ini.pgsql.max-links">pgsql.max_links</link>
To enable persistent connections, the
<link linkend="ini.pgsql.allow-persistent">pgsql.allow_persistent</link>
&php.ini; directive must be set to <literal>"On"</literal> (which is the default).
The maximum number of persistent connections can be defined with the
<link linkend="ini.pgsql.max-persistent">pgsql.max_persistent</link>
&php.ini; directive (defaults to <literal>-1</literal> for no limit).
The total number of connections can be set with the
<link linkend="ini.pgsql.max-links">pgsql.max_links</link>
&php.ini; directive.
</para>
<para>
Expand All @@ -54,7 +57,7 @@
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 \\.
escaped with a backslash, i.e., <literal>\'</literal> and <literal>\\</literal>.
</para>
<para>
The currently recognized parameter keywords are:
Expand All @@ -63,8 +66,8 @@
<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.
<parameter>service</parameter>.
Which of these arguments exist depends on the PostgreSQL version.
</para>
</listitem>
</varlistentry>
Expand All @@ -85,7 +88,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <classname>PgSql\Connection</classname> instance on success, &return.falseforfailure;.
Returns a <classname>PgSql\Connection</classname> instance on success, &return.falseforfailure;.
</para>
</refsect1>

Expand All @@ -103,7 +106,7 @@
<row>
<entry>8.1.0</entry>
<entry>
Returns an <classname>PgSql\Connection</classname> instance now;
Returns a <classname>PgSql\Connection</classname> instance now;
previously, a &resource; was returned.
</entry>
</row>
Expand All @@ -120,18 +123,18 @@
<programlisting role="php">
<![CDATA[
<?php
// Connect to a database named "mary"
$dbconn = pg_pconnect("dbname=mary");
//connect to a database named "mary"
// Connect to a database named "mary" on "localhost" at port "5432"
$dbconn2 = pg_pconnect("host=localhost port=5432 dbname=mary");
// connect to a database named "mary" on "localhost" at port "5432"
// Connect to a database named "mary" on the host "sheep" with a username and password
$dbconn3 = pg_pconnect("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
// Connect to a database named "test" on the host "sheep" with a username and password
$conn_string = "host=sheep port=5432 dbname=test user=lamb password=bar";
$dbconn4 = pg_pconnect($conn_string);
//connect to a database named "test" on the host "sheep" with a username and password
?>
]]>
</programlisting>
Expand Down

0 comments on commit 3b2503b

Please sign in to comment.