Class Sqlserver

SQLServer driver.

Namespace: Cake\Database\Driver

Property Summary

$_autoQuoting protected

bool

Indicates whether or not the driver is doing automatic identifier quoting for all queries
$_baseConfig protected

array

Base configuration settings for Sqlserver driver
$_config protected

array

Configuration data.
$_connection protected

PDO

Instance of PDO.
$_endQuote protected

string

String used to end a database identifier quoting to make it safe
$_startQuote protected

string

String used to start a database identifier quoting to make it safe

Method Summary

__construct() public

Constructor
__debugInfo() public

Returns an array that can be used to describe the internal state of this object.
__destruct() public

Destructor
_connect() protected

Establishes a connection to the database server
_deleteQueryTranslator() protected

Apply translation steps to delete queries.
_expressionTranslators() protected

Returns a dictionary of expressions to be transformed when compiling a Query to SQL. Array keys are method names to be called in this class
_insertQueryTranslator() protected

Apply translation steps to insert queries.
_pagingSubquery() protected

Generate a paging subquery for older versions of SQLserver.
_selectQueryTranslator() protected

Modify the limit/offset to TSQL
_transformDistinct() protected

Returns the passed query after rewriting the DISTINCT clause, so that drivers that do not support the "ON" part can provide the actual way it should be done
_transformFunctionExpression() protected

Receives a FunctionExpression and changes it so that it conforms to this SQL dialect.
_transformTupleComparison() protected

Receives a TupleExpression and changes it so that it conforms to this SQL dialect.
_updateQueryTranslator() protected

Apply translation steps to update queries.
_version() public

Get the version of SQLserver we are connected to.
autoQuoting() public

Returns whether or not this driver should automatically quote identifiers in queries
beginTransaction() public

Starts a transaction
commitTransaction() public

Commits a transaction
compileQuery() public

Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string
connect() public

Establishes a connection to the database server
connection() public

Returns correct connection resource or object that is internally used If first argument is passed, it will set internal connection object or result to the value passed
disableForeignKeySQL() public

Get the SQL for disabling foreign keys
disconnect() public

Disconnects from database server
enableForeignKeySQL() public

Get the SQL for enabling foreign keys
enabled() public

Returns whether PHP is able to use this driver for connecting to database
isConnected() public

Check whether or not the driver is connected.
lastInsertId() public

Returns last id generated for a table or sequence in database
newCompiler() public

Returns an instance of a QueryCompiler
prepare() public

Prepares a sql statement to be executed
queryTranslator() public

Returns a callable function that will be used to transform a passed Query object. This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.
quote() public

Returns a value in a safe representation to be used in a query string
quoteIdentifier() public

Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words
releaseSavePointSQL() public

Returns a SQL snippet for releasing a previously created save point
rollbackSavePointSQL() public

Returns a SQL snippet for rollbacking a previously created save point
rollbackTransaction() public

Rollsback a transaction
savePointSQL() public

Returns a SQL snippet for creating a new transaction savepoint
schemaDialect() public

Get the schema dialect.
schemaValue() public

Escapes values for use in schema definitions.
supportsDynamicConstraints() public

Returns whether the driver supports adding or dropping constraints to already created tables.
supportsQuoting() public

Checks if the driver supports quoting, as PDO_ODBC does not support it.
supportsSavePoints() public

Returns whether this driver supports save points for nested transactions

Method Detail

__construct() ¶ public

__construct(array $config = [])

Constructor

Parameters

array $config optional: The configuration for the driver.

Throws

InvalidArgumentException

__debugInfo() ¶ public

__debugInfo(): array

Returns an array that can be used to describe the internal state of this object.

Returns

array

__destruct() ¶ public

__destruct()

Destructor

_connect() ¶ protected

_connect(string $dsn, array $config): bool

Establishes a connection to the database server

Parameters

string $dsn: A Driver-specific PDO-DSN
array $config: configuration to be used for creating connection

Returns

bool

_deleteQueryTranslator() ¶ protected

_deleteQueryTranslator(Cake\Database\Query $query): Cake\Database\Query

Apply translation steps to delete queries.

Chops out aliases on delete query conditions as most database dialects do not support aliases in delete queries. This also removes aliases in table names as they frequently don't work either.

We are intentionally not supporting deletes with joins as they have even poorer support.

Parameters

Cake\Database\Query $query: The query to translate

Returns

Cake\Database\Query

_expressionTranslators() ¶ protected

_expressionTranslators(): array

Returns a dictionary of expressions to be transformed when compiling a Query to SQL. Array keys are method names to be called in this class

Returns

array

_insertQueryTranslator() ¶ protected

_insertQueryTranslator(Cake\Database\Query $query): Cake\Database\Query

Apply translation steps to insert queries.

