DBAL4: Making a start

Author: JulianMar

.github/workflows/tests.yml

@@ -22,7 +22,6 @@ jobs:
       matrix:
         os: [ 'ubuntu-latest' ] #, macos-latest, windows-latest ]
         php-version: [
-          '8.0',
           '8.1',
           '8.2',
           '8.3',

README.rst

@@ -22,7 +22,7 @@ CrateDB DBAL Driver
     :target: https://packagist.org/packages/crate/crate-dbal
     :alt: Latest stable version
 
-.. image:: https://img.shields.io/badge/PHP-8.0%2C%208.1%2C%208.2%2C%208.3%2C%208.4%2C%208.5-green.svg
+.. image:: https://img.shields.io/badge/PHP-8.1%2C%208.2%2C%208.3%2C%208.4%2C%208.5-green.svg
     :target: https://packagist.org/packages/crate/crate-dbal
     :alt: Supported PHP versions
 

composer.json

@@ -15,8 +15,8 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
-        "php": "^8.0|^8.1|^8.2|^8.3|^8.4|^8.5",
-        "doctrine/dbal": "^3",
+        "php": "^8.1|^8.2|^8.3|^8.4|^8.5",
+        "doctrine/dbal": "^4",
         "crate/crate-pdo": "^2.2.4",
         "ext-pdo": "*"
     },
@@ -27,7 +27,9 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.0",
-        "friendsofphp/php-cs-fixer": "^3.89"
+        "friendsofphp/php-cs-fixer": "^3.89",
+        "slam/dbal-debugstack-middleware": "*",
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "autoload-dev": {
         "psr-0": {
@@ -44,7 +46,7 @@
     },
     "scripts": {
         "test": "XDEBUG_MODE=coverage phpunit --coverage-clover build/logs/clover.xml",
-        "check-style": "php-cs-fixer check",
-        "fix-style": "php-cs-fixer fix"
+        "check-style": "phpcs && php-cs-fixer check --verbose --diff",
+        "fix-style": "phpcbf && php-cs-fixer fix"
     }
 }

src/Crate/DBAL/Driver/PDOCrate/CrateStatement.php

@@ -92,9 +92,9 @@ public function rowCount(): int
     /**
      * {@inheritDoc}
      */
-    public function bindValue($param, $value, $type = ParameterType::STRING): bool
+    public function bindValue($param, $value, $type = ParameterType::STRING): void
     {
-        return $this->stmt->bindValue($param, $value, $type);
+        $this->stmt->bindValue($param, $value, $type);
     }
 
     /**

src/Crate/DBAL/Driver/PDOCrate/Driver.php

@@ -28,12 +28,13 @@
 use Crate\DBAL\Platforms\CratePlatform4;
 use Crate\DBAL\Schema\CrateSchemaManager;
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Driver as DoctrineDriver;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
-use Doctrine\DBAL\VersionAwarePlatformDriver;
+use Doctrine\DBAL\ServerVersionProvider;
 use SensitiveParameter;
 
-class Driver implements VersionAwarePlatformDriver
+class Driver implements DoctrineDriver
 {
     public const VERSION = '4.0.3';
     public const NAME = 'crate';
@@ -75,8 +76,9 @@ private function constructPdoDsn(array $params): string
 
     /**
      * {@inheritDoc}
+     * @param ServerVersionProvider $versionProvider
      */
-    public function getDatabasePlatform(): AbstractPlatform
+    public function getDatabasePlatform(ServerVersionProvider $versionProvider): AbstractPlatform
     {
         return new CratePlatform4();
     }
