\Cake\Database\StatementSqlserverStatement

__construct()

__construct(\Cake\Database\StatementInterface|\PDOStatement|null  $statement = null, \Cake\Database\Driver|null  $driver = null) 

Constructor

Parameters

bindValue()

bindValue(string|integer  $column, mixed  $value, string|integer  $type = 'string') : void

The SQL Server PDO driver requires that binary parameters be bound with the SQLSRV_ENCODING_BINARY attribute.

This overrides the PDOStatement::bindValue method in order to bind binary columns using the required attribute.

You can pass PDO compatible constants for binding values with a type or optionally any type name registered in the Type class. Any value will be converted to the valid type representation if needed.

It is not allowed to combine positional and named variables in the same statement

Examples:

$statement->bindValue(1, 'a title');
$statement->bindValue(2, 5, PDO::INT);
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');

Parameters

fetch()

fetch(string  $type = self::FETCH_TYPE_NUM) : array|false

Returns the next row for the result set after executing this statement.

Rows can be fetched to contain columns as names or positions. If no rows are left in result set, this method will return false.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']

Parameters

Returns

Result array containing columns and values or false if no results are left

fetchAll()

fetchAll(string  $type = self::FETCH_TYPE_NUM) : array

Returns an array with all rows resulting from executing this statement.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]

Parameters

Returns

List of all results from database for this statement

__get()

__get(string  $property) : mixed

Magic getter to return $queryString as read-only.

Parameters

Returns

closeCursor()

closeCursor() : void

Closes a cursor in the database, freeing up any resources and memory allocated to it. In most cases you don't need to call this method, as it is automatically called after fetching all results from the result set.

columnCount()

columnCount() : integer

Returns the number of columns this statement's results will contain.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2

Returns

errorCode()

errorCode() : integer|string

Returns the error code for the last error that occurred when executing this statement.

Returns

errorInfo()

errorInfo() : array

Returns the error information for the last error that occurred when executing this statement.

Returns

execute()

execute(array|null  $params = null) : boolean

Executes the statement by sending the SQL query to the database. It can optionally take an array or arguments to be bound to the query variables. Please note that binding parameters from this method will not perform any custom type conversion as it would normally happen when calling `bindValue`.

Parameters

Returns

true on success, false otherwise

fetchAssoc()

fetchAssoc() : array

Returns the next row in a result set as an associative array. Calling this function is the same as calling $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). If no results are found false is returned.

Returns

Result array containing columns and values an an associative array or an empty array if no results

fetchColumn()

fetchColumn(integer  $position) : mixed|false

Returns the value of the result at position.

Parameters

Returns

Returns the specific value of the column designated at $position

rowCount()

rowCount() : integer

Returns the number of rows affected by this SQL statement.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1

Returns

getIterator()

getIterator() : \Cake\Database\StatementInterface|\PDOStatement

Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
  //do stuff
}

Returns

count()

count() : integer

Statements can be passed as argument for count() to return the number for affected rows from last execution.

Returns

bind()

bind(array  $params, array  $types) : void

Binds a set of values to statement object with corresponding type.

Parameters

lastInsertId()

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

Returns the latest primary inserted using this statement.

Parameters

Returns

getInnerStatement()

getInnerStatement() : \Cake\Database\StatementInterface|\PDOStatement

Returns the statement object that was decorated by this class.

Returns

cast()

cast(mixed  $value, \Cake\Database\Type|string  $type) : array

Converts a give value to a suitable database value based on type and return relevant internal statement type

Parameters

Returns

list containing converted value and internal type

matchTypes()

matchTypes(array  $columns, array  $types) : array

Matches columns to corresponding types

Both $columns and $types should either be numeric based or string key based at the same time.

Parameters

Returns