PHP PEAR 1.4.5 : Vue détaillée de pgsql.php

Classe: DB_pgsql - X-Ref

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.

DB_pgsql() X-Ref

This constructor calls <kbd>$this->DB_common()</kbd>

return: void

connect($dsn, $persistent = false) X-Ref

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:
<code>
require_once 'DB.php';

$dsn = 'pgsql://user:pass@unix(/tmp)/dbname?new_link=true';
$options = array(
'portability' => DB_PORTABILITY_ALL,
);

$db =& DB::connect($dsn, $options);
if (PEAR::isError($db)) {
die($db->getMessage());
}
</code>

param: array $dsn         the data source name
param: bool  $persistent  should the connection be persistent?
return: int  DB_OK on success. A DB_Error object on failure.

disconnect() X-Ref

Disconnects from the database server

return: bool TRUE on success, FALSE on failure

simpleQuery($query) X-Ref

Sends a query to the database server

param: string the SQL query string
return: mixed + a PHP result resrouce for successful SELECT queries

nextResult($result) X-Ref

Move the internal pgsql result pointer to the next available result

param: a valid fbsql result resource
return: true if a result is available otherwise return false

fetchInto($result, &$arr, $fetchmode, $rownum = null) X-Ref

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.

param: resource $result    the query result resource
param: array    $arr       the referenced array to put the data in
param: int      $fetchmode how the resulting array should be indexed
param: int      $rownum    the row number to fetch (0 = first row)
return: mixed  DB_OK on success, NULL when the end of a result set is

freeResult($result) X-Ref

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.

param: resource $result  PHP's query result resource
return: bool  TRUE on success, FALSE if $result is invalid

quote($str) X-Ref

quoteBoolean($boolean) X-Ref

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

param: boolean the boolean value to be quoted.
return: string the quoted string.

escapeSimple($str) X-Ref

Escapes a string according to the current DBMS's standards

{@internal PostgreSQL treats a backslash as an escape character,
so they are escaped as well.

param: string $str the string to be escaped
return: string the escaped string

numCols($result) X-Ref

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.

param: resource $result  PHP's query result resource
return: int  the number of columns.  A DB_Error object on failure.

numRows($result) X-Ref

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.

param: resource $result  PHP's query result resource
return: int  the number of rows.  A DB_Error object on failure.

autoCommit($onoff = false) X-Ref

Enables or disables automatic commits

param: bool $onoff true turns it on, false turns it off
return: int DB_OK on success. A DB_Error object if the driver

commit() X-Ref

Commits the current transaction

return: int DB_OK on success. A DB_Error object on failure.

rollback() X-Ref

Reverts the current transaction

return: int DB_OK on success. A DB_Error object on failure.

affectedRows() X-Ref

Determines the number of rows affected by a data maniuplation query

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

return: int the number of rows. A DB_Error object on failure.

nextId($seq_name, $ondemand = true) X-Ref

Returns the next free id in a sequence

param: string  $seq_name  name of the sequence
param: boolean $ondemand  when true, the seqence is automatically
return: int  the next id number in the sequence.

createSequence($seq_name) X-Ref

Creates a new sequence

param: string $seq_name name of the new sequence
return: int DB_OK on success. A DB_Error object on failure.

dropSequence($seq_name) X-Ref

Deletes a sequence

param: string $seq_name name of the sequence to be deleted
return: int DB_OK on success. A DB_Error object on failure.

modifyLimitQuery($query, $from, $count, $params = array() X-Ref

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

param: string $query   the query to modify
param: int    $from    the row to start to fetching (0 = the first row)
param: int    $count   the numbers of rows to fetch
param: mixed  $params  array, string or numeric data to be used in
return: string  the query string with LIMIT clauses added

pgsqlRaiseError($errno = null) X-Ref

Produces a DB_Error object regarding the current problem

param: int $errno if the error is being manually raised pass a
return: object the DB_Error object

errorNative() X-Ref

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

{@internal Error messages are used instead of error codes
in order to support older versions of PostgreSQL.}}

return: string the DBMS' error message

errorCode($errormsg) X-Ref

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

param: string $errormsg error message returned from the database
return: integer an error number from a DB error constant

tableInfo($result, $mode = null) X-Ref

Returns information about a table or a result set

NOTE: only supports 'table' and 'flags' if <var>$result</var>
is a table name.

param: object|string  $result  DB_result object from a query or a
param: int            $mode    a valid tableInfo mode
return: array  an associative array with the information requested.

_pgFieldFlags($resource, $num_field, $table_name) X-Ref

Get a column's flags

Supports "not_null", "default_value", "primary_key", "unique_key"
and "multiple_key".  The default value is passed through
rawurlencode() in case there are spaces in it.

param: int $resource   the PostgreSQL result identifier
param: int $num_field  the field number
return: string  the flags

getSpecialQuery($type) X-Ref

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

param: string $type the kind of objects you want to retrieve
return: string the SQL query string or null if the driver doesn't

Author:	Rui Hirokawa <hirokawa@php.net>
Author:	Stig Bakken <ssb@php.net>
Author:	Daniel Convissor <danielc@php.net>
Copyright:	1997-2005 The PHP Group
License:	http://www.php.net/license/3_0.txt PHP License 3.0
Version:	CVS: $Id: pgsql.php,v 1.134 2007/01/12 05:45:09 aharvey Exp $
Poids:	1103 lignes (36 kb)
Inclus ou requis:	0 fois
Référencé:	3 fois
Nécessite:	1 fichier DB/common.php

Code source de PHP PEAR 1.4.5

/DB/ -> pgsql.php (sommaire)

Définit 1 class