SQLite Functions
Predefined Classes
SQLiteDatabase
Represents an opened SQLite database.
Constructor
- __construct - construct a new SQLiteDatabase object
Methods
- query - Execute a query
- queryExec - Execute a result-less query
- arrayQuery - Execute a query and return the result as an array
- singleQuery - Execute a query and return either an array for one single column or the value of the first row
- unbufferedQuery - Execute an unbuffered query
- lastInsertRowid - Returns the rowid of the most recently inserted row
- changes - Returns the number of rows changed by the most recent statement
- createAggregate - Register an aggregating UDF for use in SQL statements
- createFunction - Register a UDF for use in SQL statements
- busyTimeout - Sets or disables busy timeout duration
- lastError - Returns the last error code of the most recently encountered error
- fetchColumnTypes - Return an array of column types from a particular table
SQLiteResult
Represents a buffered SQLite result set.
Methods
- fetch - Fetches the next row from the result set as an array
- fetchObject - Fetches the next row from the result set as an object
- fetchSingle - Fetches the first column from the result set as a string
- fetchAll - Fetches all rows from the result set as an array of arrays
- column - Fetches a column from the current row of the result set
- numFields - Returns the number of fields in the result set
- fieldName - Returns the name of a particular field in the result set
- current - Fetches the current row from the result set as an array
- key - Return the current row index
- next - Seek to the next row number
- valid - Returns whether more rows are available
- rewind - Seek to the first row number of the result set
- prev - Seek to the previous row number of the result set
- hasPrev - Returns whether or not a previous row is available
- numRows - Returns the number of rows in the result set
- seek - Seek to a particular row number
SQLiteUnbuffered
Represents an unbuffered SQLite result set. Unbuffered results sets are sequential, forward-seeking only.
Methods
- fetch - Fetches the next row from the result set as an array
- fetchObject - Fetches the next row from the result set as an object
- fetchSingle - Fetches the first column from the result set as a string
- fetchAll - Fetches all rows from the result set as an array of arrays
- column - Fetches a column from the current row of the result set
- numFields - Returns the number of fields in the result set
- fieldName - Returns the name of a particular field in the result set
- current - Fetches the current row from the result set as an array
- next - Seek to the next row number
- valid - Returns whether more rows are available
Table of Contents
- sqlite_array_query — Execute a query against a given database and returns an array
- sqlite_busy_timeout — Set busy timeout duration, or disable busy handlers
- sqlite_changes — Returns the number of rows that were changed by the most recent SQL statement
- sqlite_close — Closes an open SQLite database
- sqlite_column — Fetches a column from the current row of a result set
- sqlite_create_aggregate — Register an aggregating UDF for use in SQL statements
- sqlite_create_function — Registers a "regular" User Defined Function for use in SQL statements
- sqlite_current — Fetches the current row from a result set as an array
- sqlite_error_string — Returns the textual description of an error code
- sqlite_escape_string — Escapes a string for use as a query parameter
- sqlite_exec — Executes a result-less query against a given database
- sqlite_factory — Opens an SQLite database and returns an SQLiteDatabase object
- sqlite_fetch_all — Fetches all rows from a result set as an array of arrays
- sqlite_fetch_array — Fetches the next row from a result set as an array
- sqlite_fetch_column_types — Return an array of column types from a particular table
- sqlite_fetch_object — Fetches the next row from a result set as an object
- sqlite_fetch_single — Fetches the first column of a result set as a string
- sqlite_fetch_string — Alias of sqlite_fetch_single
- sqlite_field_name — Returns the name of a particular field
- sqlite_has_more — Finds whether or not more rows are available
- sqlite_has_prev — Returns whether or not a previous row is available
- sqlite_key — Returns the current row index
- sqlite_last_error — Returns the error code of the last error for a database
- sqlite_last_insert_rowid — Returns the rowid of the most recently inserted row
- sqlite_libencoding — Returns the encoding of the linked SQLite library
- sqlite_libversion — Returns the version of the linked SQLite library
- sqlite_next — Seek to the next row number
- sqlite_num_fields — Returns the number of fields in a result set
- sqlite_num_rows — Returns the number of rows in a buffered result set
- sqlite_open — Opens an SQLite database and create the database if it does not exist
- sqlite_popen — Opens a persistent handle to an SQLite database and create the database if it does not exist
- sqlite_prev — Seek to the previous row number of a result set
- sqlite_query — Executes a query against a given database and returns a result handle
- sqlite_rewind — Seek to the first row number
- sqlite_seek — Seek to a particular row number of a buffered result set
- sqlite_single_query — Executes a query and returns either an array for one single column or the value of the first row
- sqlite_udf_decode_binary — Decode binary data passed as parameters to an UDF
- sqlite_udf_encode_binary — Encode binary data before returning it from an UDF
- sqlite_unbuffered_query — Execute a query that does not prefetch and buffer all data
- sqlite_valid — Returns whether more rows are available
Коментарии
If you gone in trouble while/with installation of sqlite,
you can try the installation steps I've done at
RedHat9 with PHP4.3.4 and Apache 1.3.28
via the Linux shell:
# wget http://pecl.php.net/get/SQLite-1.0.tgz
# tar xzf SQLite-1.0.tgz
# cd sqlite
# export PHP_PREFIX="/usr"
# $PHP_PREFIX/bin/phpize
# ./configure
# make
# make install
After that add following to php.ini and restart Apache:
[sqlite]
extension="sqlite.so"
if you are going to send INSERT queries, you will need to make the folder, where you put your "file.db", writable by a web server user, otherwise you'll receive error message - "Unable to open database . . . ". File permissions are not enough (phpinfo - SQLite Lib 2.8.3)For those looking for a function similar to mysql_list_tables, here you have:
if (! function_exists ('sqlite_list_tables')) {
function sqlite_list_tables (&$dblink) {
$tables = array ();
$sql = "SELECT name FROM sqlite_master WHERE (type = 'table')";
if ($res = sqlite_query ($dblink, $sql)) {
while (sqlite_has_more($res)) {
$tables[] = sqlite_fetch_single($res);
}
}
return $tables;
}
}
And a related funtion, to test if a given table exists:
if (! function_exists ('sqlite_table_exists')) {
function sqlite_table_exists (&$dblink, $table) {
$sql = "SELECT count(name) FROM sqlite_master WHERE ((type = 'table') and (name = '$table'))";
if ($res = sqlite_query ($dblink, $sql)) {
return sqlite_fetch_single($res) > 0;
} else {
return false; // or throw exception
}
}
}
Of course it would be preferable to have these functions included in the library, to avoid potential changes internal to SQLite; but we'll have to stick to this method until then.
To elaborate on vpupkin at comcast dot net's post about the INSERT query problem, you will be unable to execute any manipulation queries (INSERT/UPDATE/DELETE/ect) on the SQLite database file unless the directory the SQLite database file resides in is writable by the webserver.
The reason for this is because SQLite needs to write a lock file to the hard drive. After a processes finishes writting, it deletes the lock file. Other processes check for the lock file before writting to the SQLite database file and if present, delay writting until the lock file is no longer present.
If you want to get the list of all the columns in a table (and associated information), PRAGMA is helpful (see http://sqlite.org/lang.html#pragma for details):
if (!($db=@sqlite_open("delme.db",0666,$sqliteerror))) die("Can't open database");
@sqlite_query ($db, 'DROP TABLE foo;');
sqlite_query($db, "CREATE TABLE foo (bar INTEGER PRIMARY KEY, baz VARCHAR(5));");
$aTableStruct = sqlite_array_query($db, "PRAGMA table_info('foo');", SQLITE_ASSOC);
for ($i=0,$aNames=array();$i<sizeof($aTableStruct);++$i)
$aNames[]=$aTableStruct[$i]['name'];
var_dump ($aNames); // => ['bar', 'baz']
Note also that if you want to use more than one database in the same connection using "ATTACH DATABASE ..." then you should supply the complete database filename.
Csaba Gabor
PHP5 compile time option --enable-sqlite-utf8
See the note about buggy utf-8 support http://uk.php.net/manual/en/function.sqlite-libencoding.php
You can use the PECL SQLite extension as a static (built into the executable) PHP module with PHP 4. Download the extension tarball and extract it. Move it to ext/sqlite in the PHP source directory. Delete configure and run buildconf.
Example below. Change version numbers as appropriate:
$ tar -xzvf php-4.3.8.tar.gz
$ tar -xzvf SQLite-1.0.2.tgz
$ mv SQLite-1.0.2 php-4.3.8/ext/sqlite
$ cd php-4.3.8
$ rm configure
$ ./buildconf --force
If everything worked, then you should now be able to build PHP with SQLite support:
$ ./configure --help | grep sqlite
--with-sqlite Include sqlite support
I think this method will work for other PECL extensions.
If you want to create a table in your database which should have an integer primary key, you cannot declare the row like this:
id int(16) primary key
or
id integer(16) primary key
When you declare it like this it could be that the id isn't auto increment. You have to declare it like this:
id integer primary key
If you need to check if a table exists, you can use a function like this:
<?php
//Returns TRUE if table exists and FALSE otherwise
// $mytable = table you want to check for
function sqlite_table_exists($mytable) {
$db = sqlite_open('mydb.sqlite', 0666, $sqliteerror);
$query = sqlite_query($db, "SELECT name FROM sqlite_master WHERE type='table'");
$tables = sqlite_fetch_array($query);
if ($tables != '') {
foreach ($tables as $table) {
if ($table == $mytable) {
return("TRUE");
}
else {
return("FALSE");
}
}
}
else {
return("FALSE");
}
}
?>
A function like this could be used to create the table if it's not already created, etc.
The same in 3 lines.
<?php
function sqlite_table_exists($db,$mytable) {
/* counts the tables that match the name given */
$result = sqlite_query($db,"SELECT COUNT(*) FROM sqlite_master WHERE type='table' AND name='$mytable'");
/* casts into integer */
$count = intval(sqlite_fetch_single($result));
/* returns true or false */
return $count > 0;
}
?>
Check the db/table if exist
$db_name='db';
$db=new SQLiteDatabase($db_name, 0666, $error);
if ($error) exit($error);
$q=$db->query("PRAGMA table_info(test)");
if ($q->numRows()!=2) {
if (!@$db->queryexec("
CREATE TABLE test (
id INTEGER NOT NULL PRIMARY KEY,
text VARCHAR ( 255 ) NOT NULL
)")
) exit ("Create SQLite Database Error\n");
}
This may have been obvious to others, but I had a tough time finding the info.
The default location for the actual database file is the same location of the php doc that created the database. You can alter this behavior by specifying the full path in the creation call:
<php
$db = sqlite_open("/absolute/path/my_sqlite.db");
?>
Note that if you used the default location, the db file may be served up by the webserver if it is in a the http document path. This is obviously a security risk that should be avoided.
//Max
SELECT tablename.columnname FROM table;
will cause SQLite to return an array having tablename.field_name as the array index. (e.g. $result['tablename.field_name'])
To let SQLite return an array having only field_name as the array index (e.g. $result['field_name']) you can issue a 'PRAGMA short_column_names = 1' query:
sqlite_query($connection_id, 'PRAGMA short_column_names = 1');
This behaviour is more consistent with the other database extensions.
For a full list of all pragmas visit: http://sqlite.org/pragma.html
A function to check whether a table exists:
<?php
function sqlite_table_exists(&$sqlite, $table)
{
$result = $sqlite->query("SELECT name FROM sqlite_master WHERE type='table' AND name='$table'");
return $result->numRows() > 0;
}
?>
Simple Example for using SQLite for small Buffering Clipboard ;)
<?php
// $Id: SQLiteClipboard.php5,v 1.1 2005/09/09 10:15:26 heinemann Exp $
/**
* @callgraph
* @class SQLiteClipboard
* @short Simple Read/Write Clipboard Class
* @version 0.0.1
* @since Fr Sep 9 08:14:45 CEST 2005
* @code
$sqlite = new SQLiteClipboard( MY_TEMP_DIR );
if ( $sqlite->INSERTING = time() )
var_dump( $sqlite->INSERTING );
else
echo "Nothing done!";
* @endcode
*/
final class SQLiteClipboard
{
private $SQL;
private $DB = "Clipboard.sqlite";
private $TB = "Clipboard";
private $ID = "ID";
private $PA = "PARAM";
private $VA = "VAL";
function __construct( $path )
{
$this->DB = chop( $path . "/" . $this->DB );
$this->sql_init();
}
private function sql_init()
{
$this->SQL = new SQLiteDatabase( $this->DB, 0660 );
if ( ! file_exists( $this->DB ) )
die( "Permission Denied!" );
$q = $this->SQL->query("PRAGMA table_info(" . $this->TB . ")");
if ( $q->numRows() == 0 ) {
$this->SQL->query( "CREATE TABLE " . $this->TB . " ( " . $this->ID . " INTEGER PRIMARY KEY, " . $this->PA . " CHAR(255), " . $this->VA . " CHAR(255) );" );
}
}
private function sql_check( $p )
{
$o = null;
$q = $this->SQL->query( "SELECT " . $this->ID . " FROM " . $this->TB . " WHERE ( " . $this->PA . "='$p' ) ORDER BY " . $this->ID . " LIMIT 1" );
while( $q->valid() ) {
$r = $q->current();
return $r[$this->ID];
$q->next();
}
return false;
}
public function __get( $p )
{
$q = $this->SQL->query( "SELECT " . $this->VA . " FROM " . $this->TB . " WHERE ( " . $this->PA . "='$p' ) ORDER BY " . $this->ID );
while( $q->valid() ) {
$r = $q->current();
$o = $r[$this->VA];
$q->next();
}
return $o;
}
public function __set( $p, $v )
{
if ( $this->sql_check( $p ) && ! empty( $v ) )
return $this->SQL->query( "UPDATE " . $this->TB . " SET " . $this->VA . "='$v' WHERE ( " . $this->PA . "='$p' );" );
elseif ( ! $this->sql_check( $p ) && ! empty( $v ) )
return $this->SQL->query( "INSERT INTO " . $this->TB . " ( " . $this->PA . ", " . $this->VA . " ) VALUES ('$p', '$v' );" );
elseif ( $this->sql_check( $p ) && empty( $v ) )
return $this->SQL->query( "DELETE FROM " . $this->TB . " WHERE ( " . $this->PA . "='$p' );" );
else
return false;
}
} // end Class
?>
If you get an error message:
Warning: sqlite_open() [function.sqlite-open]: file is encrypted or is not a database
then most probably your code is accessing a SQLite3 database.
sqlite_open() only supports SQLite2. Use PDO to access SQLite3.
The SQLite manual mentions that queries are done in a case-sensitive way, this means your query must be the correct case. It also mentions that using the "LIKE" operator will do a case-insensitive selection. This is true, but this also introduces wildcard symbols which a user could enter without getting filtered by the SQLite escape function. I'm somewhat new to SQL and I didn't think of doing this before, even after looking for a decent way to do case-insensitive queries.
For case-insensitive queries, simply use the built in "lower" function.
<?php
// ...
$name = 'bARbarA';
$rows = $db->arrayQuery('select * from blah where lower(name) = lower(\''.sqlite_escape_string($name).'\');');
// $rows might contain an entry for "Barbara" now.
?>