Class: DB_pgsql

Source Location: /DB-1.6.2/DB/pgsql.php

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_pgsql

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

Author(s):

Rui Hirokawa <hirokawa at php.net>
Stig Bakken <ssb at php.net>

Version:

$Id: pgsql.php,v 1.75 2004/04/07 05:12:28 danielc Exp $

Variables

Methods

Inherited Variables

Class: 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

Inherited Methods

Class: DB_common

DB_common::DB_common(): Constructor
DB_common::affectedRows(): Returns the affected rows of a query
DB_common::autoCommit(): enable automatic Commit
DB_common::autoExecute(): Automaticaly generate an insert or update query and call prepare() and execute() with it
DB_common::autoPrepare(): Automaticaly generate an insert or update query and pass it to prepare()
DB_common::buildManipSQL(): Make automaticaly an sql query for prepare()
DB_common::commit(): starts a Commit
DB_common::createSequence(): Creates a new sequence
DB_common::dropSequence(): Deletes a sequence
DB_common::errorCode(): Map native error codes to DB's portable ones
DB_common::errorMessage(): Map a DB error code to a textual message. This is actually just a wrapper for DB::errorMessage()
DB_common::errorNative(): Returns an errormessage, provides by the database
DB_common::escapeSimple(): Escape a string according to the current DBMS's standards
DB_common::execute(): Executes a DB statement prepared with prepare()
DB_common::executeMultiple(): This function does several execute() calls on the same statement handle
DB_common::freePrepared(): Free the resource used in a prepared query
DB_common::getAll(): Fetch all the rows returned from a query
DB_common::getAssoc(): Fetch the entire result set of a query and return it as an associative array using the first column as the key
DB_common::getCol(): Fetch a single column from a result set and return it as an indexed array
DB_common::getListOf(): list internal DB info valid values for $type are db dependent, often: databases, users, view, functions
DB_common::getOne(): Fetch the first column of the first row of data returned from a query
DB_common::getOption(): Returns the value of an option
DB_common::getRow(): Fetch the first row of data returned from a query
DB_common::getSpecialQuery(): Returns the query needed to get some backend info
DB_common::getTables()
DB_common::limitQuery(): Generates a limited query
DB_common::nextId(): Returns the next free id in a sequence
DB_common::numRows(): Returns the number of rows in a result object
DB_common::prepare(): Prepares a query for multiple execution with execute()
DB_common::provides(): Tell whether a DB implementation or its backend extension supports a given feature
DB_common::query(): Send a query to the database and return any results with a DB_result object
DB_common::quote(): DEPRECATED: Quotes a string so it can be safely used in a query
DB_common::quoteIdentifier(): Quote a string so it can be safely used as a table or column name
DB_common::quoteSmart(): Format input so it can be safely used in a query
DB_common::quoteString(): DEPRECATED: Quotes a string so it can be safely used within string delimiters in a query
DB_common::raiseError(): Communicate an error and invoke error callbacks, etc
DB_common::rollback(): starts a rollback
DB_common::setFetchMode(): Sets which fetch mode should be used by default on queries on this connection
DB_common::setOption(): Set run-time configuration options for PEAR DB
DB_common::tableInfo(): Returns information about a table or a result set

Class Details

[line 35]
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.75 2004/04/07 05:12:28 danielc Exp $

[ Top ]

Class Variables

$affected = 0

[line 47]

Type:

mixed

[ Top ]

$autocommit = true

[line 48]

Type:

mixed

[ Top ]

$connection =

[line 39]

Type:

mixed

[ Top ]

$dbsyntax =

[line 40]

Type:

mixed

[ Top ]

$dsn = array()

[line 44]

Type:

mixed

[ Top ]

$fetchmode = DB_FETCHMODE_ORDERED

[line 49]

Type:	mixed
Overrides:	Array

[ Top ]

$num_rows = array()

[line 46]

Type:

mixed

[ Top ]

$phptype =

[line 40]

Type:	mixed
Overrides:	Array

[ Top ]

$prepare_tokens = array()

[line 41]

Type:	mixed
Overrides:	Array

[ Top ]

$prepare_types = array()

[line 42]

Type:	mixed
Overrides:	Array

[ Top ]

$row = array()

[line 45]

Type:

mixed

[ Top ]

$transaction_opcount = 0

[line 43]

Type:

mixed

[ Top ]

Method Detail

DB_pgsql (Constructor) [line 54]

DB_pgsql DB_pgsql(
)

[ Top ]

affectedRows [line 512]

int affectedRows(
)

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

Overrides DB_common::affectedRows() (Returns the affected rows of a query)

[ Top ]

autoCommit [line 457]

void autoCommit(
[
$onoff = false])

Enable/disable automatic commits

Overrides DB_common::autoCommit() (enable automatic Commit)

Parameters:

$onoff —

[ Top ]

commit [line 471]

void commit(
)

Commit the current transaction.

Overrides DB_common::commit() (starts a Commit)

[ Top ]

connect [line 81]

