Represents a database statement. Concrete implementations can either use PDOStatement or a native driver
string 'assoc' string 'num' string 'obj' Assign a value to a positional or named variable in prepared query. If using positional variables you need to start with index one, if using named params then just use the name in any order.
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.
Statements can be passed as argument for count() to return the number for affected rows from last execution
Returns the error code for the last error that occurred when executing this statement
Returns the error information for the last error that occurred when executing this statement
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
bind(array $params, array $types)
Binds a set of values to statement object with corresponding type
array $params list of values to be bound
array $types list of types to be used, keys should match those in $params
bindValue(mixed $column, mixed $value, mixed $type)
Assign a value to a positional or named variable in prepared query. If using positional variables you need to start with index one, if using named params then just use the name in any order.
It is not allowed to combine positional and named variables in the same statement
$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date'); string|int $column name or param position to be bound
mixed $value The value to bind to variable in query
string|int|null $type optional name of configured Type class, or PDO type constant.
closeCursor()
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()
Returns the number of columns this statement's results will contain
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2 intcount()
Statements can be passed as argument for count() to return the number for affected rows from last execution
interrorCode()
Returns the error code for the last error that occurred when executing this statement
int|stringerrorInfo()
Returns the error information for the last error that occurred when executing this statement
arrayexecute(?array $params)
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
array|null $params optional list of values to be bound to query
booltrue on success, false otherwise
fetch(mixed $type)
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
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title'] string|int $type optional 'num' for positional columns, assoc for named columns, or PDO fetch mode constants.
mixedResult array containing columns and values or false if no results are left
fetchAll(mixed $type)
Returns an array with all rows resulting from executing this statement
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']] string|int $type optional num for fetching columns as positional keys or assoc for column names as keys
array|falselist of all results from database for this statement or false on failure.
fetchColumn(int $position)
Returns the value of the result at position.
int $position The numeric position of the column to retrieve in the result
mixedReturns the specific value of the column designated at $position
lastInsertId(?string $table, ?string $column)
Returns the latest primary inserted using this statement
string|null $table optional table name or sequence to get last insert value from
string|null $column optional the name of the column representing the primary key
string|introwCount()
Returns the number of rows affected by this SQL statement
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1 int
© 2005–present 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/4.1/interface-Cake.Database.StatementInterface.html