Parameters

Cake\Database\Query $query: The query to translate

Returns

Cake\Database\Query

_pagingSubquery() ¶ protected

_pagingSubquery(Cake\Database\Query $original, int $limit, int $offset): Cake\Database\Query

Generate a paging subquery for older versions of SQLserver.

Prior to SQLServer 2012 there was no equivalent to LIMIT OFFSET, so a subquery must be used.

Parameters

Cake\Database\Query $original: The query to wrap in a subquery.
int $limit: The number of rows to fetch.
int $offset: The number of rows to offset.

Returns

Cake\Database\Query

_selectQueryTranslator() ¶ protected

_selectQueryTranslator(Cake\Database\Query $query): Cake\Database\Query

Modify the limit/offset to TSQL

Parameters

Cake\Database\Query $query: The query to translate

Returns

Cake\Database\Query

_transformDistinct() ¶ protected

_transformDistinct(Query $original): Query

Returns the passed query after rewriting the DISTINCT clause, so that drivers that do not support the "ON" part can provide the actual way it should be done

Parameters

Query $original: The query to be transformed

Returns

Query

_transformFunctionExpression() ¶ protected

_transformFunctionExpression(Cake\Database\Expression\FunctionExpression $expression): void

Receives a FunctionExpression and changes it so that it conforms to this SQL dialect.

Parameters

Cake\Database\Expression\FunctionExpression $expression: The function expression to convert to TSQL.

Returns

void

_transformTupleComparison() ¶ protected

_transformTupleComparison(Cake\Database\Expression\TupleComparison $expression, Cake\Database\Query $query): void

Receives a TupleExpression and changes it so that it conforms to this SQL dialect.

It transforms expressions looking like '(a, b) IN ((c, d), (e, f)' into an equivalent expression of the form '((a = c) AND (b = d)) OR ((a = e) AND (b = f))'.

It can also transform transform expressions where the right hand side is a query selecting the same amount of columns as the elements in the left hand side of the expression:

(a, b) IN (SELECT c, d FROM a_table) is transformed into

1 = (SELECT 1 FROM a_table WHERE (a = c) AND (b = d))

Parameters

Cake\Database\Expression\TupleComparison $expression: The expression to transform
Cake\Database\Query $query: The query to update.

Returns

void

_updateQueryTranslator() ¶ protected

_updateQueryTranslator(Cake\Database\Query $query): Cake\Database\Query

Apply translation steps to update queries.

Parameters

Cake\Database\Query $query: The query to translate

Returns

Cake\Database\Query

_version() ¶ public

_version(): int

Get the version of SQLserver we are connected to.

Returns

int

autoQuoting() ¶ public

autoQuoting(bool $enable = null): bool

Returns whether or not this driver should automatically quote identifiers in queries

If called with a boolean argument, it will toggle the auto quoting setting to the passed value

Parameters

bool $enable optional: whether to enable auto quoting

Returns

bool

beginTransaction() ¶ public

beginTransaction(): bool

Starts a transaction

Returns

bool

commitTransaction() ¶ public

commitTransaction(): bool

Commits a transaction

Returns

bool

compileQuery() ¶ public

compileQuery(Cake\Database\Query $query, Cake\Database\ValueBinder $generator): array

Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string

Parameters

Cake\Database\Query $query: The query to compile.
Cake\Database\ValueBinder $generator: The value binder to use.

Returns

array

connect() ¶ public

connect(): bool

Establishes a connection to the database server

Returns

bool

connection() ¶ public

connection(null|PDO $connection = null): PDO

Returns correct connection resource or object that is internally used If first argument is passed, it will set internal connection object or result to the value passed

Parameters

null|PDO $connection optional: The PDO connection instance.

Returns

PDO

disableForeignKeySQL() ¶ public

disableForeignKeySQL(): string

Get the SQL for disabling foreign keys

Returns

string

disconnect() ¶ public

disconnect(): void

Disconnects from database server

Returns

void

enableForeignKeySQL() ¶ public

enableForeignKeySQL(): string

Get the SQL for enabling foreign keys

Returns

string

enabled() ¶ public

enabled(): bool

Returns whether PHP is able to use this driver for connecting to database

Returns

bool

isConnected() ¶ public

isConnected(): bool

Check whether or not the driver is connected.

Returns

bool

lastInsertId() ¶ public

lastInsertId(string $table = null, string $column = null): string|int

Returns last id generated for a table or sequence in database

Parameters

string $table optional: table name or sequence to get last insert value from
string $column optional: the name of the column representing the primary key

Returns

string|int

newCompiler() ¶ public

newCompiler(): Cake\Database\SqlserverCompiler

Returns an instance of a QueryCompiler

Returns

Cake\Database\SqlserverCompiler

prepare() ¶ public

