Represents a database statement. Concrete implementations can either use PDOStatement or a native driver
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 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
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
bind( array $params , array $types )
Binds a set of values to statement object with corresponding type
$params
$types
bindValue( string|integer $column , mixed $value , string $type 'string' )
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');
$column
$value
$type
optional 'string' 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
count( )
Statements can be passed as argument for count() to return the number for affected rows from last execution
errorCode( )
Returns the error code for the last error that occurred when executing this statement
errorInfo( )
Returns the error information for the last error that occurred when executing this statement
execute( array|null $params null )
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
$params
optional null fetch( string $type 'num' )
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']
$type
optional 'num' Result array containing columns and values or false if no results are left
fetchAll( string $type 'num' )
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']]
$type
optional 'num' lastInsertId( string|null $table null , string|null $column null )
Returns the latest primary inserted using this statement
$table
optional null $column
optional null rowCount( )
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
© 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.4/class-Cake.Database.StatementInterface.html