class FirebirdDriver implements Driver, ResultDriver, Reflector

The driver for Firebird/InterBase database.

Driver options:

  • database => the path to database file (server:/path/database.fdb)
  • username (or user)
  • password (or pass)
  • charset => character encoding to set
  • buffers (int) => buffers is the number of database buffers to allocate for the server-side cache. If 0 or omitted, server chooses its own default.
  • resource (resource) => existing connection resource

Constants

ERROR_EXCEPTION_THROWN

Methods

__construct()

No description

void
connect(array $config)

Connects to a database.

void
disconnect()

Disconnects from a database.

query($sql)

Executes the SQL query.

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.

bool
inTransaction()

Is in transaction?

mixed
getResource()

Returns the connection resource.

getReflector()

Returns the connection reflector.

createResultDriver($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.

mixed
getResultResource()

Returns the result set resource.

array
getResultColumns()

Returns metadata for all columns in a result set.

array
getTables()

Returns list of tables.

array
getColumns($table)

Returns metadata for all columns in a table.

array
getIndexes($table)

Returns metadata for all indexes in a table (the constraints are included).

array
getForeignKeys($table)

Returns metadata for all foreign keys in a table.

array
getIndices($table)

Returns list of indices in given table (the constraints are not listed).

array
getConstraints($table)

Returns list of constraints in given table.

array
getTriggersMeta($table = null)

Returns metadata for all triggers in a table or database.

array
getTriggers($table = null)

Returns list of triggers for given table.

array
getProceduresMeta()

Returns metadata from stored procedures and their input and output parameters.

array
getProcedures()

Returns list of stored procedures.

array
getGenerators()

Returns list of generators.

array
getFunctions()

Returns list of user defined functions (UDF).

Details

at line 49
__construct()

No description

at line 62
void connect(array $config)

Connects to a database.

Parameters

array $config

Return Value

void

Exceptions

Exception

at line 96
void disconnect()

Disconnects from a database.

Return Value

void

at line 108
ResultDriver|null query($sql)

Executes the SQL query.

Parameters

$sql

Return Value

ResultDriver|null

Exceptions

Exception

at line 133
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 144
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 156
void begin($savepoint = null)

Begins a transaction (if supported).

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 172
void commit($savepoint = null)

Commits statements in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 192
void rollback($savepoint = null)

Rollback changes in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 210
bool inTransaction()

Is in transaction?

Return Value

bool

at line 220
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 230
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 241
ResultDriver createResultDriver($resource)

Result set driver factory.

Parameters

$resource

Return Value

ResultDriver

at line 257
string escapeText($value)

Encodes data for use in a SQL statement.

Parameters

$value

Return Value

string

encoded value

at line 267
string escapeBinary($value)

No description

Parameters

$value

Return Value

string

at line 277
string escapeIdentifier($value)

No description

Parameters

$value

Return Value

string

at line 287
string escapeBool($value)

No description

Parameters

$value

Return Value

string

at line 297
string escapeDate($value)

No description

Parameters

$value

Return Value

string

at line 310
string escapeDateTime($value)

No description

Parameters

$value

Return Value

string

at line 325
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 375
void __destruct()

Automatically frees the resources allocated for this result set.

Return Value

void

at line 387
int getRowCount()

Returns the number of rows in a result set.

Return Value

int

at line 398
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 422
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

Exception

at line 432
void free()

Frees the resources allocated for this result set.

Return Value

void

at line 443
mixed getResultResource()

Returns the result set resource.

Return Value

mixed

at line 454
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 478
array getTables()

Returns list of tables.

Return Value

array

of {name [, (bool) view ]}

at line 502
array getColumns($table)

Returns metadata for all columns in a table.

Parameters

$table

Return Value

array

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

at line 557
array getIndexes($table)

Returns metadata for all indexes in a table (the constraints are included).

Parameters

$table

Return Value

array

of {name, (array of names) columns [, (bool) unique, (bool) primary ]}

at line 591
array getForeignKeys($table)

Returns metadata for all foreign keys in a table.

Parameters

$table

Return Value

array

at line 621
array getIndices($table)

Returns list of indices in given table (the constraints are not listed).

Parameters

$table

Return Value

array

at line 643
array getConstraints($table)

Returns list of constraints in given table.

Parameters

$table

Return Value

array

at line 669
array getTriggersMeta($table = null)

Returns metadata for all triggers in a table or database.

(Only if user has permissions on ALTER TABLE, INSERT/UPDATE/DELETE record in table)

Parameters

$table

Return Value

array

at line 717
array getTriggers($table = null)

Returns list of triggers for given table.

(Only if user has permissions on ALTER TABLE, INSERT/UPDATE/DELETE record in table)

Parameters

$table

Return Value

array

at line 738
array getProceduresMeta()

Returns metadata from stored procedures and their input and output parameters.

Return Value

array

at line 790
array getProcedures()

Returns list of stored procedures.

Return Value

array

at line 808
array getGenerators()

Returns list of generators.

Return Value

array

at line 827
array getFunctions()

Returns list of user defined functions (UDF).

Return Value

array

Traits

Better OOP experience.