connect()source public

connect( )

Establishes a connection to the database server.

Please note that the PDO::ATTR_PERSISTENT attribute is not supported by the SQL Server PHP PDO drivers. As a result you cannot use the persistent config option when connecting to a SQL Server (for more information see: https://github.com/Microsoft/msphpsql/issues/65).

Returns

boolean
true on success

Throws

InvalidArgumentException
if an unsupported setting is in the driver config

enabled()source public

enabled( )

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

Returns

boolean
true if it is valid to use this driver

prepare()source public

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

Prepares a sql statement to be executed

Parameters

string|Cake\Database\Query $query

The query to prepare.

Returns

Cake\Database\StatementInterface

Overrides

Cake\Database\Driver::prepare()

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Returns

boolean
true if driver supports dynamic constraints.

__construct()source public

__construct( array $config [] )

Constructor

Parameters

array $config optional []

The configuration for the driver.

Throws

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Returns

array

__destruct()source public

__destruct( )

Destructor

_connect()source protected

_connect( string $dsn , array $config )

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

boolean
true on success

autoQuoting()source public

autoQuoting( boolean|null $enable null )

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

Deprecated

3.4.0 use enableAutoQuoting()/isAutoQuotingEnabled() instead.

Parameters

boolean|null $enable optional null

Whether to enable auto quoting

Returns

boolean

beginTransaction()source public

beginTransaction( )

Starts a transaction.

Returns

boolean
True on success, false otherwise.

Implementation of

Cake\Database\DriverInterface::beginTransaction()

commitTransaction()source public

commitTransaction( )

Commits a transaction.

Returns

boolean
True on success, false otherwise.

Implementation of

Cake\Database\DriverInterface::commitTransaction()

compileQuery()source public

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

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

containing 2 entries. The first entity is the transformed query and the second one the compiled SQL.

Implementation of

Cake\Database\DriverInterface::compileQuery()

connection()source public

connection( mixed $connection null )

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.

Deprecated

3.6.0 Use getConnection()/setConnection() instead.

Parameters

mixed $connection optional null

The PDO connection instance.

Returns

mixed
Connection object used internally.

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

Get the SQL for disabling foreign keys.

Returns

string

Implementation of

Cake\Database\DriverInterface::disableForeignKeySQL()

disconnect()source public

disconnect( )

Disconnects from database server.

Implementation of

Cake\Database\DriverInterface::disconnect()

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable true )

Sets whether or not this driver should automatically quote identifiers in queries.

Parameters

boolean $enable optional true

Whether to enable auto quoting

Returns

$this

Implementation of

Cake\Database\DriverInterface::enableAutoQuoting()

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

Get the SQL for enabling foreign keys.

Returns

string

Implementation of

Cake\Database\DriverInterface::enableForeignKeySQL()

getConnection()source public

getConnection( )

Get the internal PDO connection instance.

Returns

PDO

Implementation of

Cake\Database\DriverInterface::getConnection()

isAutoQuotingEnabled()source public

isAutoQuotingEnabled( )

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

Returns

boolean

Implementation of

Cake\Database\DriverInterface::isAutoQuotingEnabled()

isConnected()source public

isConnected( )

Checks whether or not the driver is connected.

Returns

boolean

Implementation of

Cake\Database\DriverInterface::isConnected()

lastInsertId()source public

lastInsertId( string|null $table null , string|null $column null )

Returns last id generated for a table or sequence in database.

Parameters

string|null $table optional null

table name or sequence to get last insert value from.

string|null $column optional null

the name of the column representing the primary key.

Returns

string|integer

Implementation of

Cake\Database\DriverInterface::lastInsertId()

newCompiler()source public

newCompiler( )

Returns an instance of a QueryCompiler.

Returns

Cake\Database\QueryCompiler

Implementation of

Cake\Database\DriverInterface::newCompiler()

queryTranslator()source abstract public

queryTranslator( string $type )

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

Implementation of

Cake\Database\DriverInterface::queryTranslator()

quote()source public

quote( mixed $value , string $type )

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

Implementation of

Cake\Database\DriverInterface::quote()

quoteIdentifier()source abstract public

quoteIdentifier( string $identifier )

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 expression to quote.

Returns

string

Implementation of

Cake\Database\DriverInterface::quoteIdentifier()