prepare(string|Cake\Database\Query $query): Cake\Database\StatementInterface

Prepares a sql statement to be executed

Parameters

string|Cake\Database\Query $query: The query to prepare.

Returns

Cake\Database\StatementInterface

queryTranslator() ¶ public

queryTranslator(string $type): callable

Returns a callable function that will be used to transform a passed Query object. This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.

Parameters

string $type: the type of query to be transformed (select, insert, update, delete)

Returns

callable

quote() ¶ public

quote(mixed $value, string $type): string

Returns a value in a safe representation to be used in a query string

Parameters

mixed $value: The value to quote.
string $type: Type to be used for determining kind of quoting to perform

Returns

string

quoteIdentifier() ¶ public

quoteIdentifier(string $identifier): string

Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words

Parameters

string $identifier: The identifier to quote.

Returns

string

releaseSavePointSQL() ¶ public

releaseSavePointSQL(string $name): string

Returns a SQL snippet for releasing a previously created save point

Parameters

string $name: save point name

Returns

string

rollbackSavePointSQL() ¶ public

rollbackSavePointSQL(string $name): string

Returns a SQL snippet for rollbacking a previously created save point

Parameters

string $name: save point name

Returns

string

rollbackTransaction() ¶ public

rollbackTransaction(): bool

Rollsback a transaction

Returns

bool

savePointSQL() ¶ public

savePointSQL(string $name): string

Returns a SQL snippet for creating a new transaction savepoint

Parameters

string $name: save point name

Returns

string

schemaDialect() ¶ public

schemaDialect(): Cake\Database\Schema\MysqlSchema

Get the schema dialect.

Used by Cake\Schema package to reflect schema and generate schema.

Returns

Cake\Database\Schema\MysqlSchema

schemaValue() ¶ public

schemaValue(mixed $value): string

Escapes values for use in schema definitions.

Parameters

mixed $value: The value to escape.

Returns

string

supportsDynamicConstraints() ¶ public

supportsDynamicConstraints(): bool

Returns whether the driver supports adding or dropping constraints to already created tables.

Returns

bool

supportsQuoting() ¶ public

supportsQuoting(): bool

Checks if the driver supports quoting, as PDO_ODBC does not support it.

Returns

bool

supportsSavePoints() ¶ public

supportsSavePoints(): bool

Returns whether this driver supports save points for nested transactions

Returns

bool

Property Detail

`$_autoQuoting` ¶ protected

Indicates whether or not the driver is doing automatic identifier quoting for all queries

Type

bool

`$_baseConfig` ¶ protected

Base configuration settings for Sqlserver driver

Type

array

`$_config` ¶ protected

Configuration data.

Type

array

`$_connection` ¶ protected

Instance of PDO.

Type

PDO

`$_endQuote` ¶ protected

String used to end a database identifier quoting to make it safe

Type

string

`$_startQuote` ¶ protected

String used to start a database identifier quoting to make it safe

Type

string

Namespaces

Class Sqlserver

Property Summary

Method Summary

__construct() public

__debugInfo() public

__destruct() public

_connect() protected

_deleteQueryTranslator() protected

_expressionTranslators() protected

_insertQueryTranslator() protected

_pagingSubquery() protected

_selectQueryTranslator() protected

_transformDistinct() protected

_transformFunctionExpression() protected

_transformTupleComparison() protected

_updateQueryTranslator() protected

_version() public

autoQuoting() public

beginTransaction() public

commitTransaction() public

compileQuery() public

connect() public

connection() public

disableForeignKeySQL() public

disconnect() public

enableForeignKeySQL() public

enabled() public

isConnected() public

lastInsertId() public

newCompiler() public

prepare() public

queryTranslator() public

quote() public

quoteIdentifier() public

releaseSavePointSQL() public

rollbackSavePointSQL() public

rollbackTransaction() public

savePointSQL() public

schemaDialect() public

schemaValue() public

supportsDynamicConstraints() public

supportsQuoting() public

supportsSavePoints() public

Method Detail

__construct() ¶ public

Parameters

Throws

__debugInfo() ¶ public

Returns

__destruct() ¶ public

_connect() ¶ protected

Parameters

Returns

_deleteQueryTranslator() ¶ protected

Parameters

Returns

_expressionTranslators() ¶ protected

Returns

_insertQueryTranslator() ¶ protected

Parameters

Returns

_pagingSubquery() ¶ protected

Parameters

Returns

_selectQueryTranslator() ¶ protected

Parameters

Returns

_transformDistinct() ¶ protected

Parameters

Returns

_transformFunctionExpression() ¶ protected

Parameters

Returns

_transformTupleComparison() ¶ protected

Parameters

Returns

_updateQueryTranslator() ¶ protected

Parameters

Returns