Class DB_pgsql

Description

Database independent query interface definition for PHP's PostgreSQL extension.

  • author: Rui Hirokawa <hirokawa@php.net>
  • author: Stig Bakken <ssb@php.net>
  • version: $Id: pgsql.php,v 1.83 2004/10/04 17:53:09 danielc Exp $

Located in /maintenance/libraries/pear/DB/pgsql.php (line 35)

PEAR
   |
   --DB_common
      |
      --DB_pgsql
Variable Summary
 mixed $affected
 mixed $autocommit
 mixed $connection
 mixed $dbsyntax
 mixed $dsn
 mixed $fetchmode
 mixed $num_rows
 mixed $phptype
 mixed $row
Method Summary
 DB_pgsql DB_pgsql ()
 int affectedRows ()
 void autoCommit ([mixed $onoff = false])
 void commit ()
 int connect ($dsn $dsninfo, [$persistent $persistent = false])
 mixed createSequence (string $seq_name)
 bool disconnect ()
 mixed dropSequence (string $seq_name)
 integer errorCode (string $errormsg)
 int errorNative ()
 string escapeSimple (string $str)
 mixed fetchInto (resource $result, array &$arr, int $fetchmode, [int $rownum = null])
 bool freeResult ($result $result)
 string getSpecialQuery (string $type)
 void modifyLimitQuery (mixed $query, mixed $from, mixed $count, [mixed $params = array()])
 int nextId (string $seq_name, [boolean $ondemand = true])
 true nextResult (a $result)
 int numCols ($result $result)
 int numRows ($result $result)
 object DB pgsqlRaiseError ([integer $errno = null])
 void quote (mixed $str)
 mixed quoteSmart (mixed $in)
 void rollback ()
 int simpleQuery ($query $query)
 array tableInfo (object|string $result, [int $mode = null])
 string _pgFieldFlags (int $resource, int $num_field, mixed $table_name)
Variables
mixed $affected = 0 (line 47)
mixed $autocommit = true (line 48)
mixed $connection (line 39)
mixed $dbsyntax (line 40)
mixed $dsn = array() (line 44)
mixed $fetchmode = DB_FETCHMODE_ORDERED (line 49)

Redefinition of:
DB_common::$fetchmode
mixed $num_rows = array() (line 46)
mixed $phptype (line 40)

Redefinition of:
DB_common::$phptype
DB type (mysql, oci8, odbc etc.)
mixed $prepare_tokens = array() (line 41)

Redefinition of:
DB_common::$prepare_tokens
mixed $prepare_types = array() (line 42)

Redefinition of:
DB_common::$prepare_types
mixed $row = array() (line 45)
mixed $transaction_opcount = 0 (line 43)

Inherited Variables

Inherited from DB_common

DB_common::$dbh
DB_common::$errorcode_map
DB_common::$features
DB_common::$fetchmode_object_class
DB_common::$last_query
DB_common::$options
DB_common::$prepared_queries
DB_common::$prepare_maxstmt
Methods
Constructor DB_pgsql (line 54)
DB_pgsql DB_pgsql ()
affectedRows (line 521)

Gets the number of rows affected by the last query.

if the last query was a select, returns 0.

  • return: number of rows affected by the last query or DB_ERROR
int affectedRows ()

Redefinition of:
DB_common::affectedRows()
Returns the affected rows of a query
autoCommit (line 466)

Enable/disable automatic commits

void autoCommit ([mixed $onoff = false])

Redefinition of:
DB_common::autoCommit()
enable automatic Commit
commit (line 480)

Commit the current transaction.

void commit ()

Redefinition of:
DB_common::commit()
starts a Commit
connect (line 81)

Connect to a database and log in as the specified user.

  • return: DB_OK on success, a DB error code on failure.
int connect ($dsn $dsninfo, [$persistent $persistent = false])
  • $dsn $dsninfo: the data source name (see DB::parseDSN for syntax)
  • $persistent $persistent: (optional) whether the connection should be persistent
