SQLite3

Table of Contents

Introduction
Installing/Configuring
Predefined Constants
SQLite3 — The SQLite3 class
- SQLite3::busyTimeout — Sets the busy connection handler
- SQLite3::changes — Returns the number of database rows that were changed (or inserted or deleted) by the most recent SQL statement
- SQLite3::close — Closes the database connection
- SQLite3::__construct — Instantiates an SQLite3 object and opens an SQLite 3 database
- SQLite3::createAggregate — Registers a PHP function for use as an SQL aggregate function
- SQLite3::createCollation — Registers a PHP function for use as an SQL collating function
- SQLite3::createFunction — Registers a PHP function for use as an SQL scalar function
- SQLite3::enableExceptions — Enable throwing exceptions
- SQLite3::escapeString — Returns a string that has been properly escaped
- SQLite3::exec — Executes a result-less query against a given database
- SQLite3::lastErrorCode — Returns the numeric result code of the most recent failed SQLite request
- SQLite3::lastErrorMsg — Returns English text describing the most recent failed SQLite request
- SQLite3::lastInsertRowID — Returns the row ID of the most recent INSERT into the database
- SQLite3::loadExtension — Attempts to load an SQLite extension library
- SQLite3::open — Opens an SQLite database
- SQLite3::openBlob — Opens a stream resource to read a BLOB
- SQLite3::prepare — Prepares an SQL statement for execution
- SQLite3::query — Executes an SQL query
- SQLite3::querySingle — Executes a query and returns a single result
- SQLite3::version — Returns the SQLite3 library version as a string constant and as a number
SQLite3Stmt — The SQLite3Stmt class
- SQLite3Stmt::bindParam — Binds a parameter to a statement variable
- SQLite3Stmt::bindValue — Binds the value of a parameter to a statement variable
- SQLite3Stmt::clear — Clears all current bound parameters
- SQLite3Stmt::close — Closes the prepared statement
- SQLite3Stmt::execute — Executes a prepared statement and returns a result set object
- SQLite3Stmt::paramCount — Returns the number of parameters within the prepared statement
- SQLite3Stmt::readOnly() — Returns whether a statement is definitely read only
- SQLite3Stmt::reset — Resets the prepared statement
SQLite3Result — The SQLite3Result class
- SQLite3Result::columnName — Returns the name of the nth column
- SQLite3Result::columnType — Returns the type of the nth column
- SQLite3Result::fetchArray — Fetches a result row as an associative or numerically indexed array or both
- SQLite3Result::finalize — Closes the result set
- SQLite3Result::numColumns — Returns the number of columns in the result set
- SQLite3Result::reset — Resets the result set back to the first row

The SQLite3 class

Introduction

A class that interfaces SQLite 3 databases.

Class synopsis

SQLite3

class SQLite3 {

/* Methods */

public bool busyTimeout ( int $msecs )

public int changes ( void )

public bool close ( void )

public __construct ( string $filename [, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE [, string $encryption_key = null ]] )

public bool createAggregate ( string $name , mixed $step_callback , mixed $final_callback [, int $argument_count = -1 ] )

public bool createCollation ( string $name , callable $callback )

public bool createFunction ( string $name , mixed $callback [, int $argument_count = -1 [, int $flags = 0 ]] )

bool enableExceptions ([ bool $enableExceptions = false ] )

public static string escapeString ( string $value )

public bool exec ( string $query )

public int lastErrorCode ( void )

public string lastErrorMsg ( void )

public int lastInsertRowID ( void )

public bool loadExtension ( string $shared_library )

public void open ( string $filename [, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE [, string $encryption_key = null ]] )

public resource open ( string $table , string $column , int $rowid [, string $dbname = "main" ] )

public SQLite3Stmt prepare ( string $query )

public SQLite3Result query ( string $query )

public mixed querySingle ( string $query [, bool $entire_row = false ] )

public static array version ( void )

}

The SQLite3Stmt class

Introduction

A class that handles prepared statements for the SQLite 3 extension.

Class synopsis

SQLite3Stmt

class SQLite3Stmt {

/* Methods */

public bool bindParam ( mixed $sql_param , mixed &$param [, int $type ] )

public bool bindValue ( mixed $sql_param , mixed $value [, int $type ] )

public bool clear ( void )

public bool close ( void )

public SQLite3Result execute ( void )

public int paramCount ( void )

public bool readOnly ( void )

public bool reset ( void )

}

The SQLite3Result class

Introduction

A class that handles result sets for the SQLite 3 extension.

Class synopsis

SQLite3Result

class SQLite3Result {

/* Methods */

public string columnName ( int $column_number )

public int columnType ( int $column_number )

public array fetchArray ([ int $mode = SQLITE3_BOTH ] )

public bool finalize ( void )

public int numColumns ( void )

public bool reset ( void )

}