1. class
  2. Dibi
  3. \
  4. Drivers
  5. \
  6. Sqlite3Driver

Sqlite3Driver

class Sqlite3Driver implements Driver, ResultDriver

The driver for SQLite3 database.

Driver options:

  • database (or file) => the filename of the SQLite3 database
  • formatDate => how to format date in SQL (date)
  • formatDateTime => how to format datetime in SQL (date)
  • dbcharset => database character encoding (will be converted to 'charset')
  • charset => character encoding to set (default is UTF-8)
  • resource (SQLite3) => existing connection resource

Methods

__construct()

No description

void
connect(array $config)

Connects to a database.

void
disconnect()

Disconnects from a database.

ResultDriver|null
query($sql)

Executes the SQL query.

static DriverException
createException($message, $code, $sql)

No description

int|false
getAffectedRows()

Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.

int|false
getInsertId($sequence)

Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.

void
begin($savepoint = null)

Begins a transaction (if supported).

void
commit($savepoint = null)

Commits statements in a transaction.

void
rollback($savepoint = null)

Rollback changes in a transaction.

mixed
getResource()

Returns the connection resource.

Reflector
getReflector()

Returns the connection reflector.

ResultDriver
createResultDriver(SQLite3Result $resource)

Result set driver factory.

string
escapeText($value)

Encodes data for use in a SQL statement.

string
escapeBinary($value)

No description

string
escapeIdentifier($value)

No description

string
escapeBool($value)

No description

string
escapeDate($value)

No description

string
escapeDateTime($value)

No description

string
escapeLike($value, $pos)

Encodes string for use in a LIKE statement.

string
unescapeBinary($value)

Decodes data from result set.

escape($value, $type) deprecated

No description

void
applyLimit($sql, $limit, $offset)

Injects LIMIT/OFFSET to the SQL query.

void
__destruct()

Automatically frees the resources allocated for this result set.

int
getRowCount()

Returns the number of rows in a result set.

array
fetch($assoc)

Fetches the row at current position and moves the internal cursor to the next position.

bool
seek($row)

Moves cursor position without fetching row.

void
free()

Frees the resources allocated for this result set.

array
getResultColumns()

Returns metadata for all columns in a result set.

mixed
getResultResource()

Returns the result set resource.

void
registerFunction($name, callable $callback, $numArgs = -1)

Registers an user defined function for use in SQL statements.

void
registerAggregateFunction($name, callable $rowCallback, callable $agrCallback, $numArgs = -1)

Registers an aggregating user defined function for use in SQL statements.

Details

at line 53
__construct()

No description

Exceptions

NotSupportedException

at line 66
void connect(array $config)

Connects to a database.

Parameters

array $config

Return Value

void

Exceptions

Exception

at line 100
void disconnect()

Disconnects from a database.

Return Value

void

at line 112
ResultDriver|null query($sql)

Executes the SQL query.

Parameters

$sql

Return Value

ResultDriver|null

Exceptions

DriverException

at line 132
static DriverException createException($message, $code, $sql)

No description

Parameters

$message
$code
$sql

Return Value

DriverException

at line 163
int|false getAffectedRows()

Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.

Return Value

int|false

number of rows or false on error

at line 173
int|false getInsertId($sequence)

Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.

Parameters

$sequence

Return Value

int|false

int on success or false on failure

at line 185
void begin($savepoint = null)

Begins a transaction (if supported).

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 197
void commit($savepoint = null)

Commits statements in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 209
void rollback($savepoint = null)

Rollback changes in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 219
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 229
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 240
ResultDriver createResultDriver(SQLite3Result $resource)

Result set driver factory.

Parameters

SQLite3Result $resource

Return Value

ResultDriver

at line 256
string escapeText($value)

Encodes data for use in a SQL statement.

Parameters

$value

Return Value

string

encoded value

at line 266
string escapeBinary($value)

No description

Parameters

$value

Return Value

string

at line 276
string escapeIdentifier($value)

No description

Parameters

$value

Return Value

string

at line 286
string escapeBool($value)

No description

Parameters

$value

Return Value

string

at line 296
string escapeDate($value)

No description

Parameters

$value

Return Value

string

at line 309
string escapeDateTime($value)

No description

Parameters

$value

Return Value

string

at line 324
string escapeLike($value, $pos)

Encodes string for use in a LIKE statement.

Parameters

$value
$pos

Return Value

string

at line 336
string unescapeBinary($value)

Decodes data from result set.

Parameters

$value

Return Value

string

at line 343
escape($value, $type) deprecated

deprecated

No description

Parameters

$value
$type

at line 357
void applyLimit($sql, $limit, $offset)

Injects LIMIT/OFFSET to the SQL query.

Parameters

$sql
$limit
$offset

Return Value

void

at line 376
void __destruct()

Automatically frees the resources allocated for this result set.

Return Value

void

at line 389
int getRowCount()

Returns the number of rows in a result set.

Return Value

int

Exceptions

NotSupportedException

at line 400
array fetch($assoc)

Fetches the row at current position and moves the internal cursor to the next position.

Parameters

$assoc

Return Value

array

array on success, nonarray if no next record

at line 421
bool seek($row)

Moves cursor position without fetching row.

Parameters

$row

Return Value

bool

true on success, false if unable to seek to specified record

Exceptions

NotSupportedException

at line 431
void free()

Frees the resources allocated for this result set.

Return Value

void

at line 442
array getResultColumns()

Returns metadata for all columns in a result set.

Return Value

array

of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}

at line 464
mixed getResultResource()

Returns the result set resource.

Return Value

mixed

at line 481
void registerFunction($name, callable $callback, $numArgs = -1)

Registers an user defined function for use in SQL statements.

Parameters

$name
callable $callback
$numArgs

Return Value

void

at line 495
void registerAggregateFunction($name, callable $rowCallback, callable $agrCallback, $numArgs = -1)

Registers an aggregating user defined function for use in SQL statements.

Parameters

$name
callable $rowCallback
callable $agrCallback
$numArgs

Return Value

void

Traits

Strict

Better OOP experience.