Source for file pgsql.php
Documentation is available at pgsql.php
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2007 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 327310 2012-08-27 15:16:18Z danielc $
require_once 'MDB2/Driver/Datatype/Common.php';
* @author Paul Cooper <pgc@ucecom.com>
// {{{ _baseConvertResult()
* General type conversion method
* @param mixed $value refernce to a value to be converted
* @param string $type specifies which type to convert to
* @param boolean $rtrim [optional] when TRUE [default], apply rtrim() to text
* @return object a MDB2 error on failure
return ($value == 'f')? false : !empty ($value);
$value = pg_unescape_bytea ($value);
return parent ::_baseConvertResult ($value, $type, $rtrim);
return parent ::_baseConvertResult ($value, $type, $rtrim);
// {{{ getTypeDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an text type
* field to be used in statements like CREATE TABLE.
* @param array $field associative array with the name of the properties
* of the field being declared as array indexes. Currently, the types
* of supported field properties are as follows:
* Integer value that determines the maximum length of the text
* field. If this argument is missing the field should be
* declared to have the longest length allowed by the DBMS.
* Text value to be used as default for this field.
* Boolean flag that indicates whether this field is constrained
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
switch ($field['type']) {
$length = !empty ($field['length']) ? $field['length'] : false;
$fixed = !empty ($field['fixed']) ? $field['fixed'] : false;
return $fixed ? ($length ? 'CHAR('. $length. ')' : 'CHAR('. $db->options ['default_text_field_length']. ')')
: ($length ? 'VARCHAR('. $length. ')' : 'TEXT');
if (!empty ($field['autoincrement'])) {
if (!empty ($field['length'])) {
$length = $field['length'];
return 'BIGSERIAL PRIMARY KEY';
return 'SERIAL PRIMARY KEY';
if (!empty ($field['length'])) {
$length = $field['length'];
} elseif ($length == 3 || $length == 4 ) {
return 'TIME without time zone';
return 'TIMESTAMP without time zone';
$length = !empty ($field['length']) ? $field['length'] : 18;
$scale = !empty ($field['scale']) ? $field['scale'] : $db->options ['decimal_places'];
return 'NUMERIC('. $length. ','. $scale. ')';
// {{{ _getIntegerDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an integer type
* field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param array $field associative array with the name of the properties
* of the field being declared as array indexes. Currently, the types
* of supported field properties are as follows:
* Boolean flag that indicates whether the field should be
* declared as unsigned integer if possible.
* Integer value to be used as default for this field.
* Boolean flag that indicates whether this field is constrained
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if (!empty ($field['unsigned'])) {
$db->warnings [] = " unsigned integer field \"$name\" is being declared as signed integer";
if (!empty ($field['autoincrement'])) {
$name = $db->quoteIdentifier ($name, true );
if ($field['default'] === '') {
$field['default'] = empty ($field['notnull']) ? null : 0;
$default = ' DEFAULT '. $this->quote ($field['default'], 'integer');
$notnull = empty ($field['notnull']) ? '' : ' NOT NULL';
if (empty ($default) && empty ($notnull)) {
$default = ' DEFAULT NULL';
$name = $db->quoteIdentifier ($name, true );
* Convert a text value into a DBMS specific format that is suitable to
* compose query statements.
* @param string $value text string value that is intended to be converted.
* @param bool $quote determines if the value should be quoted and escaped
* @param bool $escape_wildcards if to escape escape wildcards
* @return string text string that represents the given argument value in
* a DBMS specific format.
function _quoteCLOB($value, $quote, $escape_wildcards)
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if ($db->options ['lob_allow_url_include']) {
$value = $this->_readFile ($value);
if (MDB2 ::isError ($value)) {
return $this->_quoteText ($value, $quote, $escape_wildcards);
* Convert a text value into a DBMS specific format that is suitable to
* compose query statements.
* @param string $value text string value that is intended to be converted.
* @param bool $quote determines if the value should be quoted and escaped
* @param bool $escape_wildcards if to escape escape wildcards
* @return string text string that represents the given argument value in
* a DBMS specific format.
function _quoteBLOB($value, $quote, $escape_wildcards)
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if ($db->options ['lob_allow_url_include']) {
$value = $this->_readFile ($value);
if (MDB2 ::isError ($value)) {
$connection = $db->getConnection ();
if (MDB2 ::isError ($connection)) {
$value = @pg_escape_bytea ($connection, $value);
$value = @pg_escape_bytea ($value);
* Convert a text value into a DBMS specific format that is suitable to
* compose query statements.
* @param string $value text string value that is intended to be converted.
* @param bool $quote determines if the value should be quoted and escaped
* @param bool $escape_wildcards if to escape escape wildcards
* @return string text string that represents the given argument value in
* a DBMS specific format.
$value = $value ? 't' : 'f';
* build a pattern matching string
* @param array $pattern even keys are strings, odd are patterns (% and _)
* @param string $operator optional pattern operator (LIKE, ILIKE and maybe others in the future)
* @param string $field optional field name that is being matched against
* (might be required when emulating ILIKE)
* @return string SQL pattern
function matchPattern($pattern, $operator = null , $field = null )
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if (null !== $operator) {
$field = (null === $field) ? '' : $field. ' ';
$match = $field. 'ILIKE ';
$match = $field. 'NOT ILIKE ';
$match = $field. 'NOT LIKE ';
return $db->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'not a supported operator type:'. $operator, __FUNCTION__ );
foreach ($pattern as $key => $value) {
$match.= $db->escapePattern ($db->escape ($value));
// {{{ patternEscapeString()
* build string to define escape pattern string
* @return string define escape pattern
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
return ' ESCAPE '. $this->quote ($db->string_quoting ['escape_pattern']);
// {{{ _mapNativeDatatype()
* Maps a native array description of a field to a MDB2 datatype and length
* @param array $field native field description
* @return array containing the various possible types, length, sign, fixed
$length = $field['length'];
$unsigned = $fixed = null;
} elseif (strstr($db_type, 'text')) {
if (isset ($field['scale'])) {
$length = $length. ','. $field['scale'];
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
return $db->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'unknown database attribute type: '. $db_type, __FUNCTION__ );
return array ($type, $length, $unsigned, $fixed);
// {{{ mapPrepareDatatype()
* Maps an mdb2 datatype to native prepare type
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if (!empty ($db->options ['datatype_map'][$type])) {
$type = $db->options ['datatype_map'][$type];
if (!empty ($db->options ['datatype_map_callback'][$type])) {
$parameter = array ('type' => $type);
return call_user_func_array($db->options ['datatype_map_callback'][$type], array (&$db, __FUNCTION__ , $parameter));
Documentation generated on Mon, 11 Mar 2019 15:51:23 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|