Zend_Db_Adapter_Pdo_Pgsql Class Reference

Inheritance diagram for Zend_Db_Adapter_Pdo_Pgsql:

Public Member Functions
	listTables ()
	describeTable ($tableName, $schemaName=null)
	limit ($sql, $count, $offset=0)
	lastSequenceId ($sequenceName)
	nextSequenceId ($sequenceName)
	lastInsertId ($tableName=null, $primaryKey=null)
Public Member Functions inherited from Zend_Db_Adapter_Pdo_Abstract
	isConnected ()
	closeConnection ()
	prepare ($sql)
	lastInsertId ($tableName=null, $primaryKey=null)
	query ($sql, $bind=array())
	exec ($sql)
	setFetchMode ($mode)
	supportsParameters ($type)
	getServerVersion ()
Public Member Functions inherited from Zend_Db_Adapter_Abstract
	__construct ($config)
	getConnection ()
	getConfig ()
	setProfiler ($profiler)
	getProfiler ()
	getStatementClass ()
	setStatementClass ($class)
	query ($sql, $bind=array())
	beginTransaction ()
	commit ()
	rollBack ()
	insert ($table, array $bind)
	update ($table, array $bind, $where='')
	delete ($table, $where='')
	select ()
	getFetchMode ()
	fetchAll ($sql, $bind=array(), $fetchMode=null)
	fetchRow ($sql, $bind=array(), $fetchMode=null)
	fetchAssoc ($sql, $bind=array())
	fetchCol ($sql, $bind=array())
	fetchPairs ($sql, $bind=array())
	fetchOne ($sql, $bind=array())
	quote ($value, $type=null)
	quoteInto ($text, $value, $type=null, $count=null)
	quoteIdentifier ($ident, $auto=false)
	quoteColumnAs ($ident, $alias, $auto=false)
	quoteTableAs ($ident, $alias=null, $auto=false)
	getQuoteIdentifierSymbol ()
	lastSequenceId ($sequenceName)
	nextSequenceId ($sequenceName)
	foldCase ($key)
	__sleep ()
	__wakeup ()
	listTables ()
	describeTable ($tableName, $schemaName=null)
	isConnected ()
	closeConnection ()
	prepare ($sql)
	lastInsertId ($tableName=null, $primaryKey=null)
	setFetchMode ($mode)
	limit ($sql, $count, $offset=0)
	supportsParameters ($type)
	getServerVersion ()

Protected Member Functions
	_connect ()
Protected Member Functions inherited from Zend_Db_Adapter_Pdo_Abstract
	_dsn ()
	_connect ()
	_quote ($value)
	_beginTransaction ()
	_commit ()
	_rollBack ()
Protected Member Functions inherited from Zend_Db_Adapter_Abstract
	_checkRequiredOptions (array $config)
	_whereExpr ($where)
	_quote ($value)
	_quoteIdentifierAs ($ident, $alias=null, $auto=false, $as=' AS ')
	_quoteIdentifier ($value, $auto=false)
	_connect ()
	_beginTransaction ()
	_commit ()
	_rollBack ()

Protected Attributes
	$_pdoType = 'pgsql'
	$_numericDataTypes
Protected Attributes inherited from Zend_Db_Adapter_Pdo_Abstract
	$_defaultStmtClass = 'Zend_Db_Statement_Pdo'
Protected Attributes inherited from Zend_Db_Adapter_Abstract
	$_config = array()
	$_fetchMode = Zend_Db::FETCH_ASSOC
	$_profiler
	$_defaultStmtClass = 'Zend_Db_Statement'
	$_defaultProfilerClass = 'Zend_Db_Profiler'
	$_connection = null
	$_caseFolding = Zend_Db::CASE_NATURAL
	$_autoQuoteIdentifiers = true
	$_numericDataTypes
	$_allowSerialization = true
	$_autoReconnectOnUnserialize = false

Detailed Description

Definition at line 39 of file Pgsql.php.

Member Function Documentation

_connect()

_connect ( )

protected

Creates a PDO object and connects to the database.

Returns

void

Exceptions

Zend_Db_Adapter_Exception

