Zend_Db_Adapter_Pdo_Sqlite Class Reference

Inheritance diagram for Zend_Db_Adapter_Pdo_Sqlite:

Public Member Functions
	__construct (array $config=array())
	listTables ()
	describeTable ($tableName, $schemaName=null)
	limit ($sql, $count, $offset=0)
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
	_checkRequiredOptions (array $config)
	_dsn ()
	_connect ()
	_quote ($value)
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 = 'sqlite'
	$_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 Sqlite.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$config = array()

)

Constructor.

$config is an array of key/value pairs containing configuration options. Note that the SQLite options are different than most of the other PDO adapters in that no username or password are needed. Also, an extra config key "sqlite2" specifies compatibility mode.

dbname => (string) The name of the database to user (required, use :memory: for memory-based database)

sqlite2 => (boolean) PDO_SQLITE defaults to SQLite 3. For compatibility with an older SQLite 2 database, set this to TRUE.

Parameters

array

$config

An array of configuration keys.

Definition at line 84 of file Sqlite.php.

    {
        if (isset($config['sqlite2']) && $config['sqlite2']) {
            $this->_pdoType = 'sqlite2';
        }

        // SQLite uses no username/password.  Stub to satisfy parent::_connect()
        $this->_config['username'] = null;
        $this->_config['password'] = null;

        return parent::__construct($config);
    }

Member Function Documentation

_checkRequiredOptions()

_checkRequiredOptions ( array  $config )

protected

Check for config options that are mandatory. Throw exceptions if any are missing.

Parameters

array

$config

Exceptions

Zend_Db_Adapter_Exception

See also

Zend_Db_Adapter_Exception

Definition at line 104 of file Sqlite.php.

    {
        // we need at least a dbname
        if (! array_key_exists('dbname', $config)) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception("Configuration array must have a key for 'dbname' that names the database instance");
        }
    }

_connect()

_connect ( )

protected

Special configuration for SQLite behavior: make sure that result sets contain keys like 'column' instead of 'table.column'.

Exceptions

Zend_Db_Adapter_Exception

if we already have a PDO object, no need to re-connect.

See also

Zend_Db_Adapter_Exception

Zend_Db_Adapter_Exception

Definition at line 128 of file Sqlite.php.

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

        parent::_connect();

        $retval = $this->_connection->exec('PRAGMA full_column_names=0');
        if ($retval === false) {
            $error = $this->_connection->errorInfo();
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception($error[2]);
        }

        $retval = $this->_connection->exec('PRAGMA short_column_names=1');
        if ($retval === false) {
            $error = $this->_connection->errorInfo();
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception($error[2]);
        }
    }

_dsn()

_dsn ( )

protected

DSN builder

Definition at line 117 of file Sqlite.php.

    {
        return $this->_pdoType .':'. $this->_config['dbname'];
    }

_quote()

_quote (   $value )

protected

Quote a raw string.

Parameters

string

$value

Raw string

Returns

string Quoted string

Definition at line 303 of file Sqlite.php.

    {
        if (!is_int($value) && !is_float($value)) {
            // Fix for null-byte injection
            $value = addcslashes($value, "\000\032");
        }
        return parent::_quote($value);
    }

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

Parameters

string	$tableName
string	$schemaName	OPTIONAL

Returns

array

Use FETCH_NUM so we are not dependent on the CASE attribute of the PDO connection

SQLite INTEGER primary key is always auto-increment.

Definition at line 198 of file Sqlite.php.

    {
        $sql = 'PRAGMA ';

        if ($schemaName) {
            $sql .= $this->quoteIdentifier($schemaName) . '.';
        }

        $sql .= 'table_info('.$this->quoteIdentifier($tableName).')';

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

        $result = $stmt->fetchAll(Zend_Db::FETCH_NUM);

        $cid        = 0;
        $name       = 1;
        $type       = 2;
        $notnull    = 3;
        $dflt_value = 4;
        $pk         = 5;

        $desc = array();

        $p = 1;
        foreach ($result as $key => $row) {
            list($length, $scale, $precision, $primary, $primaryPosition, $identity) =
                array(null, null, null, false, null, false);
            if (preg_match('/^((?:var)?char)\((\d+)\)/i', $row[$type], $matches)) {
                $row[$type] = $matches[1];
                $length = $matches[2];
            } else if (preg_match('/^decimal\((\d+),(\d+)\)/i', $row[$type], $matches)) {
                $row[$type] = 'DECIMAL';
                $precision = $matches[1];
                $scale = $matches[2];
            }
            if ((bool) $row[$pk]) {
                $primary = true;
                $primaryPosition = $p;
                $identity = (bool) ($row[$type] == 'INTEGER');
                ++$p;
            }
            $desc[$this->foldCase($row[$name])] = array(
                'SCHEMA_NAME'      => $this->foldCase($schemaName),
                'TABLE_NAME'       => $this->foldCase($tableName),
                'COLUMN_NAME'      => $this->foldCase($row[$name]),
                'COLUMN_POSITION'  => $row[$cid]+1,
                'DATA_TYPE'        => $row[$type],
                'DEFAULT'          => $row[$dflt_value],
                'NULLABLE'         => ! (bool) $row[$notnull],
                'LENGTH'           => $length,
                'SCALE'            => $scale,
                'PRECISION'        => $precision,
                'UNSIGNED'         => null, // Sqlite3 does not support unsigned data
                'PRIMARY'          => $primary,
                'PRIMARY_POSITION' => $primaryPosition,
                'IDENTITY'         => $identity
            );
        }
        return $desc;
    }

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 273 of file Sqlite.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 161 of file Sqlite.php.

    {
        $sql = "SELECT name FROM sqlite_master WHERE type='table' "
             . "UNION ALL SELECT name FROM sqlite_temp_master "
             . "WHERE type='table' ORDER BY name";

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

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::BIGINT_TYPE,
        'REAL'               => Zend_Db::FLOAT_TYPE
    )

Definition at line 60 of file Sqlite.php.

$_pdoType

$_pdoType = 'sqlite'

protected

Definition at line 47 of file Sqlite.php.

---

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

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