int connect(
$dsn
$dsninfo, [$persistent
$persistent = false])

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

Return: DB_OK on success, a DB error code on failure.

Parameters:

$dsn	`$dsninfo`	—	the data source name (see DB::parseDSN for syntax)
$persistent	`$persistent`	—	(optional) whether the connection should be persistent

[ Top ]

createSequence [line 572]

mixed createSequence(
string
$seq_name)

Create the sequence

Return: DB_OK on success or DB error on error
Access: public

Overrides DB_common::createSequence() (Creates a new sequence)

Parameters:

string $seq_name — the name of the sequence

[ Top ]

disconnect [line 143]

bool disconnect(
)

Log out and disconnect from the database.

Return: true on success, false if not connected.

[ Top ]

dropSequence [line 589]

mixed dropSequence(
string
$seq_name)

Drop a sequence

Return: DB_OK on success or DB error on error
Access: public

Overrides DB_common::dropSequence() (Deletes a sequence)

Parameters:

string $seq_name — the name of the sequence

[ Top ]

errorCode [line 234]

integer errorCode(
string
$errormsg)

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

Return: an error number from a DB error constant

Overrides DB_common::errorCode() (Map native error codes to DB's portable ones)

Parameters:

string $errormsg — error message returned from the database

[ Top ]

errorNative [line 446]

int errorNative(
)

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

Return: native PostgreSQL error code

Overrides DB_common::errorNative() (Returns an errormessage, provides by the database)

[ Top ]

escapeSimple [line 395]

string escapeSimple(
string
$str)

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

Overrides DB_common::escapeSimple() (Escape a string according to the current DBMS's standards)

Parameters:

string $str — the string to be escaped

[ Top ]

freeResult [line 324]

bool freeResult(
$result
$result)

Free the internal resources associated with $result.

Return: true on success, false if $result is invalid

Parameters:

$result $result — int PostgreSQL result identifier

[ Top ]

getSpecialQuery [line 796]

string getSpecialQuery(
string
$type)

Returns the query needed to get some backend info

Return: The SQL query string

Overrides DB_common::getSpecialQuery() (Returns the query needed to get some backend info)

Parameters:

string $type — What kind of info you want to retrieve

[ Top ]

modifyLimitQuery [line 598]

void modifyLimitQuery(

$query, 
$from, 
$count, [
$params = array()])

Parameters:

	`$query`	—
	`$from`	—
	`$count`	—
	`$params`	—

[ Top ]

nextId [line 533]

int nextId(
string
$seq_name, [boolean
$ondemand = true])

Returns the next free id in a sequence

Return: the next id number in the sequence. DB_Error if problem.
See: DB_common::nextID()
Access: public

Overrides DB_common::nextId() (Returns the next free id in a sequence)

Parameters:

string	`$seq_name`	—	name of the sequence
boolean	`$ondemand`	—	when true, the seqence is automatically created if it does not exist

[ Top ]

nextResult [line 220]

true nextResult(
a
$result)

Move the internal pgsql result pointer to the next available result

Return: if a result is available otherwise return false
Access: public

Parameters:

a $result — valid fbsql result resource

[ Top ]

numCols [line 409]

int numCols(
$result
$result)

Get the number of columns in a result set.

Return: the number of columns per row in $result

Parameters:

$result $result — resource PostgreSQL result identifier

[ Top ]

numRows [line 428]

int numRows(
$result
$result)

Get the number of rows in a result set.

Return: the number of rows in $result

Overrides DB_common::numRows() (Returns the number of rows in a result object)

Parameters:

$result $result — resource PostgreSQL result identifier

[ Top ]

pgsqlRaiseError [line 618]

object DB pgsqlRaiseError(
[integer
$errno = null])

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

Return: error object
See: DB_common::raiseError()
See: DB_pgsql::errorCode()
See: DB_pgsql::errorNative()

Parameters:

integer $errno — PEAR error number (usually a DB constant) if manually raising an error

[ Top ]

quote [line 342]

void quote(

$str)

Deprecated: Deprecated in release 1.6.0

Overrides DB_common::quote() (DEPRECATED: Quotes a string so it can be safely used in a query)

Parameters:

$str —

[ Top ]

quoteSmart [line 364]

mixed quoteSmart(
mixed
$in)

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

Overrides DB_common::quoteSmart() (Format input so it can be safely used in a query)

Parameters:

mixed $in — data to be quoted

[ Top ]

rollback [line 491]

void rollback(
)

Roll back (undo) the current transaction.

Overrides DB_common::rollback() (starts a rollback)

[ Top ]

simpleQuery [line 163]

int simpleQuery(
$query
$query)

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.

Parameters:

$query $query — the SQL query

[ Top ]

tableInfo [line 713]

array tableInfo(
object|string
$result, [int
$mode = null])

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()
Access: public

Overrides DB_common::tableInfo() (Returns information about a table or a result set)

Parameters:

object\|string	`$result`	—	DB_result object from a query or a string containing the name of a table
int	`$mode`	—	a valid tableInfo mode

[ Top ]