interface Engine

Database platform specific operations and reflection capabilities.

Constants

SupportSequence

SupportSelectUngroupedColumns

SupportMultiInsertAsSelect

SupportMultiColumnAsOrCondition

SupportSubselect

SupportSchema

Methods

bool
isSupported(string $feature)

Checks if the engine supports a specific feature.

string|null
classifyException(DriverException $e)

Maps a driver exception to an appropriate exception class.

mixed
convertToPhp(mixed $value, array $meta, TypeConverter $converter)

Converts a value from the database to a PHP value.

string
delimit(string $name)

Escapes an identifier for use in an SQL statement.

string
formatDateTime(DateTimeInterface $value)

Formats a date-time value for use in an SQL statement.

string
formatDateInterval(DateInterval $value)

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

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

Applies LIMIT and OFFSET clauses to an SQL query.

array
getTables()

Returns a list of all tables in the database.

array
getColumns(string $table)

Returns detailed information about columns in a table.

array
getIndexes(string $table)

Returns information about indexes in a table.

array
getForeignKeys(string $table)

Returns information about foreign keys in a table.

Details

at line 33
bool isSupported(string $feature)

Checks if the engine supports a specific feature.

Parameters

string $feature

Return Value

bool

at line 36
string|null classifyException(DriverException $e)

Maps a driver exception to an appropriate exception class.

Parameters

DriverException $e

Return Value

string|null

at line 39
mixed convertToPhp(mixed $value, array $meta, TypeConverter $converter)

Converts a value from the database to a PHP value.

Parameters

mixed $value
array $meta
TypeConverter $converter

Return Value

mixed

at line 44
string delimit(string $name)

Escapes an identifier for use in an SQL statement.

Parameters

string $name

Return Value

string

at line 47
string formatDateTime(DateTimeInterface $value)

Formats a date-time value for use in an SQL statement.

Parameters

DateTimeInterface $value

Return Value

string

at line 50
string formatDateInterval(DateInterval $value)

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

Parameters

DateInterval $value

Return Value

string

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

Applies LIMIT and OFFSET clauses to an SQL query.

Parameters

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

Return Value

string

at line 61
array getTables()

Returns a list of all tables in the database.

Return Value

array

at line 67
array getColumns(string $table)

Returns detailed information about columns in a table.

Parameters

string $table

Return Value

array

at line 73
array getIndexes(string $table)

Returns information about indexes in a table.

Parameters

string $table

Return Value

array

at line 79
array getForeignKeys(string $table)

Returns information about foreign keys in a table.

Parameters

string $table

Return Value

array