Get started on PhinxAdapter

composer.json

@@ -24,7 +24,7 @@
         "php": ">=8.1",
         "cakephp/cache": "^5.0",
         "cakephp/orm": "^5.0",
-        "robmorgan/phinx": "^0.15.3"
+        "robmorgan/phinx": "0.x-dev#c35379620f23319329bb9ed17b82f4bdcce2a91e"
     },
     "require-dev": {
         "cakephp/bake": "^3.0",

phpstan-baseline.neon

@@ -25,26 +25,6 @@ parameters:
 			count: 1
 			path: src/Db/Adapter/AdapterFactory.php
 
-		-
-			message: "#^Call to an undefined method Migrations\\\\Db\\\\Adapter\\\\AdapterInterface\\:\\:getDeleteBuilder\\(\\)\\.$#"
-			count: 1
-			path: src/Db/Adapter/AdapterWrapper.php
-
-		-
-			message: "#^Call to an undefined method Migrations\\\\Db\\\\Adapter\\\\AdapterInterface\\:\\:getInsertBuilder\\(\\)\\.$#"
-			count: 1
-			path: src/Db/Adapter/AdapterWrapper.php
-
-		-
-			message: "#^Call to an undefined method Migrations\\\\Db\\\\Adapter\\\\AdapterInterface\\:\\:getSelectBuilder\\(\\)\\.$#"
-			count: 1
-			path: src/Db/Adapter/AdapterWrapper.php
-
-		-
-			message: "#^Call to an undefined method Migrations\\\\Db\\\\Adapter\\\\AdapterInterface\\:\\:getUpdateBuilder\\(\\)\\.$#"
-			count: 1
-			path: src/Db/Adapter/AdapterWrapper.php
-
 		-
 			message: "#^Offset 'id' on non\\-empty\\-array\\<string, mixed\\> in isset\\(\\) always exists and is not nullable\\.$#"
 			count: 2

psalm-baseline.xml

@@ -16,25 +16,27 @@
     </RedundantPropertyInitializationCheck>
   </file>
   <file src="src/Db/Adapter/AdapterWrapper.php">
+    <DeprecatedMethod>
+      <code>getQueryBuilder</code>
+    </DeprecatedMethod>
     <InvalidNullableReturnType>
       <code>InputInterface</code>
     </InvalidNullableReturnType>
     <NullableReturnStatement>
       <code><![CDATA[$this->adapter->getInput()]]></code>
     </NullableReturnStatement>
-    <UndefinedInterfaceMethod>
-      <code>getDeleteBuilder</code>
-      <code>getInsertBuilder</code>
-      <code>getSelectBuilder</code>
-      <code>getUpdateBuilder</code>
-    </UndefinedInterfaceMethod>
   </file>
   <file src="src/Db/Adapter/MysqlAdapter.php">
     <RedundantCondition>
       <code>$opened</code>
       <code>is_array($newColumns)</code>
     </RedundantCondition>
   </file>
+  <file src="src/Db/Adapter/PhinxAdapter.php">
+    <DeprecatedMethod>
+      <code>getQueryBuilder</code>
+    </DeprecatedMethod>
+  </file>
   <file src="src/Db/Adapter/PostgresAdapter.php">
     <NoValue>
       <code><![CDATA[$options['primary_key']]]></code>

src/Db/Adapter/AdapterInterface.php

@@ -9,6 +9,10 @@
 namespace Migrations\Db\Adapter;
 
 use Cake\Database\Query;
+use Cake\Database\Query\DeleteQuery;
+use Cake\Database\Query\InsertQuery;
+use Cake\Database\Query\SelectQuery;
+use Cake\Database\Query\UpdateQuery;
 use Migrations\Db\Literal;
 use Migrations\Db\Table\Column;
 use Migrations\Db\Table\Table;
@@ -283,10 +287,39 @@ public function executeActions(Table $table, array $actions): void;
     /**
      * Returns a new Query object
      *
+     * @deprecated 4.x Use getSelectBuilder, getInsertBuilder, getUpdateBuilder, getDeleteBuilder instead.
      * @return \Cake\Database\Query
      */
     public function getQueryBuilder(string $type): Query;
 
+    /**
+     * Return a new SelectQuery object
+     *
+     * @return \Cake\Database\Query\SelectQuery
+     */
+    public function getSelectBuilder(): SelectQuery;
+
+    /**
+     * Return a new InsertQuery object
+     *
+     * @return \Cake\Database\Query\InsertQuery
+     */
+    public function getInsertBuilder(): InsertQuery;
+
+    /**
+     * Return a new UpdateQuery object
+     *
+     * @return \Cake\Database\Query\UpdateQuery
+     */
+    public function getUpdateBuilder(): UpdateQuery;
+
+    /**
+     * Return a new DeleteQuery object
+     *
+     * @return \Cake\Database\Query\DeleteQuery
+     */
+    public function getDeleteBuilder(): DeleteQuery;
+
     /**
      * Executes a SQL statement.
      *

src/Db/Adapter/PdoAdapter.php

@@ -11,6 +11,10 @@
 use BadMethodCallException;
 use Cake\Database\Connection;
 use Cake\Database\Query;
+use Cake\Database\Query\DeleteQuery;
+use Cake\Database\Query\InsertQuery;
+use Cake\Database\Query\SelectQuery;
+use Cake\Database\Query\UpdateQuery;
 use InvalidArgumentException;
 use Migrations\Db\Action\AddColumn;
 use Migrations\Db\Action\AddForeignKey;
@@ -140,18 +144,18 @@
         } else {
             $table = new DbTable($this->getSchemaTableName(), [], $this);
             if (!$table->hasColumn('migration_name')) {
                 $table
                     ->addColumn(
                         'migration_name',
                         'string',
                         ['limit' => 100, 'after' => 'version', 'default' => null, 'null' => true]
                     )
                     ->save();
             }
             if (!$table->hasColumn('breakpoint')) {
                 $table
                     ->addColumn('breakpoint', 'boolean', ['default' => false, 'null' => false])
                     ->save();
             }
         }
 
@@ -247,6 +251,38 @@
         };
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function getSelectBuilder(): SelectQuery
+    {
+        return $this->getDecoratedConnection()->selectQuery();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getInsertBuilder(): InsertQuery
+    {
+        return $this->getDecoratedConnection()->insertQuery();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getUpdateBuilder(): UpdateQuery
+    {
+        return $this->getDecoratedConnection()->updateQuery();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getDeleteBuilder(): DeleteQuery
+    {
+        return $this->getDecoratedConnection()->deleteQuery();
+    }
+
     /**
      * Executes a query and returns PDOStatement.
      *
@@ -294,7 +330,7 @@
 
         foreach ($row as $column => $value) {
             if (is_bool($value)) {
                 $row[$column] = $this->castToBool($value);
             }
         }
 
@@ -333,9 +369,9 @@
      * @param string $value The string to quote
      * @return string
      */
     protected function quoteString(string $value): string
     {
         return $this->getConnection()->quote($value);
     }
 
     /**
@@ -371,7 +407,7 @@
             foreach ($rows as $row) {
                 foreach ($row as $v) {
                     if (is_bool($v)) {
                         $vals[] = $this->castToBool($v);
                     } else {
                         $vals[] = $v;
                     }
@@ -385,11 +421,11 @@
     /**
      * @inheritDoc
      */
     public function getVersions(): array
     {
         $rows = $this->getVersionLog();
 
         return array_keys($rows);
     }
 
     /**
@@ -418,7 +454,7 @@
             $rows = $this->fetchAll(sprintf('SELECT * FROM %s ORDER BY %s', $this->quoteTableName($this->getSchemaTableName()), $orderBy));
         } catch (PDOException $e) {
             if (!$this->isDryRunEnabled()) {
                 throw $e;
             }
             $rows = [];
         }
@@ -433,96 +469,96 @@
     /**
      * @inheritDoc
      */
     public function migrated(MigrationInterface $migration, string $direction, string $startTime, string $endTime): AdapterInterface
     {
         if (strcasecmp($direction, MigrationInterface::UP) === 0) {
             // up
             $sql = sprintf(
                 "INSERT INTO %s (%s, %s, %s, %s, %s) VALUES ('%s', '%s', '%s', '%s', %s);",
                 $this->quoteTableName($this->getSchemaTableName()),
                 $this->quoteColumnName('version'),
                 $this->quoteColumnName('migration_name'),
                 $this->quoteColumnName('start_time'),
                 $this->quoteColumnName('end_time'),
                 $this->quoteColumnName('breakpoint'),
                 $migration->getVersion(),
                 substr($migration->getName(), 0, 100),
                 $startTime,
                 $endTime,
                 $this->castToBool(false)
             );
 
             $this->execute($sql);
         } else {
             // down
             $sql = sprintf(
                 "DELETE FROM %s WHERE %s = '%s'",
                 $this->quoteTableName($this->getSchemaTableName()),
                 $this->quoteColumnName('version'),
                 $migration->getVersion()
             );
 
             $this->execute($sql);
         }
 
         return $this;
     }
 
     /**
      * @inheritDoc
      */
     public function toggleBreakpoint(MigrationInterface $migration): AdapterInterface
     {
         $this->query(
             sprintf(
                 'UPDATE %1$s SET %2$s = CASE %2$s WHEN %3$s THEN %4$s ELSE %3$s END, %7$s = %7$s WHERE %5$s = \'%6$s\';',
                 $this->quoteTableName($this->getSchemaTableName()),
                 $this->quoteColumnName('breakpoint'),
                 $this->castToBool(true),
                 $this->castToBool(false),
                 $this->quoteColumnName('version'),
                 $migration->getVersion(),
                 $this->quoteColumnName('start_time')
             )
         );
 
         return $this;
     }
 
     /**
      * @inheritDoc
      */
     public function resetAllBreakpoints(): int
     {
         return $this->execute(
             sprintf(
                 'UPDATE %1$s SET %2$s = %3$s, %4$s = %4$s WHERE %2$s <> %3$s;',
                 $this->quoteTableName($this->getSchemaTableName()),
                 $this->quoteColumnName('breakpoint'),
                 $this->castToBool(false),
                 $this->quoteColumnName('start_time')
             )
         );
     }
 
     /**
      * @inheritDoc
      */
     public function setBreakpoint(MigrationInterface $migration): AdapterInterface
     {
         $this->markBreakpoint($migration, true);
 
         return $this;
     }
 
     /**
      * @inheritDoc
      */
     public function unsetBreakpoint(MigrationInterface $migration): AdapterInterface
     {
         $this->markBreakpoint($migration, false);
 
         return $this;
     }
 
     /**
@@ -532,21 +568,21 @@
      * @param bool $state The required state of the breakpoint
      * @return \Migrations\Db\Adapter\AdapterInterface
      */
     protected function markBreakpoint(MigrationInterface $migration, bool $state): AdapterInterface
     {
         $this->query(
             sprintf(
                 'UPDATE %1$s SET %2$s = %3$s, %4$s = %4$s WHERE %5$s = \'%6$s\';',
                 $this->quoteTableName($this->getSchemaTableName()),
                 $this->quoteColumnName('breakpoint'),
                 $this->castToBool($state),
                 $this->quoteColumnName('start_time'),
                 $this->quoteColumnName('version'),
                 $migration->getVersion()
             )
         );
 
         return $this;
     }
 
     /**
@@ -555,9 +591,9 @@
      * @throws \BadMethodCallException
      * @return void
      */
     public function createSchema(string $schemaName = 'public'): void
     {
         throw new BadMethodCallException('Creating a schema is not supported');
     }
 
     /**
@@ -566,9 +602,9 @@
      * @throws \BadMethodCallException
      * @return void
      */
     public function dropSchema(string $schemaName): void
     {
         throw new BadMethodCallException('Dropping a schema is not supported');
     }
 
     /**
@@ -642,7 +678,7 @@
         } elseif (is_bool($default)) {
             $default = $this->castToBool($default);
         } elseif ($default !== null && $columnType === static::PHINX_TYPE_BOOLEAN) {
             $default = $this->castToBool((bool)$default);
         }
 
         return isset($default) ? " DEFAULT $default" : '';
@@ -664,10 +700,10 @@
     /**
      * @inheritDoc
      */
     public function addColumn(Table $table, Column $column): void
     {
         $instructions = $this->getAddColumnInstructions($table, $column);
         $this->executeAlterSteps($table->getName(), $instructions);
     }
 
     /**
@@ -701,10 +737,10 @@
     /**
      * @inheritdoc
      */
     public function changeColumn(string $tableName, string $columnName, Column $newColumn): void
     {
         $instructions = $this->getChangeColumnInstructions($tableName, $columnName, $newColumn);
         $this->executeAlterSteps($tableName, $instructions);
     }
 
     /**
@@ -738,10 +774,10 @@
     /**
      * @inheritdoc
      */
     public function addIndex(Table $table, Index $index): void
     {
         $instructions = $this->getAddIndexInstructions($table, $index);
         $this->executeAlterSteps($table->getName(), $instructions);
     }
 
     /**
@@ -877,10 +913,10 @@
     /**
      * @inheritdoc
      */
     public function changePrimaryKey(Table $table, $newColumns): void
     {
         $instructions = $this->getChangePrimaryKeyInstructions($table, $newColumns);
         $this->executeAlterSteps($table->getName(), $instructions);
     }
 
     /**
@@ -895,10 +931,10 @@
     /**
      * @inheritdoc
      */
     public function changeComment(Table $table, $newComment): void
     {
         $instructions = $this->getChangeCommentInstructions($table, $newComment);
         $this->executeAlterSteps($table->getName(), $instructions);
     }
 
     /**
@@ -956,11 +992,11 @@
 
                 case $action instanceof DropForeignKey && $action->getForeignKey()->getConstraint():
                     /** @var \Migrations\Db\Action\DropForeignKey $action */
                     $instructions->merge($this->getDropForeignKeyInstructions(
                         $table->getName(),
                         (string)$action->getForeignKey()->getConstraint()
                     ));
                     break;
 
                 case $action instanceof DropIndex && $action->getIndex()->getName() !== null:
                     /** @var \Migrations\Db\Action\DropIndex $action */
@@ -980,10 +1016,10 @@
 
                 case $action instanceof DropTable:
                     /** @var \Migrations\Db\Action\DropTable $action */
                     $instructions->merge($this->getDropTableInstructions(
                         $table->getName()
                     ));
                     break;
 
                 case $action instanceof RemoveColumn:
                     /** @var \Migrations\Db\Action\RemoveColumn $action */
@@ -1027,9 +1063,9 @@
                     break;
 
                 default:
                     throw new InvalidArgumentException(
                         sprintf("Don't know how to execute action: '%s'", get_class($action))
                     );
             }
         }