Source for file sqlite.php
Documentation is available at sqlite.php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
* The PEAR DB driver for PHP's sqlite extension
* for interacting with SQLite databases
* LICENSE: This source file is subject to version 3.0 of the PHP license
* that is available through the world-wide-web at the following URI:
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
* the PHP License and are unable to obtain it through the web, please
* send a note to license@php.net so we can mail you a copy immediately.
* @author Urs Gehrig <urs@circle.ch>
* @author Mika Tuupola <tuupola@appelsiini.net>
* @author Daniel Convissor <danielc@php.net>
* @copyright 1997-2007 The PHP Group
* @license http://www.php.net/license/3_0.txt PHP License 3.0 3.0
* @version CVS: $Id: sqlite.php,v 1.117 2007/09/21 14:23:28 aharvey Exp $
* @link http://pear.php.net/package/DB
* Obtain the DB_common class so it can be extended from
require_once DB_PEAR_PATH.
'DB/common.php';
* The methods PEAR DB uses to interact with PHP's sqlite extension
* for interacting with SQLite databases
* These methods overload the ones declared in DB_common.
* NOTICE: This driver needs PHP's track_errors ini setting to be on.
* It is automatically turned on when connecting to the database.
* Make sure your scripts don't turn it off.
* @author Urs Gehrig <urs@circle.ch>
* @author Mika Tuupola <tuupola@appelsiini.net>
* @author Daniel Convissor <danielc@php.net>
* @copyright 1997-2007 The PHP Group
* @license http://www.php.net/license/3_0.txt PHP License 3.0 3.0
* @version Release: 1.7.13
* @link http://pear.php.net/package/DB
* The DB driver type (mysql, oci8, odbc, etc.)
* The database syntax variant to be used (db2, access, etc.), if any
* The capabilities of this DB implementation
* The 'new_link' element contains the PHP version that first provided
* new_link support for this DBMS. Contains false if it's unsupported.
* Meaning of the 'limit' element:
* + 'emulate' = emulate with fetch row by number
* + 'alter' = alter the query
* A mapping of native error codes to DB error codes
* {@internal Error codes according to sqlite_exec. See the online
* manual at http://sqlite.org/c_interface.html for info.
* This error handling based on sqlite_exec is not yet implemented.}}}
* The raw database connection created by PHP
* The DSN information for connecting to a database
* @link http://www.sqlite.org/datatypes.html
* The most recent error message from $php_errormsg
* This constructor calls <kbd>$this->DB_common()</kbd>
* Connect to the database server, log in and open the database
* Don't call this method directly. Use DB::connect() instead.
* PEAR DB's sqlite driver supports the following extra DSN options:
* + mode The permissions for the database file, in four digit
* chmod octal format (eg "0600").
* Example of connecting to a database in read-only mode:
* $dsn = 'sqlite:///path/and/name/of/db/file?mode=0400';
* 'portability' => DB_PORTABILITY_ALL,
* $db = DB::connect($dsn, $options);
* if (PEAR::isError($db)) {
* die($db->getMessage());
* @param array $dsn the data source name
* @param bool $persistent should the connection be persistent?
* @return int DB_OK on success. A DB_Error object on failure.
function connect($dsn, $persistent =
false)
if ($dsn['database'] !==
':memory:') {
if (!touch($dsn['database'])) {
if (!isset
($dsn['mode']) ||
if (!chmod($dsn['database'], $mode)) {
$connect_function =
$persistent ?
'sqlite_popen' :
'sqlite_open';
// track_errors must remain on for simpleQuery()
if (!$this->connection =
@$connect_function($dsn['database'])) {
* Disconnects from the database server
* @return bool TRUE on success, FALSE on failure
* Sends a query to the database server
* NOTICE: This method needs PHP's track_errors ini setting to be on.
* It is automatically turned on when connecting to the database.
* Make sure your scripts don't turn it off.
* @param string the SQL query string
* @return mixed + a PHP result resrouce for successful SELECT queries
* + the DB_OK constant for other successful queries
* + a DB_Error object on failure
$this->_lasterror =
$php_errormsg ?
$php_errormsg :
'';
// sqlite_query() seems to allways return a resource
// so cant use that. Using $ismanip instead
$numRows =
$this->numRows($result);
* Move the internal sqlite result pointer to the next available result
* @param resource $result the valid sqlite result resource
* @return bool true if a result is available otherwise return false
* Places a row from the result set into the given array
* Formating of the array and the data therein are configurable.
* See DB_result::fetchInto() for more information.
* This method is not meant to be called directly. Use
* DB_result::fetchInto() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result the query result resource
* @param array $arr the referenced array to put the data in
* @param int $fetchmode how the resulting array should be indexed
* @param int $rownum the row number to fetch (0 = first row)
* @return mixed DB_OK on success, NULL when the end of a result set is
* @see DB_result::fetchInto()
function fetchInto($result, &$arr, $fetchmode, $rownum =
null)
/* Remove extraneous " characters from the fields in the result.
foreach ($arr as $field =>
$value) {
$strippedArr[trim($field, '"')] =
$value;
* Even though this DBMS already trims output, we do this because
* a field might have intentional whitespace at the end that
* gets removed by DB_PORTABILITY_RTRIM under another driver.
* Deletes the result set and frees the memory occupied by the result set
* This method is not meant to be called directly. Use
* DB_result::free() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return bool TRUE on success, FALSE if $result is invalid
* Gets the number of columns in a result set
* This method is not meant to be called directly. Use
* DB_result::numCols() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return int the number of columns. A DB_Error object on failure.
* @see DB_result::numCols()
* Gets the number of rows in a result set
* This method is not meant to be called directly. Use
* DB_result::numRows() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return int the number of rows. A DB_Error object on failure.
* @see DB_result::numRows()
* Determines the number of rows affected by a data maniuplation query
* 0 is returned for queries that don't manipulate data.
* @return int the number of rows. A DB_Error object on failure.
* @param string $seq_name name of the sequence to be deleted
* @return int DB_OK on success. A DB_Error object on failure.
* @see DB_common::dropSequence(), DB_common::getSequenceName(),
* DB_sqlite::nextID(), DB_sqlite::createSequence()
* @param string $seq_name name of the new sequence
* @return int DB_OK on success. A DB_Error object on failure.
* @see DB_common::createSequence(), DB_common::getSequenceName(),
* DB_sqlite::nextID(), DB_sqlite::dropSequence()
$query =
'CREATE TABLE ' .
$seqname .
' (id INTEGER UNSIGNED PRIMARY KEY) ';
$result =
$this->query($query);
$query =
"CREATE TRIGGER ${seqname}_cleanup AFTER INSERT ON $seqname
DELETE FROM $seqname WHERE id<LAST_INSERT_ROWID();
$result =
$this->query($query);
* Returns the next free id in a sequence
* @param string $seq_name name of the sequence
* @param boolean $ondemand when true, the seqence is automatically
* created if it does not exist
* @return int the next id number in the sequence.
* A DB_Error object on failure.
* @see DB_common::nextID(), DB_common::getSequenceName(),
* DB_sqlite::createSequence(), DB_sqlite::dropSequence()
function nextId($seq_name, $ondemand =
true)
$result =
$this->query("INSERT INTO $seqname (id) VALUES (NULL)");
} elseif ($ondemand &&
DB::isError($result) &&
* Get the file stats for the current database
* Possible arguments are dev, ino, mode, nlink, uid, gid, rdev, size,
* atime, mtime, ctime, blksize, blocks or a numeric key between
* @param string $arg the array key for stats()
* @return mixed an array on an unspecified key, integer on a passed
* arg and false at a stats error
$stats =
stat($this->dsn['database']);
if (((int)
$arg <=
12) & ((int)
$arg >=
0)) {
* Escapes a string according to the current DBMS's standards
* In SQLite, this makes things safe for inserts/updates, but may
* cause problems when performing text comparisons against columns
* containing binary data. See the
* {@link http://php.net/sqlite_escape_string PHP manual} for more info.
* @param string $str the string to be escaped
* @return string the escaped string
* @since Method available since Release 1.6.1
* @see DB_common::escapeSimple()
// {{{ modifyLimitQuery()
* Adds LIMIT clauses to a query string according to current DBMS standards
* @param string $query the query to modify
* @param int $from the row to start to fetching (0 = the first row)
* @param int $count the numbers of rows to fetch
* @param mixed $params array, string or numeric data to be used in
* execution of the statement. Quantity of items
* passed must match quantity of placeholders in
* query: meaning 1 placeholder for non-array
* parameters or 1 placeholder per array element.
* @return string the query string with LIMIT clauses added
return "$query LIMIT $count OFFSET $from";
* Changes a query string for various DBMS specific reasons
* This little hack lets you know how many rows were deleted
* when running a "DELETE FROM table" query. Only implemented
* if the DB_PORTABILITY_DELETE_COUNT portability option is on.
* @param string $query the query string to modify
* @return string the modified query string
* @see DB_common::setOption()
if (preg_match('/^\s*DELETE\s+FROM\s+(\S+)\s*$/i', $query)) {
'DELETE FROM \1 WHERE 1=1', $query);
// {{{ sqliteRaiseError()
* Produces a DB_Error object regarding the current problem
* @param int $errno if the error is being manually raised pass a
* DB_ERROR* constant here. If this isn't passed
* the error information gathered from the DBMS.
* @return object the DB_Error object
* @see DB_common::raiseError(),
* DB_sqlite::errorNative(), DB_sqlite::errorCode()
return $this->raiseError($errno, null, null, $userinfo, $native);
* Gets the DBMS' native error message produced by the last query
* {@internal This is used to retrieve more meaningfull error messages
* because sqlite_last_error() does not provide adequate info.}}}
* @return string the DBMS' error message
return $this->_lasterror;
* Determines PEAR::DB error code from the database's text error message
* @param string $errormsg the error message returned from the database
* @return integer the DB error number
// PHP 5.2+ prepends the function name to $php_errormsg, so we need
// this hack to work around it, per bug #9599.
$errormsg =
preg_replace('/^sqlite[a-z_]+\(\): /', '', $errormsg);
if (!isset
($error_regexps)) {
foreach ($error_regexps as $regexp =>
$code) {
// Fall back to DB_ERROR if there was no mapping.
* Returns information about a table
* @param string $result a string containing the name of a table
* @param int $mode a valid tableInfo mode
* @return array an associative array with the information requested.
* A DB_Error object on failure.
* @see DB_common::tableInfo()
* @since Method available since Release 1.7.0
* Probably received a table name.
* Create a result resource identifier.
"PRAGMA table_info('$result');",
'This DBMS can not obtain tableInfo' .
$case_func =
'strtolower';
$res['num_fields'] =
$count;
for ($i =
0; $i <
$count; $i++
) {
if (strpos($id[$i]['type'], '(') !==
false) {
$bits =
explode('(', $id[$i]['type']);
$len =
rtrim($bits[1],')');
$flags .=
'primary_key ';
if ($id[$i]['notnull']) {
if ($id[$i]['dflt_value'] !==
null) {
'table' =>
$case_func($result),
'name' =>
$case_func($id[$i]['name']),
$res['order'][$res[$i]['name']] =
$i;
$res['ordertable'][$res[$i]['table']][$res[$i]['name']] =
$i;
* Obtains the query string needed for listing a given type of objects
* @param string $type the kind of objects you want to retrieve
* @param array $args SQLITE DRIVER ONLY: a private array of arguments
* used by the getSpecialQuery(). Do not use
* @return string the SQL query string or null if the driver doesn't
* support the object type requested
* @see DB_common::getListOf()
return $this->raiseError('no key specified', null, null, null,
'Argument has to be an array.');
return 'SELECT * FROM sqlite_master;';
return "SELECT name FROM sqlite_master WHERE type='table' "
.
'UNION ALL SELECT name FROM sqlite_temp_master '
.
"WHERE type='table' ORDER BY name;";
return 'SELECT sql FROM (SELECT * FROM sqlite_master '
.
'UNION ALL SELECT * FROM sqlite_temp_master) '
.
'ORDER BY tbl_name, type DESC, name;';
* $res = $db->query($db->getSpecialQuery('schema_x',
* array('table' => 'table3')));
return 'SELECT sql FROM (SELECT * FROM sqlite_master '
.
'UNION ALL SELECT * FROM sqlite_temp_master) '
.
"WHERE tbl_name LIKE '{$args['table']}' "
.
'ORDER BY type DESC, name;';
* SQLite does not support ALTER TABLE; this is a helper query
* to handle this. 'table' represents the table name, 'rows'
* the news rows to create, 'save' the row(s) to keep _with_
* 'rows' => "id INTEGER PRIMARY KEY, firstname TEXT, surname TEXT, datetime TEXT",
* 'save' => "NULL, titel, content, datetime"
* $res = $db->query( $db->getSpecialQuery('alter', $args));
"CREATE TEMPORARY TABLE {$args['table']}_backup ({$args['rows']})",
"INSERT INTO {$args['table']}_backup SELECT {$args['save']} FROM {$args['table']}",
"DROP TABLE {$args['table']}",
"CREATE TABLE {$args['table']} ({$args['rows']})",
"INSERT INTO {$args['table']} SELECT {$rows} FROM {$args['table']}_backup",
"DROP TABLE {$args['table']}_backup",
* This is a dirty hack, since the above query will not get
* executed with a single query call so here the query method
* will be called directly and return a select instead.
return "SELECT * FROM {$args['table']};";
Documentation generated on Wed, 09 Feb 2011 09:04:41 +0700 by phpDocumentor 1.4.2