createSequence (line 581)

Create the sequence

  • return: DB_OK on success or DB error on error
  • access: public
mixed createSequence (string $seq_name)
  • string $seq_name: the name of the sequence

Redefinition of:
DB_common::createSequence()
Creates a new sequence
disconnect (line 150)

Log out and disconnect from the database.

  • return: true on success, false if not connected.
bool disconnect ()
dropSequence (line 598)

Drop a sequence

  • return: DB_OK on success or DB error on error
  • access: public
mixed dropSequence (string $seq_name)
  • string $seq_name: the name of the sequence

Redefinition of:
DB_common::dropSequence()
Deletes a sequence
errorCode (line 241)

Determine PEAR::DB error code from the database's text error message.

  • return: an error number from a DB error constant
integer errorCode (string $errormsg)
  • string $errormsg: error message returned from the database

Redefinition of:
DB_common::errorCode()
Map native error codes to DB's portable ones
errorNative (line 455)

Get the native error code of the last error (if any) that occured on the current connection.

  • return: native PostgreSQL error code
int errorNative ()

Redefinition of:
DB_common::errorNative()
Returns an errormessage, provides by the database
escapeSimple (line 404)

Escape a string according to the current DBMS's standards

PostgreSQL treats a backslash as an escape character, so they are removed.

Not using pg_escape_string() yet because it requires PostgreSQL to be at version 7.2 or greater.

  • return: the escaped string
  • internal:
string escapeSimple (string $str)
  • string $str: the string to be escaped

Redefinition of:
DB_common::escapeSimple()
Escape a string according to the current DBMS's standards
fetchInto (line 291)

Fetch a row and insert the data into an existing array.

Formating of the array and the data therein are configurable. See DB_result::fetchInto() for more information.

  • return: DB_OK on success, null when end of result set is reached or on failure
  • access: private
  • see: DB_result::fetchInto()
mixed fetchInto (resource $result, array &$arr, int $fetchmode, [int $rownum = null])
  • resource $result: query result identifier
  • array $arr: (reference) array where data from the row should be placed
  • int $fetchmode: how the resulting array should be indexed
  • int $rownum: the row number to fetch
freeResult (line 333)

Free the internal resources associated with $result.

  • return: true on success, false if $result is invalid
bool freeResult ($result $result)
  • $result $result: int PostgreSQL result identifier
getSpecialQuery (line 805)

Returns the query needed to get some backend info

  • return: The SQL query string
string getSpecialQuery (string $type)
  • string $type: What kind of info you want to retrieve

Redefinition of:
DB_common::getSpecialQuery()
Returns the query needed to get some backend info
modifyLimitQuery (line 607)
void modifyLimitQuery (mixed $query, mixed $from, mixed $count, [mixed $params = array()])

Redefinition of:
DB_common::modifyLimitQuery()
This method is used by backends to alter limited queries
nextId (line 542)

Returns the next free id in a sequence

  • return: the next id number in the sequence. DB_Error if problem.
  • access: public
  • see: DB_common::nextID()
  • internal:
int nextId (string $seq_name, [boolean $ondemand = true])
  • string $seq_name: name of the sequence
  • boolean $ondemand: when true, the seqence is automatically created if it does not exist

Redefinition of:
DB_common::nextId()
Returns the next free id in a sequence
nextResult (line 227)

Move the internal pgsql result pointer to the next available result

  • return: if a result is available otherwise return false
  • access: public
true nextResult (a $result)
  • a $result: valid fbsql result resource
numCols (line 418)

Get the number of columns in a result set.

  • return: the number of columns per row in $result
int numCols ($result $result)
  • $result $result: resource PostgreSQL result identifier
numRows (line 437)

Get the number of rows in a result set.

  • return: the number of rows in $result
int numRows ($result $result)
  • $result $result: resource PostgreSQL result identifier

Redefinition of:
DB_common::numRows()
Returns the number of rows in a result object
pgsqlRaiseError (line 627)

