DBAL 3.0: suggestions to improve the Driver\Connection interface

.scrutinizer.yml

@@ -3,7 +3,7 @@ build:
         analysis:
             environment:
                 php:
-                    version: 7.1
+                    version: 7.2
             cache:
                 disabled: false
                 directories:
@@ -21,7 +21,7 @@ before_commands:
 tools:
     external_code_coverage:
         timeout: 3600
-        runs: 27 # 23x Travis (jobs with COVERAGE=yes) + 3x AppVeyor (jobs with coverage=yes) + 1x ContinuousPHP
+        runs: 26 # 22x Travis (jobs with COVERAGE=yes) + 3x AppVeyor (jobs with coverage=yes) + 1x ContinuousPHP
 
 filter:
     excluded_paths:

.travis.yml

@@ -8,7 +8,6 @@ cache:
         - $HOME/.composer/cache
 
 php:
-  - 7.1
   - 7.2
   - 7.3
   - nightly
@@ -57,11 +56,11 @@ jobs:
     - env: DB=pgsql POSTGRESQL_VERSION=11.0
 
   exclude:
-    - php: 7.1
+    - php: 7.2
       env: DB=sqlite
-    - php: 7.1
+    - php: 7.2
       env: DB=mysql
-    - php: 7.1
+    - php: 7.2
       env: DB=mysqli
     - php: 7.2
       env: DB=sqlite
@@ -79,10 +78,6 @@ jobs:
       env: DB=mysqli
 
   include:
-    - stage: Test
-      php: 7.1
-      env: DB=sqlite
-
     - stage: Test
       php: 7.2
       env: DB=sqlite COVERAGE=yes
@@ -95,12 +90,6 @@ jobs:
       php: 7.2
       env: DB=mysqli COVERAGE=yes
 
-    - stage: Test
-      php: 7.1
-      env: DB=mysql MYSQL_VERSION=5.7
-      sudo: required
-      before_script:
-        - bash ./tests/travis/install-mysql-5.7.sh
     - stage: Test
       php: 7.2
       env: DB=mysql MYSQL_VERSION=5.7 COVERAGE=yes
@@ -120,12 +109,6 @@ jobs:
       before_script:
         - bash ./tests/travis/install-mysql-5.7.sh
 
-    - stage: Test
-      php: 7.1
-      env: DB=mysqli MYSQL_VERSION=5.7
-      sudo: required
-      before_script:
-        - bash ./tests/travis/install-mysql-5.7.sh
     - stage: Test
       php: 7.2
       env: DB=mysqli MYSQL_VERSION=5.7 COVERAGE=yes
@@ -181,12 +164,6 @@ jobs:
       addons:
         mariadb: 10.2
 
-    - stage: Test
-      php: 7.1
-      env: DB=mariadb MARIADB_VERSION=10.3
-      addons:
-          mariadb: 10.3
-
     - stage: Test
       php: 7.2
       env: DB=mariadb MARIADB_VERSION=10.3 COVERAGE=yes
@@ -205,12 +182,6 @@ jobs:
       addons:
           mariadb: 10.3
 
-    - stage: Test
-      php: 7.1
-      env: DB=mariadb.mysqli MARIADB_VERSION=10.3
-      addons:
-          mariadb: 10.3
-
     - stage: Test
       php: 7.2
       env: DB=mariadb.mysqli MARIADB_VERSION=10.3 COVERAGE=yes
@@ -229,14 +200,6 @@ jobs:
       addons:
           mariadb: 10.3
 
-    - stage: Test
-      php: 7.2
-      env: DB=pgsql POSTGRESQL_VERSION=9.2 COVERAGE=yes
-      services:
-        - postgresql
-      addons:
-        postgresql: "9.2"
-
     - stage: Test
       php: 7.2
       env: DB=pgsql POSTGRESQL_VERSION=9.3 COVERAGE=yes
@@ -280,14 +243,6 @@ jobs:
       before_script:
         - bash ./tests/travis/install-postgres-10.sh
 
