class MsSqlDriver implements ISupplementalDriver

Supplemental MS SQL database driver.

Traits

Strict class for better experience.

Methods

void
initialize(Connection $connection, array $options)

Initializes connection.

convertException(PDOException $e)

Converts PDOException to DriverException or its descendant.

string
delimite(string $name)

Delimites identifier for use in a 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.

array
getColumnTypes(PDOStatement $statement)

Returns associative array of detected types (IStructure::FIELD_*) in result set.

bool
isSupported(string $item)

Cheks if driver supports specific property

Details

at line 26
void initialize(Connection $connection, array $options)

Initializes connection.

Parameters

Connection $connection
array $options

Return Value

void

at line 32
DriverException convertException(PDOException $e)

Converts PDOException to DriverException or its descendant.

Parameters

PDOException $e

Return Value

DriverException

at line 41
string delimite(string $name)

Delimites identifier for use in a SQL statement.

Parameters

string $name

Return Value

string

at line 48
string formatDateTime(DateTimeInterface $value)

Formats date-time for use in a SQL statement.

Parameters

DateTimeInterface $value

Return Value

string

at line 54
string formatDateInterval(DateInterval $value)

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

Parameters

DateInterval $value

Return Value

string

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

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

at line 67
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 87
array getTables()

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

Return Value

array

at line 100
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 138
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 170
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 209
array getColumnTypes(PDOStatement $statement)

Returns associative array of detected types (IStructure::FIELD_*) in result set.

Parameters

PDOStatement $statement

Return Value

array

at line 215
bool isSupported(string $item)

Cheks if driver supports specific property

Parameters

string $item self::SUPPORT_* property

Return Value

bool