The SQLite3 class

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

Introduction

A class that interfaces SQLite 3 databases.

Class synopsis

classSQLite3 {

publicconstintOK;

publicconstintDENY;

publicconstintIGNORE;

publicconstintCREATE_INDEX;

publicconstintCREATE_TABLE;

publicconstintCREATE_TEMP_INDEX;

publicconstintCREATE_TEMP_TABLE;

publicconstintCREATE_TEMP_TRIGGER;

publicconstintCREATE_TEMP_VIEW;

publicconstintCREATE_TRIGGER;

publicconstintCREATE_VIEW;

publicconstintDELETE;

publicconstintDROP_INDEX;

publicconstintDROP_TABLE;

publicconstintDROP_TEMP_INDEX;

publicconstintDROP_TEMP_TABLE;

publicconstintDROP_TEMP_TRIGGER;

publicconstintDROP_TEMP_VIEW;

publicconstintDROP_TRIGGER;

publicconstintDROP_VIEW;

publicconstintINSERT;

publicconstintPRAGMA;

publicconstintREAD;

publicconstintSELECT;

publicconstintTRANSACTION;

publicconstintUPDATE;

publicconstintATTACH;

publicconstintDETACH;

publicconstintALTER_TABLE;

publicconstintREINDEX;

publicconstintANALYZE;

publicconstintCREATE_VTABLE;

publicconstintDROP_VTABLE;

publicconstintFUNCTION;

publicconstintSAVEPOINT;

publicconstintCOPY;

publicconstintRECURSIVE;

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

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

publicbusyTimeout(int$milliseconds): bool

publicchanges(): int

publicclose(): bool

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

publiccreateCollation(string$name, callable$callback): bool

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

publicenableExceptions(bool$enable = false): bool

publicstaticescapeString(string$string): string

publicexec(string$query): bool

publiclastErrorCode(): int

publiclastErrorMsg(): string

publiclastInsertRowID(): int

publicloadExtension(string$name): bool

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

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

publicprepare(string$query): SQLite3Stmt|false

publicquery(string$query): SQLite3Result|false

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

publicsetAuthorizer(?callable$callback): bool

publicstaticversion(): 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

The SQLite3 class

Introduction

Class synopsis

Predefined Constants

Table of Contents