Add execute() method

Prepare and execute in a single method.

Author: trowski

lib/AbstractPool.php

@@ -182,6 +182,35 @@ private function doPrepare(string $sql): \Generator {
         return $statement;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function execute(string $sql, ...$data): Promise {
+        return new Coroutine($this->doExecute($sql, $data));
+    }
+
+    private function doExecute(string $sql, array $data): \Generator {
+        /** @var \Amp\Mysql\Connection $connection */
+        $connection = yield from $this->pop();
+
+        try {
+            $result = yield $connection->execute($sql, ...$data);
+        } catch (\Throwable $exception) {
+            $this->push($connection);
+            throw $exception;
+        }
+
+        if ($result instanceof Operation) {
+            $result->onComplete(function () use ($connection) {
+                $this->push($connection);
+            });
+        } else {
+            $this->push($connection);
+        }
+
+        return $result;
+    }
+
     /**
      * {@inheritdoc}
      */

lib/Connection.php

@@ -320,6 +320,17 @@ public function prepare(string $query): Promise {
         return $promise;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function execute(string $sql, ...$data): Promise {
+        return \Amp\call(function () use ($sql, $data) {
+            /** @var \Amp\Mysql\Statement $statment */
+            $statment = yield $this->prepare($sql);
+            return yield $statment->execute(...$data);
+        });
+    }
+
     public function __destruct() {
         $this->processor->delRef();
     }

lib/Executor.php

@@ -6,9 +6,9 @@
 
 interface Executor {
     /**
-     * @param string $sql
+     * @param string $sql SQL query to execute.
      *
-     * @return \Amp\Promise<\Amp\Postgres\CommandResult|\Amp\Postgres\TupleResult>
+     * @return \Amp\Promise<\Amp\Mysql\CommandResult|\Amp\Mysql\ResultSet>
      *
      * @throws \Amp\Mysql\FailureException If the operation fails due to unexpected condition.
      * @throws \Amp\Mysql\ConnectionException If the connection to the database is lost.
@@ -17,16 +17,28 @@ interface Executor {
     public function query(string $sql): Promise;
 
     /**
-     * @param string $sql
+     * @param string $sql SQL query to prepare.
      *
-     * @return \Amp\Promise<\Amp\Postgres\Statement>
+     * @return \Amp\Promise<\Amp\Mysql\Statement>
      *
      * @throws \Amp\Mysql\FailureException If the operation fails due to unexpected condition.
      * @throws \Amp\Mysql\ConnectionException If the connection to the database is lost.
      * @throws \Amp\Mysql\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 ...$data Query parameters.
+     *
+     * @return \Amp\Promise<\Amp\Mysql\CommandResult|\Amp\Mysql\ResultSet>
+     *
+     * @throws \Amp\Mysql\FailureException If the operation fails due to unexpected condition.
+     * @throws \Amp\Mysql\ConnectionException If the connection to the database is lost.
+     * @throws \Amp\Mysql\QueryError If the operation fails due to an error in the query (such as a syntax error).
+     */
+    public function execute(string $sql, ...$data): Promise;
+
     /**
      * Closes the executor. No further queries may be performed.
      */

lib/Transaction.php

@@ -33,6 +33,11 @@ public function __destruct() {
         }
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Closes and commits all changes in the transaction.
+     */
     public function close() {
         if ($this->connection) {
             $this->commit(); // Invokes $this->queue->complete().
@@ -86,6 +91,19 @@ public function prepare(string $sql): Promise {
         return $this->connection->prepare($sql);
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @throws \Amp\Mysql\TransactionError If the transaction has been committed or rolled back.
+     */
+    public function execute(string $sql, ...$data): Promise {
+        if ($this->connection === null) {
+            throw new TransactionError("The transaction has been committed or rolled back");
+        }
+
+        return $this->connection->execute($sql, ...$data);
+    }
+
     /**
      * Commits the transaction and makes it inactive.
      *

test/Mysql/ConnectionTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Amp\Mysql\CommandResult;
 use Amp\Mysql\DataTypes;
 use Amp\Mysql\ResultSet;
 use PHPUnit\Framework\TestCase;
@@ -28,6 +29,7 @@ function testQuery() {
 
             /** @var \Amp\Mysql\ResultSet $resultset */
             $resultset = yield $db->query("SELECT 1 AS a");
+            $this->assertInstanceOf(ResultSet::class, $resultset);
 
             for ($i = 0; yield $resultset->advance(); ++$i) {
                 $this->assertEquals(["a" => 1], $resultset->getCurrent());
@@ -48,6 +50,7 @@ function testQueryFetchRow() {
 
             /** @var \Amp\Mysql\ResultSet $resultset */
             $resultset = yield $db->query('SELECT a FROM tmp');
+            $this->assertInstanceOf(ResultSet::class, $resultset);
 
             $got = [];
             while (yield $resultset->advance(ResultSet::FETCH_ARRAY)) {
@@ -71,7 +74,7 @@ function testMultiStmt() {
 
             /** @var \Amp\Mysql\ResultSet $resultset */
             $resultset = yield $db->query("INSERT INTO tmp VALUES (5, 6), (8, 9); SELECT a FROM tmp; SELECT b FROM tmp WHERE a = 5; SELECT b AS d, a + 1 AS c FROM tmp WHERE b < 7");
-
+            $this->assertInstanceOf(ResultSet::class, $resultset);
 
             $got = [];
             while (yield $resultset->advance(ResultSet::FETCH_ARRAY)) {
@@ -119,6 +122,7 @@ function testPrepared() {
             $this->assertEquals(yield $stmt->getFields(), [$base + ["name" => "a", "original_name" => "a"], $base + ["name" => "b", "original_name" => "b"]]);
             $stmt->bind("num", 9);
             $result = yield $stmt->execute(5);
+            $this->assertInstanceOf(ResultSet::class, $result);
             $got = [];
             while (yield $result->advance(ResultSet::FETCH_ARRAY)) {
                 $got[] = $result->getCurrent();
@@ -128,6 +132,7 @@ function testPrepared() {
             /** @var \Amp\Mysql\Statement $stmt */
             $stmt = yield $db->prepare("SELECT * FROM tmp WHERE a = ? OR b = ?");
             $result = yield $stmt->execute(5, 8);
+            $this->assertInstanceOf(ResultSet::class, $result);
             $got = [];
             while (yield $result->advance(ResultSet::FETCH_ARRAY)) {
                 $got[] = $result->getCurrent();
@@ -138,6 +143,7 @@ function testPrepared() {
             $stmt = yield $db->prepare("SELECT * FROM tmp WHERE a = :a OR b = ?");
             $stmt->bind("a", 5);
             $result = yield $stmt->execute(9);
+            $this->assertInstanceOf(ResultSet::class, $result);
             $got = [];
             while (yield $result->advance(ResultSet::FETCH_ARRAY)) {
                 $got[] = $result->getCurrent();
@@ -149,6 +155,32 @@ function testPrepared() {
             $stmt->bind("bar", 9);
             /** @var \Amp\Mysql\CommandResult $result */
             $result = yield $stmt->execute();
+            $this->assertInstanceOf(CommandResult::class, $result);
+            $this->assertSame(1, $result->affectedRows());
+        });
+    }
+
+    function testExecute() {
+        \Amp\Loop::run(function () {
+            /** @var \Amp\Mysql\Connection $db */
+            $db = yield connect("host=".DB_HOST.";user=".DB_USER.";pass=".DB_PASS.";db=connectiontest");
+
+            $db->query("CREATE TEMPORARY TABLE tmp SELECT 1 AS a, 2 AS b");
+            $db->query("INSERT INTO tmp VALUES (5, 6), (8, 9), (10, 11), (12, 13)");
+
+            /** @var \Amp\Mysql\ResultSet $result */
+            $result = yield $db->execute("SELECT * FROM tmp WHERE a = ? OR b = ?", 5, 9);
+            $this->assertInstanceOf(ResultSet::class, $result);
+            $got = [];
+            while (yield $result->advance(ResultSet::FETCH_ARRAY)) {
+                $got[] = $result->getCurrent();
+            }
+            $this->assertCount(2, $got);
+            $this->assertSame([[5, 6], [8, 9]], $got);
+
+            /** @var \Amp\Mysql\CommandResult $result */
+            $result = yield $db->execute("INSERT INTO tmp VALUES (?, ?)", 14, 15);
+            $this->assertInstanceOf(CommandResult::class, $result);
             $this->assertSame(1, $result->affectedRows());
         });
     }