API Documentation

Db/Adapter/Pdo/Pgsql.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Db
subpackage
Adapter
version
$Id: Pgsql.php 22789 2010-08-03 19:01:10Z ramon $
Classes
Zend_Db_Adapter_Pdo_Pgsql

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Db_Adapter_Pdo_Pgsql

Extends from
Zend_Db_Adapter_Pdo_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Db
subpackage
Adapter
Properties
$_pdoType
$_numericDataTypes
Methods
_connect
listTables
describeTable
limit
lastSequenceId
nextSequenceId
lastInsertId

Description

Class for connecting to PostgreSQL databases and performing common operations.

Properties

$_numericDataTypes

array $_numericDataTypes = 'array'

Keys are UPPERCASE SQL datatypes or the constants Zend_Db::INT_TYPE, Zend_Db::BIGINT_TYPE, or Zend_Db::FLOAT_TYPE.

Values are: 0 = 32-bit integer 1 = 64-bit integer 2 = float or decimal

Details

$_numericDataTypes
array
Associative array of datatypes to values 0, 1, or 2.
visibility
protected
default
array
final
false
static
false

$_pdoType

string $_pdoType = 'pgsql'

PDO type.

Details

$_pdoType
string
visibility
protected
default
pgsql
final
false
static
false

Methods

_connect

_connect( ) : void

Creates a PDO object and connects to the database.

Details
visibility
protected
final
false
static
false
throws

describeTable

describeTable( string $tableName, string $schemaName = null ) : array

Returns the column descriptions for a table.

The return value is an associative array keyed by the column name, as returned by the RDBMS.

The value of each array element is an associative array with the following keys:

SCHEMA_NAME => string; name of database or schema TABLE_NAME => string; COLUMN_NAME => string; column name COLUMN_POSITION => number; ordinal position of column in table DATA_TYPE => string; SQL datatype name of column DEFAULT => string; default expression of column, null if none NULLABLE => boolean; true if column can have nulls LENGTH => number; length of CHAR/VARCHAR SCALE => number; scale of NUMERIC/DECIMAL PRECISION => number; precision of NUMERIC/DECIMAL UNSIGNED => boolean; unsigned property of an integer type PRIMARY => boolean; true if column is part of the primary key PRIMARY_POSITION => integer; position of column in primary key IDENTITY => integer; true if column is auto-generated with unique values

Arguments
$tableName
string
$schemaName
string
OPTIONAL
Output
array
Details
visibility
public
final
false
static
false
todo
Discover integer unsigned property.

lastInsertId

lastInsertId( string $tableName = null, string $primaryKey = null ) : string

Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.

As a convention, on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2), this method forms the name of a sequence from the arguments and returns the last id generated by that sequence. On RDBMS brands that support IDENTITY/AUTOINCREMENT columns, this method returns the last value generated for such a column, and the table name argument is disregarded.

Arguments
$tableName
string
OPTIONAL Name of table.
$primaryKey
string
OPTIONAL Name of primary key column.
Output
string
Details
visibility
public
final
false
static
false

lastSequenceId

lastSequenceId( string $sequenceName ) : string

Return the most recent value from the specified sequence in the database.

This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

Arguments
$sequenceName
string
Output
string
Details
visibility
public
final
false
static
false

limit

limit( string $sql, integer $count, integer $offset = 0 ) : string

Adds an adapter-specific LIMIT clause to the SELECT statement.

Arguments
$sql
string
$count
integer
$offset
integer
OPTIONAL
Output
string
Details
visibility
public
final
false
static
false

listTables

listTables( ) : array

Returns a list of the tables in the database.

Output
array
Details
visibility
public
final
false
static
false

nextSequenceId

nextSequenceId( string $sequenceName ) : string

Generate a new value from the specified sequence in the database, and return it.

This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

Arguments
$sequenceName
string
Output
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.