API Documentation

Db/Adapter/Pdo/Sqlite.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: Sqlite.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Db_Adapter_Pdo_Sqlite

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_Sqlite

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
__construct
_checkRequiredOptions
_dsn
_connect
listTables
describeTable
limit

Description

Class for connecting to SQLite2 and SQLite3 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 = 'sqlite'

PDO type

Details

$_pdoType
string
visibility
protected
default
sqlite
final
false
static
false

Methods

__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.

Arguments
$config
array
An array of configuration keys.
Details
visibility
public
final
false
static
false

_checkRequiredOptions

_checkRequiredOptions( array $config ) :

Check for config options that are mandatory.

Throw exceptions if any are missing.

Arguments
$config
array
Details
visibility
protected
final
false
static
false
throws

_connect

_connect( ) :

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

Details
visibility
protected
final
false
static
false
throws

_dsn

_dsn( ) :

DSN builder

Details
visibility
protected
final
false
static
false

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

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
Documentation was generated by DocBlox.