Class Sqlserver
SQLServer driver.
- Cake\Database\Driver implements Cake\Database\DriverInterface
-
Cake\Database\Driver\Sqlserver
uses
Cake\Database\Dialect\SqlserverDialectTrait
Properties summary
-
$_baseConfigprotectedarrayBase configuration settings for Sqlserver driver
Inherited Properties
-
_autoQuoting,_config,_connection_endQuote,_startQuote
Method Summary
-
connect() public
Establishes a connection to the database server. -
enabled() public
Returns whether PHP is able to use this driver for connecting to database -
prepare() public
Prepares a sql statement to be executed -
supportsDynamicConstraints() public
Returns whether the driver supports adding or dropping constraints to already created tables.
Method Detail
connect() 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
true on success
Throws
if an unsupported setting is in the driver config
enabled() public ¶
enabled( )
Returns whether PHP is able to use this driver for connecting to database
Returns
true if it is valid to use this driver
prepare() 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
Overrides
supportsDynamicConstraints() public ¶
supportsDynamicConstraints( )
Returns whether the driver supports adding or dropping constraints to already created tables.
Returns
true if driver supports dynamic constraints.
Methods inherited from Cake\Database\Driver
__construct() public ¶
__construct( array $config = [] )
Constructor
Parameters
- array $config optional []
- The configuration for the driver.
Throws
__debugInfo() public ¶
__debugInfo( )
Returns an array that can be used to describe the internal state of this object.
Returns
_connect() 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
true on success
autoQuoting() public deprecated ¶
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
Parameters
- boolean|null $enable optional null
- Whether to enable auto quoting
Returns
beginTransaction() public ¶
beginTransaction( )
Starts a transaction.
Returns
True on success, false otherwise.
Implementation of
commitTransaction() public ¶
commitTransaction( )
Commits a transaction.
Returns
True on success, false otherwise.
Implementation of
compileQuery() 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
containing 2 entries. The first entity is the transformed query and the second one the compiled SQL.
Implementation of
connection() public deprecated ¶
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
Parameters
- mixed $connection optional null
- The PDO connection instance.
Returns
Connection object used internally.
disableAutoQuoting() public ¶
disableAutoQuoting( )
Disable auto quoting of identifiers in queries.
Returns
$this
disableForeignKeySQL() abstract public ¶
disableForeignKeySQL( )
Get the SQL for disabling foreign keys.
Returns
Implementation of
enableAutoQuoting() 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
enableForeignKeySQL() abstract public ¶
enableForeignKeySQL( )
Get the SQL for enabling foreign keys.
Returns
Implementation of
getConnection() public ¶
getConnection( )
Get the internal PDO connection instance.
Returns
Implementation of
isAutoQuotingEnabled() public ¶
isAutoQuotingEnabled( )
Returns whether or not this driver should automatically quote identifiers in queries.
Returns
Implementation of
isConnected() public ¶
isConnected( )
Checks whether or not the driver is connected.
Returns
Implementation of
lastInsertId() 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
Implementation of
newCompiler() public ¶
newCompiler( )
Returns an instance of a QueryCompiler.
Returns
Implementation of
queryTranslator() 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
Implementation of
quote() 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
Implementation of
quoteIdentifier() 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
Implementation of
releaseSavePointSQL() abstract public ¶
releaseSavePointSQL( string $name )
Get the SQL for releasing a save point.
Parameters
- string $name
- The table name.
Returns
Implementation of
rollbackSavePointSQL() abstract public ¶
rollbackSavePointSQL( string $name )
Get the SQL for rollingback a save point.
Parameters
- string $name
- The table name.
Returns
Implementation of
rollbackTransaction() public ¶
rollbackTransaction( )
Rollbacks a transaction.
Returns
True on success, false otherwise.
Implementation of
savePointSQL() abstract public ¶
savePointSQL( string $name )
Get the SQL for creating a save point.
Parameters
- string $name
- The table name.
Returns
Implementation of
schema() public ¶
schema( )
Returns the schema name that's being used.
Returns
Implementation of
schemaDialect() abstract public ¶
schemaDialect( )
Get the schema dialect.
Returns
Implementation of
schemaValue() public ¶
schemaValue( mixed $value )
Escapes values for use in schema definitions.
Parameters
- mixed $value
- The value to escape.
Returns
String for use in schema definitions.
Implementation of
setConnection() public ¶
setConnection( PDO $connection )
Set the internal PDO connection instance.
Parameters
- PDO $connection
- PDO instance.
Returns
$this
Implementation of
supportsQuoting() public ¶
supportsQuoting( )
Checks if the driver supports quoting, as PDO_ODBC does not support it.
Returns
Implementation of
supportsSavePoints() public ¶
supportsSavePoints( )
Returns whether this driver supports save points for nested transactions.
Returns
True if save points are supported, false otherwise.
Implementation of
Methods used from Cake\Database\Dialect\SqlserverDialectTrait
_expressionTranslators() 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
_pagingSubquery() 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
Modified query object.
_selectQueryTranslator() protected ¶
_selectQueryTranslator( Cake\Database\Query $query )
Modify the limit/offset to TSQL
Parameters
- Cake\Database\Query $query
- The query to translate
Returns
The modified query
_transformDistinct() 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
_transformFunctionExpression() 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.
releaseSavePointSQL() public ¶
releaseSavePointSQL( string $name )
Returns a SQL snippet for releasing a previously created save point
Parameters
- string $name
- save point name
Returns
rollbackSavePointSQL() public ¶
rollbackSavePointSQL( string $name )
Returns a SQL snippet for rollbacking a previously created save point
Parameters
- string $name
- save point name
Returns
savePointSQL() public ¶
savePointSQL( string $name )
Returns a SQL snippet for creating a new transaction savepoint
Parameters
- string $name
- save point name
Returns
schemaDialect() public ¶
schemaDialect( )
Get the schema dialect.
Used by Cake\Schema package to reflect schema and generate schema.
Returns
Properties detail
$_baseConfig ¶
Base configuration settings for Sqlserver driver
[
'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,
]