API Documentation

Zend/Db/Adapter/Pdo/Sqlite.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Db  
Subpackage
Adapter  
Version
$Id: Sqlite.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Db_Adapter_Pdo_Sqlite

Package: Zend\Db\Adapter

Class for connecting to SQLite2 and SQLite3 databases and performing common operations.

Parent(s)
\Zend_Db_Adapter_Pdo_Abstract < \Zend_Db_Adapter_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_numericDataTypes= 'array( Zend_Db::INT_TYPE => Zend_Db::INT_TYPE'

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

Associative array of datatypes to values 0, 1, or 2.

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

Default valuearray( Zend_Db::INT_TYPE => Zend_Db::INT_TYPEDetails
Type
array
Propertyprotectedstring  $_pdoType= ''sqlite''

PDO type

Default value'sqlite'Details
Type
string

Methods

methodpublic__construct( array $config = array() ) : void

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
Name Type Description
$config array

An array of configuration keys.

methodprotected_checkRequiredOptions( array $config ) : void

Check for config options that are mandatory.

Throw exceptions if any are missing.

Parameters
Name Type Description
$config array
Throws
Exception Description
\Zend_Db_Adapter_Exception
methodprotected_connect( ) : void

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

Throws
Exception Description
\Zend_Db_Adapter_Exception
methodprotected_dsn( ) : void

DSN builder

methodpublicdescribeTable( 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

Parameters
Name Type Description
$tableName string
$schemaName string

OPTIONAL

Returns
Type Description
array
methodpubliclimit( string $sql, integer $count, integer $offset = 0 ) : string

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

Parameters
Name Type Description
$sql string
$count integer
$offset integer

OPTIONAL

Returns
Type Description
string
methodpubliclistTables( ) : array

Returns a list of the tables in the database.

Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.