Properties

$_connection

$_connection : \PDO|null

Instance of PDO.

Type

\PDO|null

$_config

$_config : array

Configuration data.

Type

array

$_baseConfig

$_baseConfig : array

Base configuration settings for Sqlserver driver

Type

array

$_autoQuoting

$_autoQuoting : boolean

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

Type

boolean

Methods

__construct()

__construct(array  $config = array()) 

Constructor

Parameters

array $config

The configuration for the driver.

Throws

\InvalidArgumentException

connect()

connect() : boolean

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).

Throws

\InvalidArgumentException

if an unsupported setting is in the driver config

Returns

boolean —

true on success

disconnect()

disconnect() : void

Disconnects from database server.

connection()

connection(mixed  $connection = null) : mixed

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

mixed $connection

The PDO connection instance.

Returns

mixed —

Connection object used internally.

getConnection()

getConnection() : \PDO

Get the internal PDO connection instance.

Returns

\PDO

setConnection()

setConnection(\PDO  $connection) : $this

Set the internal PDO connection instance.

Parameters

\PDO $connection

PDO instance.

Returns

$this

enabled()

enabled() : boolean

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

Returns

boolean —

true if it is valid to use this driver

beginTransaction()

beginTransaction() : boolean

Starts a transaction.

Returns

boolean —

True on success, false otherwise.

commitTransaction()

commitTransaction() : boolean

Commits a transaction.

Returns

boolean —

True on success, false otherwise.

rollbackTransaction()

rollbackTransaction() : boolean

Rollbacks a transaction.

Returns

boolean —

True on success, false otherwise.

releaseSavePointSQL()

releaseSavePointSQL(string  $name) : string

Get the SQL for releasing a save point.

Parameters

string $name

The table name.

Returns

string

savePointSQL()

savePointSQL(string  $name) : string

Get the SQL for creating a save point.

Parameters

string $name

The table name.

Returns

string

rollbackSavePointSQL()

rollbackSavePointSQL(string  $name) : string

Get the SQL for rollingback a save point.

Parameters

string $name

The table name.

Returns

string

disableForeignKeySQL()

disableForeignKeySQL() : string

Get the SQL for disabling foreign keys.

Returns

string

enableForeignKeySQL()

enableForeignKeySQL() : string

Get the SQL for enabling foreign keys.

Returns

string

supportsDynamicConstraints()

supportsDynamicConstraints() : boolean

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

Returns

boolean —

true if driver supports dynamic constraints.

supportsSavePoints()

supportsSavePoints() : boolean

Returns whether this driver supports save points for nested transactions.

Returns

boolean —

True if save points are supported, false otherwise.

quote()

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

supportsQuoting()

supportsQuoting() : boolean

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

Returns

boolean

queryTranslator()

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

schemaDialect()

schemaDialect() : \Cake\Database\Schema\BaseSchema

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

quoteIdentifier()

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

Returns

string

schemaValue()

schemaValue(mixed  $value) : string

Escapes values for use in schema definitions.

Parameters

mixed $value

The value to escape.

Returns

string —

String for use in schema definitions.

schema()

schema() : string

Returns the schema name that's being used.

Returns

string

lastInsertId()

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

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

Parameters

string|null $table

table name or sequence to get last insert value from.

string|null $column

the name of the column representing the primary key.

Returns

string|integer

isConnected()

isConnected() : boolean

Checks whether or not the driver is connected.

Returns

boolean

enableAutoQuoting()

enableAutoQuoting(boolean  $enable = true) : $this

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

Parameters

boolean $enable

Whether to enable auto quoting

Returns

$this

disableAutoQuoting()

disableAutoQuoting() : $this

Disable auto quoting of identifiers in queries.

Returns

$this

isAutoQuotingEnabled()

isAutoQuotingEnabled() : boolean

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

Returns

boolean

autoQuoting()

autoQuoting(boolean|null  $enable = null) : boolean

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

Whether to enable auto quoting

Returns

boolean

compileQuery()

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 —

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

__destruct()

__destruct() 

Destructor

__debugInfo()

__debugInfo() : array

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

Returns

array

_connect()

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

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