Olu Amey
129 lines
3.1 KiB
PHP
129 lines
3.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This file is part of the CodeIgniter 4 framework.
|
|
*
|
|
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace CodeIgniter\Database;
|
|
|
|
/**
|
|
* Interface QueryInterface
|
|
*
|
|
* Represents a single statement that can be executed against the database.
|
|
* Statements are platform-specific and can handle binding of binds.
|
|
*/
|
|
interface QueryInterface
|
|
{
|
|
/**
|
|
* Sets the raw query string to use for this statement.
|
|
*
|
|
* @param string $sql
|
|
* @param mixed $binds
|
|
* @param boolean $setEscape
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function setQuery(string $sql, $binds = null, bool $setEscape = true);
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the final, processed query string after binding, etal
|
|
* has been performed.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getQuery();
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Records the execution time of the statement using microtime(true)
|
|
* for it's start and end values. If no end value is present, will
|
|
* use the current time to determine total duration.
|
|
*
|
|
* @param float $start
|
|
* @param float $end
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function setDuration(float $start, float $end = null);
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the duration of this query during execution, or null if
|
|
* the query has not been executed yet.
|
|
*
|
|
* @param integer $decimals The accuracy of the returned time.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDuration(int $decimals = 6): string;
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Stores the error description that happened for this query.
|
|
*
|
|
* @param integer $code
|
|
* @param string $error
|
|
*/
|
|
public function setError(int $code, string $error);
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Reports whether this statement created an error not.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function hasError(): bool;
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the error code created while executing this statement.
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getErrorCode(): int;
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the error message created while executing this statement.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getErrorMessage(): string;
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Determines if the statement is a write-type query or not.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function isWriteType(): bool;
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Swaps out one table prefix for a new one.
|
|
*
|
|
* @param string $orig
|
|
* @param string $swap
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function swapPrefix(string $orig, string $swap);
|
|
|
|
//--------------------------------------------------------------------
|
|
}
|