Definition at line 81 of file Pgsql.php.

    {
        if ($this->_connection) {
            return;
        }

        parent::_connect();

        if (!empty($this->_config['charset'])) {
            $sql = "SET NAMES '" . $this->_config['charset'] . "'";
            $this->_connection->exec($sql);
        }
    }

describeTable()

describeTable	(		$tableName,
			$schemaName = null
	)

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

Todo:

Discover integer unsigned property.

Parameters

string	$tableName
string	$schemaName	OPTIONAL

Returns

array

Definition at line 149 of file Pgsql.php.

    {
        $sql = "SELECT
                a.attnum,
                n.nspname,
                c.relname,
                a.attname AS colname,
                t.typname AS type,
                a.atttypmod,
                FORMAT_TYPE(a.atttypid, a.atttypmod) AS complete_type,
                d.adsrc AS default_value,
                a.attnotnull AS notnull,
                a.attlen AS length,
                co.contype,
                ARRAY_TO_STRING(co.conkey, ',') AS conkey
            FROM pg_attribute AS a
                JOIN pg_class AS c ON a.attrelid = c.oid
                JOIN pg_namespace AS n ON c.relnamespace = n.oid
                JOIN pg_type AS t ON a.atttypid = t.oid
                LEFT OUTER JOIN pg_constraint AS co ON (co.conrelid = c.oid
                    AND a.attnum = ANY(co.conkey) AND co.contype = 'p')
                LEFT OUTER JOIN pg_attrdef AS d ON d.adrelid = c.oid AND d.adnum = a.attnum
            WHERE a.attnum > 0 AND c.relname = ".$this->quote($tableName);
        if ($schemaName) {
            $sql .= " AND n.nspname = ".$this->quote($schemaName);
        }
        $sql .= ' ORDER BY a.attnum';

        $stmt = $this->query($sql);

        // Use FETCH_NUM so we are not dependent on the CASE attribute of the PDO connection
        $result = $stmt->fetchAll(Zend_Db::FETCH_NUM);

        $attnum        = 0;
        $nspname       = 1;
        $relname       = 2;
        $colname       = 3;
        $type          = 4;
        $atttypemod    = 5;
        $complete_type = 6;
        $default_value = 7;
        $notnull       = 8;
        $length        = 9;
        $contype       = 10;
        $conkey        = 11;

        $desc = array();
        foreach ($result as $key => $row) {
            $defaultValue = $row[$default_value];
            if ($row[$type] == 'varchar' || $row[$type] == 'bpchar' ) {
                if (preg_match('/character(?: varying)?(?:\((\d+)\))?/', $row[$complete_type], $matches)) {
                    if (isset($matches[1])) {
                        $row[$length] = $matches[1];
                    } else {
                        $row[$length] = null; // unlimited
                    }
                }
                if (preg_match("/^'(.*?)'::(?:character varying|bpchar)$/", $defaultValue, $matches)) {
                    $defaultValue = $matches[1];
                }
            }
            list($primary, $primaryPosition, $identity) = array(false, null, false);
            if ($row[$contype] == 'p') {
                $primary = true;
                $primaryPosition = array_search($row[$attnum], explode(',', $row[$conkey])) + 1;
                $identity = (bool) (preg_match('/^nextval/', $row[$default_value]));
            }
            $desc[$this->foldCase($row[$colname])] = array(
                'SCHEMA_NAME'      => $this->foldCase($row[$nspname]),
                'TABLE_NAME'       => $this->foldCase($row[$relname]),
                'COLUMN_NAME'      => $this->foldCase($row[$colname]),
                'COLUMN_POSITION'  => $row[$attnum],
                'DATA_TYPE'        => $row[$type],
                'DEFAULT'          => $defaultValue,
                'NULLABLE'         => (bool) ($row[$notnull] != 't'),
                'LENGTH'           => $row[$length],
                'SCALE'            => null, // @todo
                'PRECISION'        => null, // @todo
                'UNSIGNED'         => null, // @todo
                'PRIMARY'          => $primary,
                'PRIMARY_POSITION' => $primaryPosition,
                'IDENTITY'         => $identity
            );
        }
        return $desc;
    }

lastInsertId()

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

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.

Parameters

string	$tableName	OPTIONAL Name of table.
string	$primaryKey	OPTIONAL Name of primary key column.

Returns

string

