Class Sqlserver
SQLServer driver.
- Cake\Database\Driver
-
Cake\Database\Driver\Sqlserver uses Cake\Database\Driver\PDODriverTrait , Cake\Database\Dialect\SqlserverDialectTrait
Properties summary
-
$_baseConfig
protectedBase configuration settings for Sqlserver driverarray
Inherited Properties
-
_autoQuoting
,_config
_connection
_endQuote
,_startQuote
Method Summary
- connect() publicEstablishes a connection to the database server
- enabled() publicReturns whether PHP is able to use this driver for connecting to database
- prepare() publicPrepares a sql statement to be executed
- supportsDynamicConstraints() public
Returns whether the driver supports adding or dropping constraints to already created tables.
Method Detail
connect()source public
connect( )
Establishes a connection to the database server
Returns
booleantrue on success
enabled()source public
enabled( )
Returns whether PHP is able to use this driver for connecting to database
Returns
booleantrue 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
supportsDynamicConstraints()source public
supportsDynamicConstraints( )
Returns whether the driver supports adding or dropping constraints to already created tables.
Returns
booleantrue if driver supports dynamic constraints
Methods inherited from Cake\Database\Driver
__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
arrayautoQuoting()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
Parameters
- boolean|null
$enable
optional null - whether to enable auto quoting
Returns
booleanbeginTransaction()source abstract public
beginTransaction( )
Starts a transaction
Returns
booleantrue on success, false otherwise
commitTransaction()source abstract public
commitTransaction( )
Commits a transaction
Returns
booleantrue on success, false otherwise
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
arraycontaining 2 entries. The first entity is the transformed query and the second one the compiled SQL
connection()source abstract public
connection( null|PDO $connection null )
Returns correct connection resource or object that is internally used If first argument is passed,
Parameters
- null|PDO
$connection
optional null - The connection object
disableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Get the SQL for disabling foreign keys
Returns
stringenableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Get the SQL for enabling foreign keys
Returns
stringisConnected()source public
isConnected( )
Check whether or not the driver is connected.
Returns
booleanlastInsertId()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|integernewCompiler()source public
newCompiler( )
Returns an instance of a QueryCompiler
Returns
Cake\Database\QueryCompilerqueryTranslator()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
callablequote()source abstract 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
stringquoteIdentifier()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
stringreleaseSavePointSQL()source abstract public
releaseSavePointSQL( string $name )
Get the SQL for releasing a save point.
Parameters
- string
$name
- The table name
Returns
stringrollbackSavePointSQL()source abstract public
rollbackSavePointSQL( string $name )
Get the SQL for rollingback a save point.
Parameters
- string
$name
- The table name
Returns
stringrollbackTransaction()source abstract public
rollbackTransaction( )
Rollsback a transaction
Returns
booleantrue on success, false otherwise
savePointSQL()source abstract public
savePointSQL( string $name )
Get the SQL for creating a save point.
Parameters
- string
$name
- The table name
Returns
stringschemaDialect()source abstract public
schemaDialect( )
Get the schema dialect.
Used by Cake\Database\Schema package to reflect schema and generate schema.
If all the tables that use this Driver specify their own schemas, then this may return null.
Returns
Cake\Database\Schema\BaseSchema
schemaValue()source public
schemaValue( mixed $value )
Escapes values for use in schema definitions.
Parameters
- mixed
$value
- The value to escape.
Returns
stringString for use in schema definitions.
supportsQuoting()source public
supportsQuoting( )
Checks if the driver supports quoting
Returns
booleansupportsSavePoints()source public
supportsSavePoints( )
Returns whether this driver supports save points for nested transactions
Returns
booleantrue if save points are supported, false otherwise
Methods used from Cake\Database\Driver\PDODriverTrait
_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
booleantrue on success
beginTransaction()source public
beginTransaction( )
Starts a transaction
Returns
booleantrue on success, false otherwise
commitTransaction()source public
commitTransaction( )
Commits a transaction
Returns
booleantrue on success, false otherwise
connection()source public
connection( null|PDO $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
Parameters
- null|PDO
$connection
optional null - The PDO connection instance.
Returns
PDOconnection object used internally
isConnected()source public
isConnected( )
Check whether or not the driver is connected.
Returns
booleanlastInsertId()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|integerquote()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
stringrollbackTransaction()source public
rollbackTransaction( )
Rollback a transaction
Returns
booleantrue on success, false otherwise
supportsQuoting()source public
supportsQuoting( )
Checks if the driver supports quoting, as PDO_ODBC does not support it.
Returns
booleanMethods used from Cake\Database\Dialect\SqlserverDialectTrait
_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\QueryModified 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\QueryThe 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( )
Get the version of SQLserver we are connected to.
Returns
integerdisableForeignKeySQL()source public
disableForeignKeySQL( )
enableForeignKeySQL()source public
enableForeignKeySQL( )
releaseSavePointSQL()source public
releaseSavePointSQL( string $name )
Returns a SQL snippet for releasing a previously created save point
Parameters
- string
$name
- save point name
Returns
stringrollbackSavePointSQL()source public
rollbackSavePointSQL( string $name )
Returns a SQL snippet for rollbacking a previously created save point
Parameters
- string
$name
- save point name
Returns
stringsavePointSQL()source public
savePointSQL( string $name )
Returns a SQL snippet for creating a new transaction savepoint
Parameters
- string
$name
- save point name
Returns
stringschemaDialect()source public
schemaDialect( )
Get the schema dialect.
Used by Cake\Schema package to reflect schema and generate schema.
Returns
Cake\Database\Schema\MysqlSchemaProperties detail
$_baseConfigsource
protected array
Base configuration settings for Sqlserver driver
[ 'persistent' => false, 'host' => 'localhost\SQLEXPRESS', 'username' => '', 'password' => '', 'database' => 'cake', // PDO::SQLSRV_ENCODING_UTF8 'encoding' => 65001, 'flags' => [], 'init' => [], 'settings' => [], ]
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.3/class-Cake.Database.Driver.Sqlserver.html