54 lines
1.8 KiB
PHP
54 lines
1.8 KiB
PHP
<?php
|
|
|
|
namespace Amp\Sql;
|
|
|
|
use Amp\Promise;
|
|
|
|
interface Executor {
|
|
/**
|
|
* @param string $sql SQL query to execute.
|
|
*
|
|
* @return \Amp\Promise<\Amp\Sql\CommandResult|\Amp\Sql\ResultSet>
|
|
*
|
|
* @throws \Amp\Sql\FailureException If the operation fails due to unexpected condition.
|
|
* @throws \Amp\Sql\ConnectionException If the connection to the database is lost.
|
|
* @throws \Amp\Sql\QueryError If the operation fails due to an error in the query (such as a syntax error).
|
|
*/
|
|
public function query(string $sql): Promise;
|
|
|
|
/**
|
|
* @param string $sql SQL query to prepare.
|
|
*
|
|
* @return \Amp\Promise<\Amp\Mysql\Statement>
|
|
*
|
|
* @throws \Amp\Sql\FailureException If the operation fails due to unexpected condition.
|
|
* @throws \Amp\Sql\ConnectionException If the connection to the database is lost.
|
|
* @throws \Amp\Sql\QueryError If the operation fails due to an error in the query (such as a syntax error).
|
|
*/
|
|
public function prepare(string $sql): Promise;
|
|
|
|
/**
|
|
* @param string $sql SQL query to prepare and execute.
|
|
* @param mixed[] $params Query parameters.
|
|
*
|
|
* @return \Amp\Promise<\Amp\Sql\CommandResult|\Amp\Sql\ResultSet>
|
|
*
|
|
* @throws \Amp\Sql\FailureException If the operation fails due to unexpected condition.
|
|
* @throws \Amp\Sql\ConnectionException If the connection to the database is lost.
|
|
* @throws \Amp\Sql\QueryError If the operation fails due to an error in the query (such as a syntax error).
|
|
*/
|
|
public function execute(string $sql, array $params = []): Promise;
|
|
|
|
/**
|
|
* Indicates if the connection to the database is still alive.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isAlive(): bool;
|
|
|
|
/**
|
|
* Closes the executor. No further queries may be performed.
|
|
*/
|
|
public function close();
|
|
}
|