releaseSavePointSQL()source abstract public

releaseSavePointSQL( string $name )

Get the SQL for releasing a save point.

Parameters

string $name

The table name.

Returns

string

Implementation of

Cake\Database\DriverInterface::releaseSavePointSQL()

rollbackSavePointSQL()source abstract public

rollbackSavePointSQL( string $name )

Get the SQL for rollingback a save point.

Parameters

string $name

The table name.

Returns

string

Implementation of

Cake\Database\DriverInterface::rollbackSavePointSQL()

rollbackTransaction()source public

rollbackTransaction( )

Rollbacks a transaction.

Returns

boolean
True on success, false otherwise.

Implementation of

Cake\Database\DriverInterface::rollbackTransaction()

savePointSQL()source abstract public

savePointSQL( string $name )

Get the SQL for creating a save point.

Parameters

string $name

The table name.

Returns

string

Implementation of

Cake\Database\DriverInterface::savePointSQL()

schema()source public

schema( )

Returns the schema name that's being used.

Returns

string

Implementation of

Cake\Database\DriverInterface::schema()

schemaDialect()source abstract public

schemaDialect( )

Get the schema dialect.

Returns

Cake\Database\Schema\BaseSchema

Implementation of

Cake\Database\DriverInterface::schemaDialect()

schemaValue()source public

schemaValue( mixed $value )

Escapes values for use in schema definitions.

Parameters

mixed $value

The value to escape.

Returns

string
String for use in schema definitions.

Implementation of

Cake\Database\DriverInterface::schemaValue()

setConnection()source public

setConnection( PDO $connection )

Set the internal PDO connection instance.

Parameters

PDO $connection

PDO instance.

Returns

$this

Implementation of

Cake\Database\DriverInterface::setConnection()

supportsQuoting()source public

supportsQuoting( )

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

Returns

boolean

Implementation of

Cake\Database\DriverInterface::supportsQuoting()

supportsSavePoints()source public

supportsSavePoints( )

Returns whether this driver supports save points for nested transactions.

Returns

boolean
True if save points are supported, false otherwise.

Implementation of

Cake\Database\DriverInterface::supportsSavePoints()

_expressionTranslators()source protected

_expressionTranslators( )

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

_pagingSubquery()source protected

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

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.

integer $limit

The number of rows to fetch.

integer $offset

The number of rows to offset.

Returns

Cake\Database\Query
Modified query object.

_selectQueryTranslator()source protected

_selectQueryTranslator( Cake\Database\Query $query )

Modify the limit/offset to TSQL

Parameters

Cake\Database\Query $query

The query to translate

Returns

Cake\Database\Query
The modified query

_transformDistinct()source protected

_transformDistinct( Cake\Database\Query $original )

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

Cake\Database\Query $original

The query to be transformed

Returns

Cake\Database\Query

_transformFunctionExpression()source protected

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

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.

_version()source public

_version( )

disableForeignKeySQL()source public

disableForeignKeySQL( )

enableForeignKeySQL()source public

enableForeignKeySQL( )

newCompiler()source public

newCompiler( )

Returns

Cake\Database\SqlserverCompiler

releaseSavePointSQL()source public

releaseSavePointSQL( string $name )

Returns a SQL snippet for releasing a previously created save point

Parameters

string $name

save point name

Returns

string

rollbackSavePointSQL()source public

rollbackSavePointSQL( string $name )

Returns a SQL snippet for rollbacking a previously created save point

Parameters

string $name

save point name

Returns

string

savePointSQL()source public

savePointSQL( string $name )

Returns a SQL snippet for creating a new transaction savepoint

Parameters

string $name

save point name

Returns

string

schemaDialect()source public

schemaDialect( )

Get the schema dialect.

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

Returns

Cake\Database\Schema\SqlserverSchema

[
    'host' => 'localhost\SQLEXPRESS',
    'username' => '',
    'password' => '',
    'database' => 'cake',
    'port' => '',
    // PDO::SQLSRV_ENCODING_UTF8
    'encoding' => 65001,
    'flags' => [],
    'init' => [],
    'settings' => [],
    'attributes' => [],
    'app' => null,
    'connectionPooling' => null,
    'failoverPartner' => null,
    'loginTimeout' => null,
    'multiSubnetFailover' => null,
]