The SQLite3 class

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

Introduction

A class that interfaces SQLite 3 databases.

Class synopsis

class SQLite3 {

/* Constants */

public const int OK ;

public const int DENY ;

public const int IGNORE ;

public const int CREATE_INDEX ;

public const int CREATE_TABLE ;

public const int CREATE_TEMP_INDEX ;

public const int CREATE_TEMP_TABLE ;

public const int CREATE_TEMP_TRIGGER ;

public const int CREATE_TEMP_VIEW ;

public const int CREATE_TRIGGER ;

public const int CREATE_VIEW ;

public const int DELETE ;

public const int DROP_INDEX ;

public const int DROP_TABLE ;

public const int DROP_TEMP_INDEX ;

public const int DROP_TEMP_TABLE ;

public const int DROP_TEMP_TRIGGER ;

public const int DROP_TEMP_VIEW ;

public const int DROP_TRIGGER ;

public const int DROP_VIEW ;

public const int INSERT ;

public const int PRAGMA ;

public const int READ ;

public const int SELECT ;

public const int TRANSACTION ;

public const int UPDATE ;

public const int ATTACH ;

public const int DETACH ;

public const int ALTER_TABLE ;

public const int REINDEX ;

public const int ANALYZE ;

public const int CREATE_VTABLE ;

public const int DROP_VTABLE ;

public const int FUNCTION ;

public const int SAVEPOINT ;

public const int COPY ;

public const int RECURSIVE ;

/* Methods */

public __construct (string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = "")

public backup (SQLite3 $destination, string $sourceDatabase = "main", string $destinationDatabase = "main"): bool

public busyTimeout (int $milliseconds): bool

public changes (): int

public close (): bool

public createAggregate (
string $name,
callable $stepCallback,
callable $finalCallback,
int $argCount = -1
): bool

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

public createFunction (
string $name,
callable $callback,
int $argCount = -1,
int $flags = 0
): bool

public enableExceptions (bool $enable = false ): bool

public static escapeString (string $string): string

public exec (string $query): bool

public lastErrorCode (): int

public lastErrorMsg (): string

public lastInsertRowID (): int

public loadExtension (string $name): bool

public open (string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = ""): void

public openBlob (
string $table,
string $column,
int $rowid,
string $database = "main",
int $flags = SQLITE3_OPEN_READONLY
): resource |false

public prepare (string $query): SQLite3Stmt |false

public query (string $query): SQLite3Result |false

public querySingle (string $query, bool $entireRow = false ): mixed

public setAuthorizer (? callable $callback): bool

public static version (): array

}

Predefined Constants

SQLite3::OK
SQLite3::DENY
SQLite3::IGNORE
SQLite3::CREATE_INDEX
SQLite3::CREATE_TABLE
SQLite3::CREATE_TEMP_INDEX
SQLite3::CREATE_TEMP_TABLE
SQLite3::CREATE_TEMP_TRIGGER
SQLite3::CREATE_TEMP_VIEW
SQLite3::CREATE_TRIGGER
SQLite3::CREATE_VIEW
SQLite3::DELETE
SQLite3::DROP_INDEX
SQLite3::DROP_TABLE
SQLite3::DROP_TEMP_INDEX
SQLite3::DROP_TEMP_TABLE
SQLite3::DROP_TEMP_TRIGGER
SQLite3::DROP_TEMP_VIEW
SQLite3::DROP_TRIGGER
SQLite3::DROP_VIEW
SQLite3::INSERT
SQLite3::PRAGMA
SQLite3::READ
SQLite3::SELECT
SQLite3::TRANSACTION
SQLite3::UPDATE
SQLite3::ATTACH
SQLite3::DETACH
SQLite3::ALTER_TABLE
SQLite3::REINDEX
SQLite3::ANALYZE
SQLite3::CREATE_VTABLE
SQLite3::DROP_VTABLE
SQLite3::FUNCTION
SQLite3::SAVEPOINT
SQLite3::COPY
SQLite3::RECURSIVE

SQLite3::backup — Backup one database to another database
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::setAuthorizer — Configures a callback to be used as an authorizer to limit what a statement can do
SQLite3::version — Returns the SQLite3 library version as a string constant and as a number

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

+add a note

User Contributed Notes

There are no user contributed notes for this page.