-    - stage: Test
-      php: 7.1
-      env: DB=pgsql POSTGRESQL_VERSION=11.0
-      sudo: required
-      services:
-        - docker
-      before_script:
-        - bash ./tests/travis/install-postgres-11.sh
     - stage: Test
       php: 7.2
       env: DB=pgsql POSTGRESQL_VERSION=11.0 COVERAGE=yes
@@ -313,15 +268,6 @@ jobs:
       before_script:
         - bash ./tests/travis/install-postgres-11.sh
 
-    - stage: Test
-      php: 7.1
-      env: DB=sqlsrv
-      sudo: required
-      services:
-        - docker
-      before_script:
-        - bash ./tests/travis/install-mssql-$DB.sh
-        - bash ./tests/travis/install-mssql.sh
     - stage: Test
       php: 7.2
       env: DB=sqlsrv COVERAGE=yes
@@ -350,15 +296,6 @@ jobs:
         - bash ./tests/travis/install-mssql-$DB.sh
         - bash ./tests/travis/install-mssql.sh
 
-    - stage: Test
-      php: 7.1
-      env: DB=pdo_sqlsrv
-      sudo: required
-      services:
-        - docker
-      before_script:
-        - bash ./tests/travis/install-mssql-$DB.sh
-        - bash ./tests/travis/install-mssql.sh
     - stage: Test
       php: 7.2
       env: DB=pdo_sqlsrv COVERAGE=yes
@@ -387,15 +324,6 @@ jobs:
       - bash ./tests/travis/install-mssql-$DB.sh
       - bash ./tests/travis/install-mssql.sh
 
-    - stage: Test
-      php: 7.1
-      env: DB=ibm_db2
-      sudo: required
-      services:
-        - docker
-      before_script:
-        - bash ./tests/travis/install-db2.sh
-        - bash ./tests/travis/install-db2-$DB.sh
     - stage: Test
       php: 7.2
       env: DB=ibm_db2 COVERAGE=yes
@@ -406,12 +334,6 @@ jobs:
         - bash ./tests/travis/install-db2.sh
         - bash ./tests/travis/install-db2-$DB.sh
 
-    - stage: Test
-      php: 7.1
-      env: DB=sqlite DEPENDENCIES=low
-      install:
-        - travis_retry composer update --prefer-dist --prefer-lowest
-
     - stage: Test
       if: type = cron
       php: 7.2

UPGRADE.md