@@ -103,7 +105,7 @@ public function getName(): string
      */
     public function getDatabase(Connection $conn): string|null
     {
-        return null;
+        return 'doc';
     }
 
     /**

src/Crate/DBAL/Driver/PDOCrate/PDOConnection.php

@@ -116,28 +116,28 @@ public function lastInsertId($name = null): string
         }
     }
 
-    public function beginTransaction()
+    public function beginTransaction(): void
     {
         try {
-            return $this->connection->beginTransaction();
+            $this->connection->beginTransaction();
         } catch (PDOException $exception) {
             throw Exception::new($exception);
         }
     }
 
-    public function commit()
+    public function commit(): void
     {
         try {
-            return $this->connection->commit();
+            $this->connection->commit();
         } catch (PDOException $exception) {
             throw Exception::new($exception);
         }
     }
 
-    public function rollBack()
+    public function rollBack(): void
     {
         try {
-            return $this->connection->rollBack();
+            $this->connection->rollBack();
         } catch (PDOException $exception) {
             throw Exception::new($exception);
         }

src/Crate/DBAL/Platforms/CratePlatform.php

@@ -23,13 +23,17 @@
 
 namespace Crate\DBAL\Platforms;
 
+use Crate\DBAL\Platforms\Keywords\CrateKeywords;
+use Crate\DBAL\Schema\CrateSchemaManager;
+use Crate\DBAL\Types\ArrayType;
 use Crate\DBAL\Types\MapType;
 use Crate\DBAL\Types\TimestampType;
-use Doctrine\DBAL\Event\SchemaCreateTableColumnEventArgs;
-use Doctrine\DBAL\Event\SchemaCreateTableEventArgs;
-use Doctrine\DBAL\Events;
-use Doctrine\DBAL\Exception as DBALException;
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Platforms\DateIntervalUnit;
+use Doctrine\DBAL\Platforms\Exception\NoColumnsSpecifiedForTable;
+use Doctrine\DBAL\Platforms\Keywords\KeywordList;
+use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Identifier;
 use Doctrine\DBAL\Schema\Index;
@@ -52,18 +56,22 @@ public function __construct()
     {
         $this->initializeDoctrineTypeMappings();
         if (!Type::hasType(MapType::NAME)) {
-            Type::addType(MapType::NAME, 'Crate\DBAL\Types\MapType');
+            Type::addType(MapType::NAME, MapType::class);
+            $this->registerDoctrineTypeMapping(10, MapType::NAME);
         }
         if (!Type::hasType(TimestampType::NAME)) {
-            Type::addType(TimestampType::NAME, 'Crate\DBAL\Types\TimestampType');
+            Type::addType(TimestampType::NAME, TimestampType::class);
+        }
+        if (!Type::hasType(ArrayType::NAME)) {
+            Type::addType(ArrayType::NAME, ArrayType::class);
+            $this->registerDoctrineTypeMapping(9, ArrayType::NAME);
         }
-        Type::overrideType('array', 'Crate\DBAL\Types\ArrayType');
     }
 
     /**
      * {@inheritDoc}
      */
