<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Open a persistent PostgreSQL connection</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.pg-parameter-status.html">pg_parameter_status</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.pg-ping.html">pg_ping</a></div> <div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.pg-pconnect" class="refentry"> <div class="refnamediv"> <h1 class="refname">pg_pconnect</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">pg_pconnect</span> — <span class="dc-title">Open a persistent PostgreSQL connection</span></p> </div> <div class="refsect1 description" id="refsect1-function.pg-pconnect-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">resource</span> <span class="methodname"><strong>pg_pconnect</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$connection_string</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$connect_type</code></span> ] )</div> <p class="para rdfs-comment"> <span class="function"><strong>pg_pconnect()</strong></span> opens a connection to a PostgreSQL database. It returns a connection resource that is needed by other PostgreSQL functions. </p> <p class="para"> If a second call is made to <span class="function"><strong>pg_pconnect()</strong></span> with the same <em><code class="parameter">connection_string</code></em> as an existing connection, the existing connection will be returned unless you pass <strong><code>PGSQL_CONNECT_FORCE_NEW</code></strong> as <em><code class="parameter">connect_type</code></em>. </p> <p class="para"> To enable persistent connection, the <a href="pgsql.configuration.html#ini.pgsql.allow-persistent" class="link">pgsql.allow_persistent</a> <var class="filename">php.ini</var> directive must be set to "On" (which is the default). The maximum number of persistent connection can be defined with the <a href="pgsql.configuration.html#ini.pgsql.max-persistent" class="link">pgsql.max_persistent</a> <var class="filename">php.ini</var> directive (defaults to -1 for no limit). The total number of connections can be set with the <a href="pgsql.configuration.html#ini.pgsql.max-links" class="link">pgsql.max_links</a> <var class="filename">php.ini</var> directive. </p> <p class="para"> <span class="function"><a href="function.pg-close.html" class="function">pg_close()</a></span> will not close persistent links generated by <span class="function"><strong>pg_pconnect()</strong></span>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.pg-pconnect-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">connection_string</code></em></span> <dd> <p class="para"> The <em><code class="parameter">connection_string</code></em> 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 <em>keyword = value</em>. Spaces around the equal sign are optional. To write an empty value or a value containing spaces, surround it with single quotes, e.g., <em>keyword = 'a value'</em>. Single quotes and backslashes within the value must be escaped with a backslash, i.e., \' and \\. </p> <p class="para"> The currently recognized parameter keywords are: <em><code class="parameter">host</code></em>, <em><code class="parameter">hostaddr</code></em>, <em><code class="parameter">port</code></em>, <em><code class="parameter">dbname</code></em>, <em><code class="parameter">user</code></em>, <em><code class="parameter">password</code></em>, <em><code class="parameter">connect_timeout</code></em>, <em><code class="parameter">options</code></em>, <em><code class="parameter">tty</code></em> (ignored), <em><code class="parameter">sslmode</code></em>, <em><code class="parameter">requiressl</code></em> (deprecated in favor of <em><code class="parameter">sslmode</code></em>), and <em><code class="parameter">service</code></em>. Which of these arguments exist depends on your PostgreSQL version. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">connect_type</code></em></span> <dd> <p class="para"> If <strong><code>PGSQL_CONNECT_FORCE_NEW</code></strong> is passed, then a new connection is created, even if the <em><code class="parameter">connection_string</code></em> is identical to an existing connection. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.pg-pconnect-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> PostgreSQL connection resource on success, <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.pg-pconnect-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2104"> <p><strong>Example #1 Using <span class="function"><strong>pg_pconnect()</strong></span></strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$dbconn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_pconnect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=mary"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">//connect to a database named "mary"<br /><br /></span><span style="color: #0000BB">$dbconn2 </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_pconnect</span><span style="color: #007700">(</span><span style="color: #DD0000">"host=localhost port=5432 dbname=mary"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// connect to a database named "mary" on "localhost" at port "5432"<br /><br /></span><span style="color: #0000BB">$dbconn3 </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_pconnect</span><span style="color: #007700">(</span><span style="color: #DD0000">"host=sheep port=5432 dbname=mary user=lamb password=foo"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">//connect to a database named "mary" on the host "sheep" with a username and password<br /><br /></span><span style="color: #0000BB">$conn_string </span><span style="color: #007700">= </span><span style="color: #DD0000">"host=sheep port=5432 dbname=test user=lamb password=bar"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$dbconn4 </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_pconnect</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_string</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">//connect to a database named "test" on the host "sheep" with a username and password<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.pg-pconnect-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.pg-connect.html" class="function" rel="rdfs-seeAlso">pg_connect()</a> - Open a PostgreSQL connection</span></li> <li class="member"> <a href="features.persistent-connections.html" class="link"> Persistent Database Connections</a> </li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.pg-parameter-status.html">pg_parameter_status</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.pg-ping.html">pg_ping</a></div> <div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>