@@ -1,3 +1,139 @@
+# Upgrade to 3.0
+
+## BC BREAK: `Doctrine\DBAL\Types\Type::getDefaultLength()` removed
+
+The `Doctrine\DBAL\Types\Type::getDefaultLength()` method has been removed as it served no purpose.
+
+## BC BREAK: `Doctrine\DBAL\Types\Type::__toString()` removed
+
+Relying on string representation was discouraged and has been removed.
+
+## BC BREAK: The `NULL` value of `$offset` in LIMIT queries is not allowed
+
+The `NULL` value of the `$offset` argument in `AbstractPlatform::(do)?ModifyLimitQuery()` methods is no longer allowed. The absence of the offset should be indicated with a `0` which is now the default value.
+
+## BC BREAK: Removed dbal:import CLI command
+
+The `dbal:import` CLI command has been removed since it only worked with PDO-based drivers by relying on a non-documented behavior of the extension, and it was impossible to make it work with other drivers.
+Please use other database client applications for import, e.g.:
+
+ * For MySQL and MariaDB: `mysql [dbname] < data.sql`.
+ * For PostgreSQL: `psql [dbname] < data.sql`.
+ * For SQLite: `sqlite3 /path/to/file.db < data.sql`.
+
+## BC BREAK: Removed support for DB-generated UUIDs
+
+The support for DB-generated UUIDs was removed as non-portable.
+Please generate UUIDs on the application side (e.g. using [ramsey/uuid](https://packagist.org/packages/ramsey/uuid)).
+
+## BC BREAK: Removed MsSQLKeywords class
+
+The `Doctrine\DBAL\Platforms\MsSQLKeywords` has been removed.
+Please use `Doctrine\DBAL\Platforms\SQLServerPlatform `instead.
+
+## BC BREAK: Removed PDO DB2 driver
+
+This PDO-based IBM DB2 driver (built on top of pdo_ibm extension) has already been unsupported as of 2.5, it has now been now removed.
+
+The following class has been removed:
+
+ * `Doctrine\DBAL\Driver\PDOIbm\Driver`
+
+## BC BREAK: Removed support for SQL Anywhere 12 and older
+
+DBAL now requires SQL Anywhere 16 or newer, support for unmaintained versions has been dropped.
+If you are using any of the legacy versions, you have to upgrade to newer SQL Anywhere version (16+).
+`Doctrine\DBAL\Platforms\SQLAnywherePlatform` and `Doctrine\DBAL\Platforms\Keywords\SQLAnywhereKeywords` now represent the SQL Anywhere 16.
+
+The following classes have been removed:
+
+ * `Doctrine\DBAL\Platforms\SQLAnywhere11Platform`
+ * `Doctrine\DBAL\Platforms\SQLAnywhere12Platform`
+ * `Doctrine\DBAL\Platforms\SQLAnywhere16Platform`  
+ * `Doctrine\DBAL\Platforms\Keywords\SQLAnywhere11Keywords`
+ * `Doctrine\DBAL\Platforms\Keywords\SQLAnywhere12Keywords`
+ * `Doctrine\DBAL\Platforms\Keywords\SQLAnywhere16Keywords`
+
+## BC BREAK: Removed support for SQL Server 2005 and older
+
+DBAL now requires SQL Server 2008 or newer, support for unmaintained versions has been dropped.
+If you are using any of the legacy versions, you have to upgrade to newer SQL Server version (2012+ is recommended).
+`Doctrine\DBAL\Platforms\SQLServerPlatform` and `Doctrine\DBAL\Platforms\Keywords\SQLServerKeywords` now represent the SQL Server 2008.
+
+The following classes have been removed:
+
+ * `Doctrine\DBAL\Platforms\SQLServer2005Platform`
+ * `Doctrine\DBAL\Platforms\SQLServer2008Platform`
+ * `Doctrine\DBAL\Platforms\Keywords\SQLServer2005Keywords`
+ * `Doctrine\DBAL\Platforms\Keywords\SQLServer2008Keywords`
+
+## BC BREAK: Removed support for PostgreSQL 9.2 and older
+
+DBAL now requires PostgeSQL 9.3 or newer, support for unmaintained versions has been dropped.
+If you are using any of the legacy versions, you have to upgrade to newer PostgreSQL version (9.6+ is recommended).
+`Doctrine\DBAL\Platforms\PostgreSqlPlatform` and `Doctrine\DBAL\Platforms\Keywords\PostgreSQLKeywords` now represent the PostgreSQL 9.3.
+
+The following classes have been removed:
+
+ * `Doctrine\DBAL\Platforms\PostgreSQL91Platform`
+ * `Doctrine\DBAL\Platforms\PostgreSQL92Platform`
+ * `Doctrine\DBAL\Platforms\Keywords\PostgreSQL91Keywords`
+ * `Doctrine\DBAL\Platforms\Keywords\PostgreSQL92Keywords`
+
+## BC BREAK: Removed Doctrine\DBAL\Version
+
+The Doctrine\DBAL\Version class is no longer available: please refrain from checking the DBAL version at runtime.
+
+## BC BREAK: the PDO symbols are no longer part of the DBAL API
+
+1. The support of `PDO::PARAM_*`, `PDO::FETCH_*`, `PDO::CASE_*` and `PDO::PARAM_INPUT_OUTPUT` constants in the DBAL API is removed.
+2. `\Doctrine\DBAL\Driver\PDOConnection` does not extend `\PDO` anymore. Please use `\Doctrine\DBAL\Driver\PDOConnection::getWrappedConnection()` to access the underlying `PDO` object.
+3. `\Doctrine\DBAL\Driver\PDOStatement` does not extend `\PDOStatement` anymore.
+
+Before:
+
+    use Doctrine\DBAL\Portability\Connection;
+
+    $params = array(
+        'wrapperClass' => Connection::class,
+        'fetch_case' => PDO::CASE_LOWER,
+    );
+
+    $stmt->bindValue(1, 1, PDO::PARAM_INT);
+    $stmt->fetchAll(PDO::FETCH_COLUMN);
+
+After:
+
+    use Doctrine\DBAL\ColumnCase;
+    use Doctrine\DBAL\FetchMode;
+    use Doctrine\DBAL\ParameterType;
+    use Doctrine\DBAL\Portability\Connection;
+
+    $params = array(
+        'wrapperClass' => Connection::class,
+        'fetch_case' => ColumnCase::LOWER,
+    );
+
+    $stmt->bindValue(1, 1, ParameterType::INTEGER);
+    $stmt->fetchAll(FetchMode::COLUMN);
+
+## BC BREAK: Removed Drizzle support
+
+The Drizzle project is abandoned and is therefore not supported by Doctrine DBAL anymore.
+
+## BC BREAK: SQLLogger changes
+
+- The `SQLLogger` interface has changed; the methods are the same but use scalar type hints, return types, and non-nullable arrays.
+- `SQLLogger` implementations: `DebugStack`, `EchoSQLLogger`, `LoggerChain` are now final.
+- `Configuration::getSQLLogger()` does not return `null` anymore, but a `NullLogger` implementation.
+- `Configuration::setSQLLogger()` does not allow `null` anymore.
+
+## BC BREAK: Changes to handling binary fields
+
+- Binary fields whose length exceeds the maximum field size on a given platform are no longer represented as `BLOB`s.
+  Use binary fields of a size which fits all target platforms, or use blob explicitly instead.
+- Binary fields are no longer represented as streams in PHP. They are represented as strings.
+
 # Upgrade to 2.9
 
 ## Deprecated `Configuration::getFilterSchemaAssetsExpression()`, `::setFilterSchemaAssetsExpression()` and `AbstractSchemaManager::getFilterSchemaAssetsExpression()`.

build.properties

@@ -1,3 +0,0 @@
-# Version class and file
-project.version_class = Doctrine\\DBAL\\Version
-project.version_file = lib/Doctrine/DBAL/Version.php

build.xml

@@ -38,29 +38,6 @@
         </exec>
     </target>
 
-    <target name="make-release" depends="check-git-checkout-clean,prepare,php">
-        <replace file="${project.version_file}" token="-DEV" value="" failOnNoReplacements="true" />
-        <exec executable="${php_executable}" outputproperty="doctrine.current_version" failonerror="true">
-            <arg value="-r" />
-            <arg value="require_once '${project.version_file}';echo ${project.version_class}::VERSION;" />
-        </exec>
-        <exec executable="${php_executable}" outputproperty="doctrine.next_version" failonerror="true">
-            <arg value="-r" />
-            <arg value="$parts = explode('.', str_ireplace(array('-DEV', '-ALPHA', '-BETA'), '', '${doctrine.current_version}'));
-                if (count($parts) != 3) {
-                    throw new \InvalidArgumentException('Version is assumed in format x.y.z, ${doctrine.current_version} given');
-                }
-                $parts[2]++;
-                echo implode('.', $parts);
-            " />
-        </exec>
-
-        <git-commit file="${project.version_file}" message="Release ${doctrine.current_version}" />
-        <git-tag version="${doctrine.current_version}" />
-        <replace file="${project.version_file}" token="${doctrine.current_version}" value="${doctrine.next_version}-DEV" />
-        <git-commit file="${project.version_file}" message="Bump version to ${doctrine.next_version}" />
-    </target>
-
     <target name="check-git-checkout-clean">
         <exec executable="git" failonerror="true">
             <arg value="diff-index" />

composer.json

@@ -21,10 +21,10 @@
         {"name": "Jonathan Wage", "email": "jonwage@gmail.com"}
     ],
     "require": {
-        "php": "^7.1",
-        "ext-pdo": "*",
+        "php": "^7.2",
         "doctrine/cache": "^1.0",
-        "doctrine/event-manager": "^1.0"
+        "doctrine/event-manager": "^1.0",
+        "ocramius/package-versions": "^1.2"
     },
     "require-dev": {
         "doctrine/coding-standard": "^5.0",