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

OdbcDriver

class OdbcDriver implements Driver

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(array $config)

No description

void
disconnect()

Disconnects from a database.

ResultDriver|null
query(string $sql)

Executes the SQL query.

int|null
getAffectedRows()

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

int|null
getInsertId(string|null $sequence)

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

void
begin(string $savepoint = null)

Begins a transaction (if supported).

void
commit(string $savepoint = null)

Commits statements in a transaction.

void
rollback(string $savepoint = null)

Rollback changes in a transaction.

bool
inTransaction()

Is in transaction?

mixed
getResource()

Returns the connection resource.

Reflector
getReflector()

Returns the connection reflector.

OdbcResult
createResultDriver(resource $resource)

Result set driver factory.

string
escapeText(string $value)

Encodes data for use in a SQL statement.

string
escapeBinary(string $value)

No description

string
escapeIdentifier(string $value)

No description

string
escapeBool(bool $value)

No description

string
escapeDate(DateTimeInterface|string|int $value)

No description

string
escapeDateTime(DateTimeInterface|string|int $value)

No description

string
escapeLike(string $value, int $pos)

Encodes string for use in a LIKE statement.

void
applyLimit(string $sql, int|null $limit, int|null $offset)

Injects LIMIT/OFFSET to the SQL query.

Details

at line 43
__construct(array $config)

No description

Parameters

array $config

Exceptions

NotSupportedException

at line 79
void disconnect()

Disconnects from a database.

Return Value

void

at line 89
ResultDriver|null query(string $sql)

Executes the SQL query.

Parameters

string $sql

Return Value

ResultDriver|null

Exceptions

DriverException

at line 108
int|null getAffectedRows()

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

Return Value

int|null

at line 117
int|null getInsertId(string|null $sequence)

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

Parameters

string|null $sequence

Return Value

int|null

at line 127
void begin(string $savepoint = null)

Begins a transaction (if supported).

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 139
void commit(string $savepoint = null)

Commits statements in a transaction.

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 152
void rollback(string $savepoint = null)

Rollback changes in a transaction.

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 164
bool inTransaction()

Is in transaction?

Return Value

bool

at line 174
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 183
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 193
OdbcResult createResultDriver(resource $resource)

Result set driver factory.

Parameters

resource $resource

Return Value

OdbcResult

at line 205
string escapeText(string $value)

Encodes data for use in a SQL statement.

Parameters

string $value

Return Value

string

at line 211
string escapeBinary(string $value)

No description

Parameters

string $value

Return Value

string

at line 217
string escapeIdentifier(string $value)

No description

Parameters

string $value

Return Value

string

at line 223
string escapeBool(bool $value)

No description

Parameters

bool $value

Return Value

string

at line 232
string escapeDate(DateTimeInterface|string|int $value)

No description

Parameters

DateTimeInterface|string|int $value

Return Value

string

at line 244
string escapeDateTime(DateTimeInterface|string|int $value)

No description

Parameters

DateTimeInterface|string|int $value

Return Value

string

at line 256
string escapeLike(string $value, int $pos)

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

at line 266
void applyLimit(string $sql, int|null $limit, int|null $offset)

Injects LIMIT/OFFSET to the SQL query.

Parameters

string $sql
int|null $limit
int|null $offset

Return Value

void

Traits

Strict

Better OOP experience.