-    public function getDefaultTransactionIsolationLevel()
+    public function getDefaultTransactionIsolationLevel(): TransactionIsolationLevel
     {
         // CrateDB provides `READ_UNCOMMITTED` isolation levels.
         // https://github.com/crate/crate/blob/master/server/src/main/java/io/crate/analyze/ShowStatementAnalyzer.java#L69-L85
@@ -268,26 +276,26 @@ public function getAlterTableSQL(TableDiff $diff): array
         $commentsSQL = array();
         $columnSql = array();
 
-        foreach ($diff->addedColumns as $column) {
+        foreach ($diff->getAddedColumns() as $column) {
             if ($this->onSchemaAlterTableAddColumn($column, $diff, $columnSql)) {
                 continue;
             }
 
             $query = 'ADD ' . $this->getColumnDeclarationSQL($column->getQuotedName($this), $column->toArray());
             $sql[] = 'ALTER TABLE ' . $diff->name . ' ' . $query;
-            if ($comment = $this->getColumnComment($column)) {
+            if ($comment = $column->getComment()) {
                 $commentsSQL[] = $this->getCommentOnColumnSQL($diff->name, $column->getName(), $comment);
             }
         }
 
-        if (count($diff->removedColumns) > 0) {
-            throw DBALException::notSupported("Alter Table: drop columns");
+        if (count($diff->getDroppedColumns()) > 0) {
+            throw Exception::notSupported("Alter Table: drop columns");
         }
-        if (count($diff->changedColumns) > 0) {
-            throw DBALException::notSupported("Alter Table: change column options");
+        if (count($diff->getChangedColumns()) > 0) {
+            throw Exception::notSupported("Alter Table: change column options");
         }
-        if (count($diff->renamedColumns) > 0) {
-            throw DBALException::notSupported("Alter Table: rename columns");
+        if (count($diff->getRenamedColumns()) > 0) {
+            throw Exception::notSupported("Alter Table: rename columns");
         }
 
         $tableSql = array();
@@ -309,7 +317,7 @@ public function getAlterTableSQL(TableDiff $diff): array
     public function getColumnDeclarationSQL($name, array $column): string
     {
         if (isset($column['columnDefinition'])) {
-            $columnDef = $this->getCustomTypeDeclarationSQL($column);
+            $columnDef = $column['columnDefinition'];
         } else {
             $typeDecl = $column['type']->getSqlDeclaration($column, $this);
             $columnDef = $typeDecl;
@@ -324,10 +332,10 @@ public function getColumnDeclarationSQL($name, array $column): string
      * @param Index $index
      * @codeCoverageIgnore
      */
-    public function getIndexDeclarationSQL($name, Index $index): string
+    public function getIndexDeclarationSQL(Index $index): string
     {
         $columns = $index->getQuotedColumns($this);
-        $name = new Identifier($name);
+        $name = new Identifier($index->getName());
 
         if (count($columns) == 0) {
             throw new \InvalidArgumentException("Incomplete definition. 'columns' required.");
@@ -457,7 +465,7 @@ protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef): string
      * @param false|int $length
      * @param $fixed
      */
-    protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed): string
+    protected function getVarcharTypeDeclarationSQLSnippet($length): string
     {
         return 'STRING';
     }
@@ -612,7 +620,7 @@ public function getCreateTableSQL(Table $table, $createFlags = self::CREATE_INDE
         }
 
         if (count($table->getColumns()) === 0) {
-            throw DBALException::noColumnsSpecifiedForTable($table->getName());
+            throw NoColumnsSpecifiedForTable::new($table->getName());
         }
 
         $tableName = $table->getQuotedName($this);
@@ -644,30 +652,9 @@ public function getCreateTableSQL(Table $table, $createFlags = self::CREATE_INDE
         $columns = array();
 
         foreach ($table->getColumns() as $column) {
-            if (null !== $this->_eventManager &&
-                $this->_eventManager->hasListeners(Events::onSchemaCreateTableColumn)
-            ) {
-                $eventArgs = new SchemaCreateTableColumnEventArgs($column, $table, $this);
-                $this->_eventManager->dispatchEvent(Events::onSchemaCreateTableColumn, $eventArgs);
-
-                $columnSql = array_merge($columnSql, $eventArgs->getSql());
-
-                if ($eventArgs->isDefaultPrevented()) {
-                    continue;
-                }
-            }
             $columns[$column->getQuotedName($this)] = self::prepareColumnData($this, $column, $options['primary']);
         }
 
-        if (null !== $this->_eventManager && $this->_eventManager->hasListeners(Events::onSchemaCreateTable)) {
-            $eventArgs = new SchemaCreateTableEventArgs($table, $columns, $options, $this);
-            $this->_eventManager->dispatchEvent(Events::onSchemaCreateTable, $eventArgs);
-
-            if ($eventArgs->isDefaultPrevented()) {
-                return array_merge($eventArgs->getSql(), $columnSql);
-            }
-        }
-
         $sql = $this->_getCreateTableSQL($tableName, $columns, $options);
         if ($this->supportsCommentOnStatement()) {
             foreach ($table->getColumns() as $column) {
@@ -699,7 +686,7 @@ protected function _getCreateTableSQL($name, array $columns, array $options = ar
 
         if (isset($options['indexes']) && ! empty($options['indexes'])) {
             foreach ($options['indexes'] as $index => $definition) {
-                $columnListSql .= ', ' . $this->getIndexDeclarationSQL($index, $definition);
+                $columnListSql .= ', ' . $this->getIndexDeclarationSQL($definition);
             }
         }
 
@@ -798,8 +785,8 @@ private function buildPartitionOptions(array $options)
      */
     public static function prepareColumnData(AbstractPlatform $platform, $column, $primaries = array())
     {
-        if ($column->hasCustomSchemaOption("unique") ? $column->getCustomSchemaOption("unique") : false) {
-            throw DBALException::notSupported("Unique constraints are not supported. Use `primary key` instead");
+        if ($column->hasPlatformOption("unique") ? $column->hasPlatformOption("unique") : false) {
+            throw Exception::notSupported("Unique constraints are not supported. Use `primary key` instead");
         }
 
         $columnData = array();
@@ -811,8 +798,7 @@ public static function prepareColumnData(AbstractPlatform $platform, $column, $p
         $columnData['unique'] = false;
         $columnData['version'] = $column->hasPlatformOption("version") ? $column->getPlatformOption("version") : false;
 
-        if (strtolower($columnData['type']->getName()) ==
-            strtolower($platform->getVarcharTypeDeclarationSQLSnippet(0, false))
+        if ($columnData['type'] == $platform->getVarcharTypeDeclarationSQLSnippet(0, false)
                 && $columnData['length'] === null) {
             $columnData['length'] = 255;
         }
@@ -823,7 +809,7 @@ public static function prepareColumnData(AbstractPlatform $platform, $column, $p
         $columnData['default'] = $column->getDefault();
         $columnData['columnDefinition'] = $column->getColumnDefinition();
         $columnData['autoincrement'] = $column->getAutoincrement();
-        $columnData['comment'] = $platform->getColumnComment($column);
+        $columnData['comment'] = $column->getComment();
         $columnData['platformOptions'] = $column->getPlatformOptions();
 
         if (in_array($column->getName(), $primaries)) {
@@ -885,4 +871,49 @@ public function getCurrentDatabaseExpression(): string
         // Added by Doctrine 3.
         return 'CURRENT_DATABASE()';
     }
+
+    /**
+     * Obtains DBMS specific SQL code portion needed to set an index
+     * declaration to be used in statements like CREATE TABLE.
+     *
+     * @deprecated
+     */
+    public function getIndexFieldDeclarationListSQL(Index $index): string
+    {
+        return implode(', ', $index->getQuotedColumns($this));
+    }
+
+    public function createSchemaManager(Connection $connection): AbstractSchemaManager
+    {
+        return new CrateSchemaManager($connection, $this);
+    }
+
+    public function getLocateExpression(string $string, string $substring, ?string $start = null): string
+    {
+        throw Exception::notSupported(__METHOD__);
+    }
+
+    protected function getDateArithmeticIntervalExpression(
+        string $date,
+        string $operator,
+        string $interval,
+        DateIntervalUnit $unit,
+    ): string {
+        throw Exception::notSupported(__METHOD__);
+    }
+
+    public function getListViewsSQL(string $database): string
+    {
+        throw Exception::notSupported(__METHOD__);
+    }
+
+    public function getSetTransactionIsolationSQL(TransactionIsolationLevel $level): string
+    {
+        throw Exception::notSupported(__METHOD__);
+    }
+
+    protected function createReservedKeywordsList(): KeywordList
+    {
+        return new CrateKeywords();
+    }
 }

src/Crate/DBAL/Platforms/CratePlatform4.php

@@ -79,7 +79,7 @@ public function getFloatDeclarationSQL(array $field): string
     /**
      * {@inheritDoc}
      */
-    protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed): string
+    protected function getVarcharTypeDeclarationSQLSnippet($length): string
     {
         return 'TEXT';
     }