Class DB_pgsql

Description
Description | Vars (details) | Methods (details)

The methods PEAR DB uses to interact with PHP's pgsql extension for interacting with PostgreSQL databases

These methods overload the ones declared in DB_common.

Located in /web/lib/external/pear-db/DB/pgsql.php (line 49) 

PEAR
   |
   --DB_common
      |
      --DB_pgsql
Variable Summary
Description | Vars (details) | Methods (details)
integer $affected
resource $connection
string $dbsyntax
array $dsn
array $errorcode_map
array $features
string $phptype
Method Summary
Description | Vars (details) | Methods (details)
void DB_pgsql ()
int affectedRows ()
int autoCommit ([bool $onoff = false])
int commit ()
int connect (array $dsn, [bool $persistent = false])
int createSequence (string $seq_name)
bool disconnect ()
int dropSequence (string $seq_name)
integer errorCode (string $errormsg)
string errorNative ()
string escapeSimple (string $str)
mixed fetchInto (resource $result,  &$arr, int $fetchmode, [int $rownum = null], array $arr)
bool freeResult (resource $result)
string getSpecialQuery (string $type)
string modifyLimitQuery (string $query, int $from, int $count, [mixed $params = array()])
int nextId (string $seq_name, [boolean $ondemand = true])
true nextResult (a $result)
int numCols (resource $result)
int numRows (resource $result)
object the pgsqlRaiseError ([int $errno = null])
void quote ( $str)
string quoteBoolean (boolean $boolean)
int rollback ()
mixed simpleQuery (string $query)
array tableInfo (object|string $result, [int $mode = null])
Variables
Description | Vars (details) | Methods (details)
integer $affected = 0 (line 130)

The number of rows affected by a data manipulation query

resource $connection (line 99)

The raw database connection created by PHP

string $dbsyntax = 'pgsql' (line 63)

The database syntax variant to be used (db2, access, etc.), if any

array $dsn = array() (line 105)

The DSN information for connecting to a database

array $errorcode_map = array(
) (line 92)

A mapping of native error codes to DB error codes

array $features = array(
'limit' => 'alter',
'new_link' => '4.3.0',
'numrows' => true,
'pconnect' => true,
'prepare' => false,
'ssl' => true,
'transactions' => true,
) (line 78)

The capabilities of this DB implementation

The 'new_link' element contains the PHP version that first provided new_link support for this DBMS. Contains false if it's unsupported.

Meaning of the 'limit' element:

  • 'emulate' = emulate with fetch row by number
  • 'alter' = alter the query
  • false = skip rows

string $phptype = 'pgsql' (line 57)

The DB driver type (mysql, oci8, odbc, etc.)

Inherited Variables

Inherited from DB_common

DB_common::$fetchmode
 DB_common::$fetchmode_object_class
 DB_common::$last_parameters
 DB_common::$last_query
 DB_common::$options
 DB_common::$prepared_queries
 DB_common::$prepare_tokens
 DB_common::$prepare_types
 DB_common::$was_connected
 DB_common::$_last_query_manip
 DB_common::$_next_query_manip
Methods
Description | Vars (details) Methods (details)
Constructor DB_pgsql (line 155)

This constructor calls $this->DB_common()

void DB_pgsql ()
affectedRows (line 652)

Determines the number of rows affected by a data maniuplation query

  1. is returned for queries that don't manipulate data.

  • return: the number of rows. A DB_Error object on failure.
int affectedRows ()
Redefinition of:
DB_common::affectedRows()
Determines the number of rows affected by a data maniuplation query
autoCommit (line 592)

Enables or disables automatic commits

  • return: DB_OK on success. A DB_Error object if the driver doesn't support auto-committing transactions.
int autoCommit ([bool $onoff = false])
  • bool $onoff: true turns it on, false turns it off
Redefinition of:
DB_common::autoCommit()
Enables or disables automatic commits
commit (line 608)

Commits the current transaction

  • return: DB_OK on success. A DB_Error object on failure.
