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

OdbcDriver

class OdbcDriver implements Driver, ResultDriver, Reflector

The driver interacting with databases via ODBC connections.

Driver options:

  • dsn => driver specific DSN
  • username (or user)
  • password (or pass)
  • persistent (bool) => try to find a persistent link?
  • resource (resource) => existing connection resource
  • microseconds (bool) => use microseconds in datetime format?

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.

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.

Reflector
getReflector()

Returns the connection reflector.

ResultDriver
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.

array
getResultColumns()

Returns metadata for all columns in a result set.

mixed
getResultResource()

Returns the result set resource.

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.

array
getForeignKeys($table)

Returns metadata for all foreign keys in a table.

Details

at line 50
__construct()

No description

Exceptions

NotSupportedException

at line 63
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

DriverException

at line 128
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 138
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 150
void begin($savepoint = null)

Begins a transaction (if supported).

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 164
void commit($savepoint = null)

Commits statements in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 179
void rollback($savepoint = null)

Rollback changes in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 192
bool inTransaction()

Is in transaction?

Return Value

bool

at line 202
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 212
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 223
ResultDriver createResultDriver($resource)

Result set driver factory.

Parameters

$resource

Return Value

ResultDriver

at line 239
string escapeText($value)

Encodes data for use in a SQL statement.

Parameters

$value

Return Value

string

encoded value

at line 249
string escapeBinary($value)

No description

Parameters

$value

Return Value

string

at line 259
string escapeIdentifier($value)

No description

Parameters

$value

Return Value

string

at line 269
string escapeBool($value)

No description

Parameters

$value

Return Value

string

at line 279
string escapeDate($value)

No description

Parameters

$value

Return Value

string

at line 292
string escapeDateTime($value)

No description

Parameters

$value

Return Value

string

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

Encodes string for use in a LIKE statement.

Parameters

$value
$pos

Return Value

string

at line 319
string unescapeBinary($value)

Decodes data from result set.

Parameters

$value

Return Value

string

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

deprecated

No description

Parameters

$value
$type

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

Injects LIMIT/OFFSET to the SQL query.

Parameters

$sql
$limit
$offset

Return Value

void

at line 361
void __destruct()

Automatically frees the resources allocated for this result set.

Return Value

void

at line 373
int getRowCount()

Returns the number of rows in a result set.

Return Value

int

at line 385
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 409
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

at line 420
void free()

Frees the resources allocated for this result set.

Return Value

void

at line 431
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 451
mixed getResultResource()

Returns the result set resource.

Return Value

mixed

at line 465
array getTables()

Returns list of tables.

Return Value

array

of {name [, (bool) view ]}

at line 487
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 513
array getIndexes($table)

Returns metadata for all indexes in a table.

Parameters

$table

Return Value

array

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

at line 524
array getForeignKeys($table)

Returns metadata for all foreign keys in a table.

Parameters

$table

Return Value

array

Traits

Strict

Better OOP experience.