class SqlsrvDriver implements Driver

The driver for Microsoft SQL Server and SQL Azure databases.

Driver options:

  • host => the MS SQL server host name. It can also include a port number (hostname:port)
  • username (or user)
  • password (or pass)
  • database => the database name to select
  • options (array) => connection options https://msdn.microsoft.com/en-us/library/cc296161(SQL.90).aspx
  • charset => character encoding to set (default is UTF-8)
  • resource (resource) => existing connection resource

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|null $savepoint = null)

Begins a transaction (if supported).

void
commit(string|null $savepoint = null)

Commits statements in a transaction.

void
rollback(string|null $savepoint = null)

Rollback changes in a transaction.

mixed
getResource()

Returns the connection resource.

getReflector()

Returns the connection reflector.

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 $value)

No description

string
escapeDateTime(DateTimeInterface $value)

No description

string
escapeDateInterval(DateInterval $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 41
__construct(array $config)

No description

Parameters

array $config

Exceptions

NotSupportedException

at line 83
void disconnect()

Disconnects from a database.

Return Value

void

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

Executes the SQL query.

Parameters

string $sql

Return Value

ResultDriver|null

Exceptions

DriverException

at line 116
int|null getAffectedRows()

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

Return Value

int|null

at line 125
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 141
void begin(string|null $savepoint = null)

Begins a transaction (if supported).

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 151
void commit(string|null $savepoint = null)

Commits statements in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 161
void rollback(string|null $savepoint = null)

Rollback changes in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 171
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 180
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 190
SqlsrvResult createResultDriver(resource $resource)

Result set driver factory.

Parameters

resource $resource

Return Value

SqlsrvResult

at line 202
string escapeText(string $value)

Encodes data for use in a SQL statement.

Parameters

string $value

Return Value

string

at line 208
string escapeBinary(string $value)

No description

Parameters

string $value

Return Value

string

at line 214
string escapeIdentifier(string $value)

No description

Parameters

string $value

Return Value

string

at line 221
string escapeBool(bool $value)

No description

Parameters

bool $value

Return Value

string

at line 227
string escapeDate(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 233
string escapeDateTime(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 239
string escapeDateInterval(DateInterval $value)

No description

Parameters

DateInterval $value

Return Value

string

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

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

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

Better OOP experience.