int commit ()
Redefinition of:
DB_common::commit()
Commits the current transaction
connect (line 209)

Connect to the database server, log in and open the database

Don't call this method directly. Use DB::connect() instead.

PEAR DB's pgsql driver supports the following extra DSN options:

  • connect_timeout How many seconds to wait for a connection to be established. Available since PEAR DB 1.7.0.
  • new_link If set to true, causes subsequent calls to connect() to return a new connection link instead of the existing one. WARNING: this is not portable to other DBMS's. Available only if PHP is >= 4.3.0 and PEAR DB is >= 1.7.0.
  • options Command line options to be sent to the server. Available since PEAR DB 1.6.4.
  • service Specifies a service name in pg_service.conf that holds additional connection parameters. Available since PEAR DB 1.7.0.
  • sslmode How should SSL be used when connecting? Values: disable, allow, prefer or require. Available since PEAR DB 1.7.0.
  • tty This was used to specify where to send server debug output. Available since PEAR DB 1.6.4.
Example of connecting to a new link via a socket:
  1.  require_once 'DB.php';
  2.  
  3.  $dsn = 'pgsql://user:pass@unix(/tmp)/dbname?new_link=true';
  4.  $options = array(
  5.      'portability' => DB_PORTABILITY_ALL,
  6.  );
  7.  
  8.  $db = DB::connect($dsn, $options);
  9.  if (PEAR::isError($db)) {
  10.      die($db->getMessage());
  11.  }

int connect (array $dsn, [bool $persistent = false])
  • array $dsn: the data source name
  • bool $persistent: should the connection be persistent?
createSequence (line 715)

Creates a new sequence

int createSequence (string $seq_name)
  • string $seq_name: name of the new sequence
Redefinition of:
DB_common::createSequence()
Creates a new sequence
disconnect (line 302)

Disconnects from the database server

  • return: TRUE on success, FALSE on failure
bool disconnect ()
dropSequence (line 735)

Deletes a sequence

int dropSequence (string $seq_name)
  • string $seq_name: name of the sequence to be deleted
Redefinition of:
DB_common::dropSequence()
Deletes a sequence
errorCode (line 818)

Determines 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()
Maps native error codes to DB's portable ones
errorNative (line 804)

Gets the DBMS' native error message produced by the last query

  • return: the DBMS' error message
string errorNative ()
Redefinition of:
DB_common::errorNative()
Gets the DBMS' native error code produced by the last query
escapeSimple (line 512)

Escapes a string according to the current DBMS's standards

string escapeSimple (string $str)
  • string $str: the string to be escaped
Redefinition of:
DB_common::escapeSimple()
Escapes a string according to the current DBMS's standards
fetchInto (line 413)

Places a row from the result set into the given array

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

This method is not meant to be called directly. Use DB_result::fetchInto() instead. It can't be declared "protected" because DB_result is a separate object.

  • return: DB_OK on success, NULL when the end of a result set is reached or on failure
  • see: DB_result::fetchInto()
mixed fetchInto (resource $result,  &$arr, int $fetchmode, [int $rownum = null], array $arr)
  • resource $result: the query result resource
  • array $arr: the referenced array to put the data in
  • int $fetchmode: how the resulting array should be indexed
  • int $rownum: the row number to fetch (0 = first row)
  • &$arr
freeResult (line 457)

Deletes the result set and frees the memory occupied by the result set

This method is not meant to be called directly. Use DB_result::free() instead. It can't be declared "protected" because DB_result is a separate object.

bool freeResult (resource $result)
  • resource $result: PHP's query result resource
getSpecialQuery (line 1056)

Obtains the query string needed for listing a given type of objects

  • return: the SQL query string or null if the driver doesn't support the object type requested
  • see: DB_common::getListOf()
  • access: protected
string getSpecialQuery (string $type)
  • string $type: the kind of objects you want to retrieve