Definition at line 323 of file Pgsql.php.

    {
        if ($tableName !== null) {
            $sequenceName = $tableName;
            if ($primaryKey) {
                $sequenceName .= "_$primaryKey";
            }
            $sequenceName .= '_seq';
            return $this->lastSequenceId($sequenceName);
        }
        return $this->_connection->lastInsertId($tableName);
    }

lastSequenceId()

lastSequenceId

(

$sequenceName

)

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.

Parameters

string

$sequenceName

Returns

string

Definition at line 281 of file Pgsql.php.

    {
        $this->_connect();
        $sequenceName = str_replace($this->getQuoteIdentifierSymbol(), '', (string) $sequenceName);
        $value = $this->fetchOne("SELECT CURRVAL("
               . $this->quote($this->quoteIdentifier($sequenceName, true))
               . ")");
        return $value;
    }

limit()

limit	(		$sql,
			$count,
			$offset = 0
	)

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

Parameters

string	$sql
integer	$count
integer	$offset	OPTIONAL

Returns

string

See also

Zend_Db_Adapter_Exception

Zend_Db_Adapter_Exception

Definition at line 245 of file Pgsql.php.

    {
        $count = intval($count);
        if ($count <= 0) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception("LIMIT argument count=$count is not valid");
        }

        $offset = intval($offset);
        if ($offset < 0) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception("LIMIT argument offset=$offset is not valid");
        }

        $sql .= " LIMIT $count";
        if ($offset > 0) {
            $sql .= " OFFSET $offset";
        }

        return $sql;
    }

listTables()

listTables

(

)

Returns a list of the tables in the database.

Returns

array

Definition at line 100 of file Pgsql.php.

    {
        // @todo use a better query with joins instead of subqueries
        $sql = "SELECT c.relname AS table_name "
             . "FROM pg_class c, pg_user u "
             . "WHERE c.relowner = u.usesysid AND c.relkind = 'r' "
             . "AND NOT EXISTS (SELECT 1 FROM pg_views WHERE viewname = c.relname) "
             . "AND c.relname !~ '^(pg_|sql_)' "
             . "UNION "
             . "SELECT c.relname AS table_name "
             . "FROM pg_class c "
             . "WHERE c.relkind = 'r' "
             . "AND NOT EXISTS (SELECT 1 FROM pg_views WHERE viewname = c.relname) "
             . "AND NOT EXISTS (SELECT 1 FROM pg_user WHERE usesysid = c.relowner) "
             . "AND c.relname !~ '^pg_'";

        return $this->fetchCol($sql);
    }

nextSequenceId()

nextSequenceId

(

$sequenceName

)

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.

Parameters

string

$sequenceName

Returns

string

Definition at line 299 of file Pgsql.php.

    {
        $this->_connect();
        $sequenceName = str_replace($this->getQuoteIdentifierSymbol(), '', (string) $sequenceName);
        $value = $this->fetchOne("SELECT NEXTVAL("
               . $this->quote($this->quoteIdentifier($sequenceName, true))
               . ")");
        return $value;
    }

Field Documentation

$_numericDataTypes

$_numericDataTypes

protected

Initial value:

= array(
        Zend_Db::INT_TYPE    => Zend_Db::INT_TYPE,
        Zend_Db::BIGINT_TYPE => Zend_Db::BIGINT_TYPE,
        Zend_Db::FLOAT_TYPE  => Zend_Db::FLOAT_TYPE,
        'INTEGER'            => Zend_Db::INT_TYPE,
        'SERIAL'             => Zend_Db::INT_TYPE,
        'SMALLINT'           => Zend_Db::INT_TYPE,
        'BIGINT'             => Zend_Db::BIGINT_TYPE,
        'BIGSERIAL'          => Zend_Db::BIGINT_TYPE,
        'DECIMAL'            => Zend_Db::FLOAT_TYPE,
        'DOUBLE PRECISION'   => Zend_Db::FLOAT_TYPE,
        'NUMERIC'            => Zend_Db::FLOAT_TYPE,
        'REAL'               => Zend_Db::FLOAT_TYPE
    )

Definition at line 60 of file Pgsql.php.

$_pdoType

$_pdoType = 'pgsql'

protected

Definition at line 47 of file Pgsql.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Db/Adapter/Pdo/Pgsql.php