Source for file pgsql.php
Documentation is available at pgsql.php
// vim: set et ts=4 sw=4 fdm=marker:
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith |
// | All rights reserved. |
// +----------------------------------------------------------------------+
// | MDB2 is a merge of PEAR DB and Metabases that provides a unified DB |
// | API as well as database abstraction for PHP applications. |
// | This LICENSE is in the BSD license style. |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution. |
// | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, |
// | Lukas Smith nor the names of his contributors may be used to endorse |
// | or promote products derived from this software without specific prior|
// | written permission. |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
// | REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS|
// | OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
// | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY|
// | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
// | POSSIBILITY OF SUCH DAMAGE. |
// +----------------------------------------------------------------------+
// | Author: Paul Cooper <pgc@ucecom.com> |
// +----------------------------------------------------------------------+
// $Id: pgsql.php,v 1.64 2005/04/25 13:09:03 lsmith Exp $
* @author Paul Cooper <pgc@ucecom.com>
$this->supported['summary_functions'] = true;
* This method is used to collect information about an error
$native_msg = @pg_result_error ($error);
// Fall back to MDB2_ERROR if there was no mapping.
if (empty ($error_regexps)) {
'/(relation|sequence|table).*does not exist|class .* not found/i'
'/index .* does not exist/'
'/column .* does not exist/i'
'/relation .* already exists/i'
'/(divide|division) by zero$/i'
'/pg_atoi: error in .*: can\'t parse /i'
'/invalid input syntax for( type)? (integer|numeric)/i'
'/value .* is out of range for type \w*int/i'
'/integer out of range/i'
'/value too long for type character/i'
'/attribute .* not found|relation .* does not have attribute/i'
'/column .* specified in USING clause does not exist in (left|right) table/i'
'/parser: parse error at or near/i'
'/column reference .* is ambiguous/i'
'/violates not-null constraint/'
'/violates [\w ]+ constraint/'
'/referential integrity violation/'
'/more expressions than target columns/i'
foreach ($error_regexps as $regexp => $code) {
return array ($error, null , $native_msg);
// {{{ beginTransaction()
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug('starting transaction', 'beginTransaction');
$result = $this->_doQuery('BEGIN', true );
if (PEAR ::isError ($result)) {
* Commit the database changes done during a transaction that is in
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug('commit transaction', 'commit');
'commit: transaction changes are being auto committed');
$result = $this->_doQuery('COMMIT', true );
if (PEAR ::isError ($result)) {
* Cancel any database changes done during a transaction that is in
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug('rolling back transaction', 'rollback');
'rollback: transactions can not be rolled back when changes are auto committed');
$result = $this->_doQuery('ROLLBACK', true );
if (PEAR ::isError ($result)) {
* Does the grunt work of connecting to the database
* @return mixed connection resource on success, MDB2 Error Object on failure
function _doConnect($database_name, $persistent = false )
if ($database_name == '') {
$database_name = 'template1';
$protocol = $this->dsn['protocol'] ? $this->dsn['protocol'] : 'tcp';
if ($protocol == 'tcp') {
if ($this->dsn['hostspec']) {
$params[0 ] .= 'host=' . $this->dsn['hostspec'];
if ($this->dsn['port']) {
$params[0 ] .= ' port=' . $this->dsn['port'];
} elseif ($protocol == 'unix') {
// Allow for pg socket in non-standard locations.
if ($this->dsn['socket']) {
$params[0 ] .= 'host=' . $this->dsn['socket'];
if ($this->dsn['port']) {
$params[0 ] .= ' port=' . $this->dsn['port'];
$params[0 ] .= ' dbname=\'' . addslashes($database_name) . '\'';
if ($this->dsn['username']) {
$params[0 ] .= ' user=\'' . addslashes($this->dsn['username']) . '\'';
if ($this->dsn['password']) {
$params[0 ] .= ' password=\'' . addslashes($this->dsn['password']) . '\'';
if (!empty ($this->dsn['options'])) {
$params[0 ] .= ' options=' . $this->dsn['options'];
if (!empty ($this->dsn['tty'])) {
$params[0 ] .= ' tty=' . $this->dsn['tty'];
if (!empty ($this->dsn['connect_timeout'])) {
$params[0 ] .= ' connect_timeout=' . $this->dsn['connect_timeout'];
if (!empty ($this->dsn['sslmode'])) {
$params[0 ] .= ' sslmode=' . $this->dsn['sslmode'];
if (!empty ($this->dsn['service'])) {
$params[0 ] .= ' service=' . $this->dsn['service'];
if (isset ($this->dsn['new_link'])
&& ($this->dsn['new_link'] == 'true' || $this->dsn['new_link'] === true ))
$params[] = PGSQL_CONNECT_FORCE_NEW;
$connect_function = $persistent ? 'pg_pconnect' : 'pg_connect';
* Connect to the database
* @return true on success, MDB2 Error Object on failure
if (!PEAR ::loadExtension ($this->phptype)) {
'connect: extension '. $this->phptype. ' is not compiled into PHP');
if (PEAR ::isError ($connection)) {
* Log out and disconnect from the database.
* @return mixed true on success, false if not connected and error
* @param string $query the SQL query
* @param mixed $types array that contains the types of the columns in
* @return mixed MDB2_OK on success, a MDB2 error on failure
$connection = $this->_doConnect('template1', false );
if (PEAR ::isError ($connection)) {
'Cannot connect to template1');
$query = $this->_modifyQuery($query, $isManip, $limit, $offset);
$result = $this->_doQuery($query, $isManip, $connection, false );
if (PEAR ::isError ($result)) {
return $this->_wrapResult($result, $types, true , false , $limit, $offset);
* @param string $query query
* @param boolean $isManip if the query is a manipulation query
* @param resource $connection
* @param string $database_name
* @return result or error object
function _doQuery($query, $isManip = false , $connection = null , $database_name = null )
$this->debug($query, 'query');
if ($this->options['disable_query']) {
if (PEAR ::isError ($error)) {
$result = @pg_query ($connection, $query);
return @pg_affected_rows ($result);
* Changes a query string for various DBMS specific reasons
* @param string $query query to modify
* @return the new (modified) query
&& !preg_match('/LIMIT\s*\d(\s*(,|OFFSET)\s*\d+)?/i', $query)
if (substr($query, -1 ) == ';') {
$query = substr($query, 0 , -1 );
$manip = preg_replace('/^(DELETE FROM|UPDATE).*$/', '\\1', $query);
$query = $manip. ' '. $from. ' WHERE ctid=(SELECT ctid FROM '. $from. ' '. $where. ' LIMIT '. $limit. ')';
$query .= " LIMIT $limit OFFSET $offset";
* returns the next free id of a sequence
* @param string $seq_name name of the sequence
* @param boolean $ondemand when true the seqence is
* automatic created, if it
* @return mixed MDB2 Error Object or id
function nextID($seq_name, $ondemand = true )
$query = " SELECT NEXTVAL('$sequence_name')";
$result = $this->queryOne($query, 'integer');
if (PEAR ::isError ($result)) {
$result = $this->manager->createSequence ($seq_name, 1 );
if (PEAR ::isError ($result)) {
'nextID: on demand sequence could not be created');
return $this->nextId ($seq_name, false );
* returns the current id of a sequence
* @param string $seq_name name of the sequence
* @return mixed MDB2 Error Object or id
return $this->queryOne(" SELECT last_value FROM $sequence_name" , 'integer');
class MDB2_Result_pgsql extends MDB2_Result_Common
* Fetch a row and insert the data into an existing array.
* @param int $fetchmode how the array data should be indexed
* @param int $rownum number of the row where the data can be found
* @return int data array on success, a MDB2 error on failure
function &fetchRow ($fetchmode = MDB2_FETCHMODE_DEFAULT , $rownum = null )
$seek = $this->seek ($rownum);
if (PEAR ::isError ($seek)) {
$fetchmode = $this->db->fetchmode;
$row = @pg_fetch_array ($this->result, null , PGSQL_ASSOC );
$row = @pg_fetch_row ($this->result);
'fetchRow: resultset has already been freed');
$this->db->_convertEmptyArrayValuesToNull ($row);
if (isset ($this->values)) {
$this->_assignBindColumns ($row);
if (isset ($this->types)) {
$row = $this->db->datatype ->convertResultRow ($this->types, $row);
$object_class = $this->db->options ['fetch_class'];
if ($object_class == 'stdClass') {
$row = &new $object_class($row);
* Retrieve the names of columns returned by the DBMS in a query result.
* @return mixed an associative array variable
* that will hold the names of columns. The
* indexes of the array are the column names
* mapped to lower case and the values are the
* respective numbers of the columns starting
* from 0. Some DBMS may not return any
* columns when the result set does not
* a MDB2 error on failure
function _getColumnNames ()
$numcols = $this->numCols ();
if (PEAR ::isError ($numcols)) {
for ($column = 0; $column < $numcols; $column++ ) {
$column_name = @pg_field_name ($this->result, $column);
$columns[$column_name] = $column;
* Count the number of columns returned by the DBMS in a query result.
* @return mixed integer value with the number of columns, a MDB2 error
$cols = @pg_num_fields ($this->result);
'numCols: resultset has already been freed');
return $this->db->raiseError ();
* Free the internal resources associated with result.
* @return boolean true on success, false if result is invalid
$free = @pg_free_result ($this->result);
return $this->db->raiseError ();
class MDB2_BufferedResult_pgsql extends MDB2_Result_pgsql
* seek to a specific row in a result set
* @param int $rownum number of the row where the data can be found
* @return mixed MDB2_OK on success, a MDB2 error on failure
function seek ($rownum = 0 )
if ($this->rownum != ($rownum - 1 ) && !@pg_result_seek ($this->result, $rownum)) {
'seek: resultset has already been freed');
'seek: tried to seek to an invalid row number ('. $rownum. ')');
$this->rownum = $rownum - 1;
* check if the end of the result set has been reached
* @return mixed true or false on sucess, a MDB2 error on failure
$numrows = $this->numRows ();
if (PEAR ::isError ($numrows)) {
return $this->rownum < ($numrows - 1 );
* returns the number of rows in a result object
* @return mixed MDB2 Error Object or the number of rows
$rows = @pg_num_rows ($this->result);
'numRows: resultset has already been freed');
return $this->raiseError ();
class MDB2_Statement_pgsql extends MDB2_Statement_Common
Documentation generated on Mon, 11 Mar 2019 14:20:24 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|