Redefinition of:
DB_common::getSpecialQuery()
Obtains the query string needed for listing a given type of objects
modifyLimitQuery (line 760)

Adds LIMIT clauses to a query string according to current DBMS standards

  • return: the query string with LIMIT clauses added
  • access: protected
string modifyLimitQuery (string $query, int $from, int $count, [mixed $params = array()])
  • string $query: the query to modify
  • int $from: the row to start to fetching (0 = the first row)
  • int $count: the numbers of rows to fetch
  • mixed $params: array, string or numeric data to be used in execution of the statement. Quantity of items passed must match quantity of placeholders in query: meaning 1 placeholder for non-array parameters or 1 placeholder per array element.
Redefinition of:
DB_common::modifyLimitQuery()
Adds LIMIT clauses to a query string according to current DBMS standards
nextId (line 673)

Returns the next free id in a sequence

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 385)

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 547)

Gets the number of columns in a result set

This method is not meant to be called directly. Use DB_result::numCols() instead. It can't be declared "protected" because DB_result is a separate object.

int numCols (resource $result)
  • resource $result: PHP's query result resource
numRows (line 572)

Gets the number of rows in a result set

This method is not meant to be called directly. Use DB_result::numRows() instead. It can't be declared "protected" because DB_result is a separate object.

int numRows (resource $result)
  • resource $result: PHP's query result resource
Redefinition of:
DB_common::numRows()
Determines the number of rows in a query result
pgsqlRaiseError (line 780)

Produces a DB_Error object regarding the current problem

object the pgsqlRaiseError ([int $errno = null])
  • int $errno: if the error is being manually raised pass a DB_ERROR* constant here. If this isn't passed the error information gathered from the DBMS.
quote (line 475)
  • deprecated: Deprecated in release 1.6.0
void quote ( $str)
  • $str
Redefinition of:
DB_common::quote()
DEPRECATED: Quotes a string so it can be safely used in a query
quoteBoolean (line 492)

Formats a boolean value for use within a query in a locale-independent manner.

string quoteBoolean (boolean $boolean)
  • boolean $boolean: the boolean value to be quoted.
Redefinition of:
DB_common::quoteBoolean()
Formats a boolean value for use within a query in a locale-independent manner.
rollback (line 630)

Reverts the current transaction

  • return: DB_OK on success. A DB_Error object on failure.
int rollback ()
Redefinition of:
DB_common::rollback()
Reverts the current transaction
simpleQuery (line 321)

Sends a query to the database server

  • return: + a PHP result resrouce for successful SELECT queries
    • the DB_OK constant for other successful queries
    • a DB_Error object on failure
mixed simpleQuery (string $query)
  • string $query: the SQL query string
tableInfo (line 895)

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. A DB_Error object on failure.
  • see: DB_common::tableInfo()
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. While this also accepts a query result resource identifier, this behavior is deprecated.
  • int $mode: a valid tableInfo mode
Redefinition of:
DB_common::tableInfo()
Returns information about a table or a result set

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::nextQueryIsManip()
DB_common::numRows()
DB_common::prepare()
DB_common::provides()
DB_common::query()
DB_common::quote()
DB_common::quoteBoolean()
DB_common::quoteFloat()
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::_checkManip()
DB_common::_convertNullArrayValuesToEmpty()
DB_common::_rtrimArrayValues()
DB_common::__sleep()
DB_common::__toString()
DB_common::__wakeup()

Inherited From PEAR

PEAR::PEAR()
PEAR::delExpect()
PEAR::expectError()
PEAR::getStaticProperty()
PEAR::isError()
PEAR::loadExtension()
PEAR::popErrorHandling()
PEAR::popExpect()
PEAR::pushErrorHandling()
PEAR::raiseError()
PEAR::registerShutdownFunc()
PEAR::setErrorHandling()
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::throwError()
PEAR::_PEAR()

Documentation generated on Wed, 09 Feb 2011 09:03:19 +0700 by phpDocumentor 1.4.2