interface Driver

Supplemental database driver.

Constants

SUPPORT_SEQUENCE

SUPPORT_SELECT_UNGROUPED_COLUMNS

SUPPORT_MULTI_INSERT_AS_SELECT

SUPPORT_MULTI_COLUMN_AS_OR_COND

SUPPORT_SUBSELECT

SUPPORT_SCHEMA

Methods

void
connect(string $dsn, string|null $user = null, string|null $password = null, array|null $options = null)

Initializes connection.

query(string $queryString, array $params)

No description

void
beginTransaction()

No description

void
commit()

No description

void
rollBack()

No description

string
getInsertId(string|null $sequence = null)

Returns the ID of the last inserted row or sequence value.

string
quote(string $string)

Delimits string for use in SQL statement.

string
delimite(string $name)

Delimits identifier for use in SQL statement.

string
formatDateTime(DateTimeInterface $value)

Formats date-time for use in a SQL statement.

string
formatDateInterval(DateInterval $value)

Formats date-time interval for use in a SQL statement.

string
formatLike(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.

array
getTables()

Returns list of tables as tuples [(string) name, (bool) view, [(string) fullName]]

array
getColumns(string $table)

Returns metadata for all columns in a table.

array
getIndexes(string $table)

Returns metadata for all indexes in a table.

array
getForeignKeys(string $table)

Returns metadata for all foreign keys in a table.

bool
isSupported(string $item)

Cheks if driver supports specific property

Details

at line 30
void connect(string $dsn, string|null $user = null, string|null $password = null, array|null $options = null)

Initializes connection.

Parameters

string $dsn
string|null $user
string|null $password
array|null $options

Return Value

void

Exceptions

ConnectionException

at line 32
ResultDriver query(string $queryString, array $params)

No description

Parameters

string $queryString
array $params

Return Value

ResultDriver

at line 34
void beginTransaction()

No description

Return Value

void

at line 36
void commit()

No description

Return Value

void

at line 38
void rollBack()

No description

Return Value

void

at line 43
string getInsertId(string|null $sequence = null)

Returns the ID of the last inserted row or sequence value.

Parameters

string|null $sequence

Return Value

string

at line 48
string quote(string $string)

Delimits string for use in SQL statement.

Parameters

string $string

Return Value

string

at line 53
string delimite(string $name)

Delimits identifier for use in SQL statement.

Parameters

string $name

Return Value

string

at line 58
string formatDateTime(DateTimeInterface $value)

Formats date-time for use in a SQL statement.

Parameters

DateTimeInterface $value

Return Value

string

at line 63
string formatDateInterval(DateInterval $value)

Formats date-time interval for use in a SQL statement.

Parameters

DateInterval $value

Return Value

string

at line 68
string formatLike(string $value, int $pos)

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

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

at line 80
array getTables()

Returns list of tables as tuples [(string) name, (bool) view, [(string) fullName]]

Return Value

array

at line 86
array getColumns(string $table)

Returns metadata for all columns in a table.

As tuples [(string) name, (string) table, (string) nativetype, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (bool) primary, (array) vendor]]

Parameters

string $table

Return Value

array

at line 92
array getIndexes(string $table)

Returns metadata for all indexes in a table.

As tuples [(string) name, (string[]) columns, (bool) unique, (bool) primary]

Parameters

string $table

Return Value

array

at line 98
array getForeignKeys(string $table)

Returns metadata for all foreign keys in a table.

As tuples [(string) name, (string) local, (string) table, (string) foreign]

Parameters

string $table

Return Value

array

at line 104
bool isSupported(string $item)

Cheks if driver supports specific property

Parameters

string $item

self::SUPPORT_* property

Return Value

bool