array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.pg-pconnect.php', 1 => 'pg_pconnect', 2 => 'Open a persistent PostgreSQL connection', ), 'up' => array ( 0 => 'ref.pgsql.php', 1 => 'PostgreSQL Functions', ), 'prev' => array ( 0 => 'function.pg-parameter-status.php', 1 => 'pg_parameter_status', ), 'next' => array ( 0 => 'function.pg-ping.php', 1 => 'pg_ping', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/pgsql/functions/pg-pconnect.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

pg_pconnect

(PHP 4, PHP 5, PHP 7, PHP 8)

pg_pconnect — Open a persistent PostgreSQL connection

Description

pg_pconnect(string $connection_string, int $flags = 0): PgSql\Connection|false

pg_pconnect() opens a connection to a PostgreSQL database. It returns a PgSql\Connection instance that is needed by other PostgreSQL functions.

If a second call is made to pg_pconnect() with the same connection_string as an existing connection, the existing connection will be returned unless you pass PGSQL_CONNECT_FORCE_NEW as flags.

To enable persistent connections, the pgsql.allow_persistent php.ini directive must be set to "On" (which is the default). The maximum number of persistent connections can be defined with the pgsql.max_persistent php.ini directive (defaults to -1 for no limit). The total number of connections can be set with the pgsql.max_links php.ini directive.

pg_close() will not close persistent links generated by pg_pconnect().

Parameters

connection_string

The connection_string 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 keyword = value. Spaces around the equal sign are optional. To write an empty value or a value containing spaces, surround it with single quotes, e.g., keyword = 'a value'. Single quotes and backslashes within the value must be escaped with a backslash, i.e., \' and \\.

The currently recognized parameter keywords are: host, hostaddr, port, dbname, user, password, connect_timeout, options, tty (ignored), sslmode, requiressl (deprecated in favor of sslmode), and service. Which of these arguments exist depends on the PostgreSQL version.

flags

If PGSQL_CONNECT_FORCE_NEW is passed, then a new connection is created, even if the connection_string is identical to an existing connection.

Return Values

Returns a PgSql\Connection instance on success, or false on failure.

Changelog

Version Description
8.1.0 Returns a PgSql\Connection instance now; previously, a resource was returned.

Examples

Example #1 Using pg_pconnect()

<?php
// Connect to a database named "mary"
$dbconn = pg_pconnect("dbname=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 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 "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);
?>

See Also