From 57d72761cb7e4bb601f164c01f3b031b5edcac88 Mon Sep 17 00:00:00 2001 From: Aaron Piotrowski Date: Thu, 28 Jun 2018 16:16:18 -0500 Subject: [PATCH] Remove dups; add some docs; update Pool --- src/Connection.php | 23 ++++++---------------- src/Executor.php | 24 +++++++++++------------ src/Link.php | 6 ++++-- src/Pool.php | 48 ++++++++++++++++++++++----------------------- src/Statement.php | 2 +- src/Transaction.php | 12 ++++++------ 6 files changed, 53 insertions(+), 62 deletions(-) diff --git a/src/Connection.php b/src/Connection.php index 275f1e9..cc7b9da 100644 --- a/src/Connection.php +++ b/src/Connection.php @@ -2,31 +2,20 @@ namespace Amp\Sql; +use Amp\CancellationToken; use Amp\Promise; interface Connection extends Link { - public function connect(): Promise; - /** - * @return bool False if the connection has been closed. + * @param ConnectionConfig $config + * @param CancellationToken|null $token + * + * @return Promise */ - public function isAlive(): bool; + public static function connect(ConnectionConfig $config, CancellationToken $token = null): Promise; /** * @return int Timestamp of the last time this connection was used. */ public function lastUsedAt(): int; - - public function close(); - - public function query(string $query): Promise; - - public function transaction(int $isolation = Transaction::COMMITTED): Promise; - - public function prepare(string $query): Promise; - - /** - * {@inheritdoc} - */ - public function execute(string $sql, array $params = []): Promise; } diff --git a/src/Executor.php b/src/Executor.php index 50a2c31..074a7de 100644 --- a/src/Executor.php +++ b/src/Executor.php @@ -8,22 +8,22 @@ interface Executor { /** * @param string $sql SQL query to execute. * - * @return \Amp\Promise<\Amp\Sql\CommandResult|\Amp\Sql\ResultSet> + * @return Promise * - * @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). + * @throws FailureException If the operation fails due to unexpected condition. + * @throws ConnectionException If the connection to the database is lost. + * @throws 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> + * @return Promise * - * @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). + * @throws FailureException If the operation fails due to unexpected condition. + * @throws ConnectionException If the connection to the database is lost. + * @throws QueryError If the operation fails due to an error in the query (such as a syntax error). */ public function prepare(string $sql): Promise; @@ -31,11 +31,11 @@ interface Executor { * @param string $sql SQL query to prepare and execute. * @param mixed[] $params Query parameters. * - * @return \Amp\Promise<\Amp\Sql\CommandResult|\Amp\Sql\ResultSet> + * @return Promise * - * @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). + * @throws FailureException If the operation fails due to unexpected condition. + * @throws ConnectionException If the connection to the database is lost. + * @throws 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; diff --git a/src/Link.php b/src/Link.php index 90b3108..1f67e28 100644 --- a/src/Link.php +++ b/src/Link.php @@ -8,7 +8,9 @@ interface Link extends Executor { /** * Starts a transaction on a single connection. * - * @return \Amp\Promise + * @param int $isolation Transaction isolation level. + * + * @return Promise */ - public function transaction(): Promise; + public function transaction(int $isolation = Transaction::ISOLATION_COMMITTED): Promise; } diff --git a/src/Pool.php b/src/Pool.php index efec222..e92d26b 100644 --- a/src/Pool.php +++ b/src/Pool.php @@ -4,37 +4,37 @@ namespace Amp\Sql; use Amp\Promise; -interface Pool extends Link -{ +interface Pool extends Link { const DEFAULT_MAX_CONNECTIONS = 100; const DEFAULT_IDLE_TIMEOUT = 60; - public function getIdleTimeout(): int; - /** - * @param int $timeout The maximum number of seconds a connection may be idle before being closed and removed - * from the pool. - * - * @throws \Error If the timeout is less than 1. - */ - public function setIdleTimeout(int $timeout); - - public function getMaxConnections(): int; - - public function getConnectionCount(): int; - - public function getIdleConnectionCount(): int; - - /** - * Extracts an idle connection from the pool. The connection is completely removed from the pool and cannot be - * put back into the pool. Useful for operations where connection state must be changed. - * - * @return \Amp\Promise<\Amp\Sql\Connection> + * @return Promise */ public function extractConnection(): Promise; /** - * {@inheritdoc} + * @return int Total number of active connections in the pool. */ - public function transaction(int $isolation = Transaction::COMMITTED): Promise; + public function getConnectionCount(): int; + + /** + * @return int Total number of idle connections in the pool. + */ + public function getIdleConnectionCount(): int; + + /** + * @return int Maximum number of connections this pool will create. + */ + public function getMaxConnections(): int; + + /** + * @return int Number of seconds a connection may remain idle before it is automatically closed. + */ + public function getIdleTimeout(): int; + + /** + * @param int $timeout Number of seconds a connection may remain idle before it is automatically closed. + */ + public function setIdleTimeout(int $timeout); } diff --git a/src/Statement.php b/src/Statement.php index 071a905..5f0a41d 100644 --- a/src/Statement.php +++ b/src/Statement.php @@ -8,7 +8,7 @@ interface Statement { /** * @param mixed[] $params * - * @return \Amp\Promise<\Amp\Sql\CommandResult> + * @return \Amp\Promise */ public function execute(array $params = []): Promise; diff --git a/src/Transaction.php b/src/Transaction.php index b73da74..225a5ed 100644 --- a/src/Transaction.php +++ b/src/Transaction.php @@ -5,10 +5,10 @@ namespace Amp\Sql; use Amp\Promise; interface Transaction extends Executor, Operation { - const UNCOMMITTED = 0; - const COMMITTED = 1; - const REPEATABLE = 2; - const SERIALIZABLE = 4; + const ISOLATION_UNCOMMITTED = 0; + const ISOLATION_COMMITTED = 1; + const ISOLATION_REPEATABLE = 2; + const ISOLATION_SERIALIZABLE = 4; /** * @return int @@ -47,7 +47,7 @@ interface Transaction extends Executor, Operation { * * @throws \Amp\Sql\TransactionError If the transaction has been committed or rolled back. */ - public function savepoint(string $identifier): Promise; + public function createSavepoint(string $identifier): Promise; /** * Rolls back to the savepoint with the given identifier. @@ -69,5 +69,5 @@ interface Transaction extends Executor, Operation { * * @throws \Amp\Sql\TransactionError If the transaction has been committed or rolled back. */ - public function release(string $identifier): Promise; + public function releaseSavepoint(string $identifier): Promise; }