Gather information about an error, then use that info to create a DB error object and finally return that object.

object DB pgsqlRaiseError ([integer $errno = null])
  • integer $errno: PEAR error number (usually a DB constant) if manually raising an error
quote (line 351)
  • internal:
  • deprecated: Deprecated in release 1.6.0
void quote (mixed $str)

Redefinition of:
DB_common::quote()
DEPRECATED: Quotes a string so it can be safely used in a query
quoteSmart (line 373)

Format input so it can be safely used in a query

  • return: Submitted variable's type = returned value:
    • null = the string NULL
    • boolean = string TRUE or FALSE
    • integer or double = the unquoted number
    • other (including strings and numeric strings) = the data escaped according to MySQL's settings then encapsulated between single quotes
  • internal:
mixed quoteSmart (mixed $in)
  • mixed $in: data to be quoted

Redefinition of:
DB_common::quoteSmart()
Format input so it can be safely used in a query
rollback (line 500)

Roll back (undo) the current transaction.

void rollback ()

Redefinition of:
DB_common::rollback()
starts a rollback
simpleQuery (line 170)

Send a query to PostgreSQL and return the results as a PostgreSQL resource identifier.

  • return: returns a valid PostgreSQL result for successful SELECT queries, DB_OK for other successful queries. A DB error code is returned on failure.
int simpleQuery ($query $query)
  • $query $query: the SQL query
tableInfo (line 722)

Returns information about a table or a result set.

NOTE: only supports 'table' and 'flags' if $result is a table name.

  • return: an associative array with the information requested or an error object if something is wrong
  • see: DB_common::tableInfo()
  • internal:
  • access: public
array tableInfo (object|string $result, [int $mode = null])
  • object|string $result: DB_result object from a query or a string containing the name of a table
  • int $mode: a valid tableInfo mode

Redefinition of:
DB_common::tableInfo()
Returns information about a table or a result set
_pgFieldFlags (line 653)

Flags of a Field

  • return: The flags of the field ("not_null", "default_value", "primary_key", "unique_key" and "multiple_key" are supported). The default value is passed through rawurlencode() in case there are spaces in it.
  • access: private
string _pgFieldFlags (int $resource, int $num_field, mixed $table_name)
  • int $resource: PostgreSQL result identifier
  • int $num_field: the field number

Inherited Methods

Inherited From DB_common

 DB_common::DB_common()
 DB_common::affectedRows()
 DB_common::autoCommit()
 DB_common::autoExecute()
 DB_common::autoPrepare()
 DB_common::buildManipSQL()
 DB_common::commit()
 DB_common::createSequence()
 DB_common::dropSequence()
 DB_common::errorCode()
 DB_common::errorMessage()
 DB_common::errorNative()
 DB_common::escapeSimple()
 DB_common::execute()
 DB_common::executeEmulateQuery()
 DB_common::executeMultiple()
 DB_common::freePrepared()
 DB_common::getAll()
 DB_common::getAssoc()
 DB_common::getCol()
 DB_common::getListOf()
 DB_common::getOne()
 DB_common::getOption()
 DB_common::getRow()
 DB_common::getSequenceName()
 DB_common::getSpecialQuery()
 DB_common::getTables()
 DB_common::limitQuery()
 DB_common::modifyLimitQuery()
 DB_common::modifyQuery()
 DB_common::nextId()
 DB_common::numRows()
 DB_common::prepare()
 DB_common::provides()
 DB_common::query()
 DB_common::quote()
 DB_common::quoteIdentifier()
 DB_common::quoteSmart()
 DB_common::quoteString()
 DB_common::raiseError()
 DB_common::rollback()
 DB_common::setFetchMode()
 DB_common::setOption()
 DB_common::tableInfo()
 DB_common::toString()
 DB_common::_convertNullArrayValuesToEmpty()
 DB_common::_rtrimArrayValues()

Documentation generated on Fri, 10 Dec 2004 18:26:12 +0000 by phpDocumentor 1.3.0RC3