[11.x] Remove Doctrine DBAL

[hafezdivandari]

Finally, this PR removes Doctrine DBAL from the framework. 🎉

New Features / Enhancements

• Removes every single usage of doctrine/dbal from the framework ⚡
• Adds native column modifying for SQLite 🚀
• Adds native column renaming for legacy MySQL (< 8.0.3) and MariaDB (<10.5.2) 👍
• Adds native index renaming on SQLite
• Adds collation column modifier on SQLite
• Adds collation to Schema::getColumns() on SQLite (was always null before)
• Includes generated and hidden columns when retrieving columns using Schema::getColumns() on SQLite
• Rewrites db:show, db:table, and model:show artisan commands to use native schema methods ✨
• Enhances number formatting on db:show and db:table commands using Number helper class
• Adds user-defined types to db:show artisan command (PostgreSQL only)
• Adds schema to db:show artisan command (PostgreSQL and SQL Server only)
• Adds DB::getServerVersion() to get database version

Notes

1. Legacy MySQL (< 8.0) and MariaDB (< 10.5.2) don't have alter table rename column command, so we're retrieving column's attributes and use alter table change column command instead, just like Doctrine DBAL, but also with support for all types including enum, geometry, etc. However, renaming generated columns (using storedAs($expression) and virtualAs($spression)) on these legacy DBs using $table->renameColumn() are not supported, but there is a workaround for this using ->renameTo()->change() Fixed on [11.x] Add support for modifying generated columns #50329.

2. Due to limitations of SQLite, modifying a column on a table that has a generated column (using storedAs($expression) and virtualAs($spression)) is partially supported, it's better than Doctrine DBAL that doesn't support these at all, but it's still not fully supported. A workaround is to also redeclare any existing generated column with change() at the end. Fixed on [11.x] Add support for modifying generated columns #50329

Check List

• Renaming columns
  • Prerequisite native support (added on Laravel 9.44 [9.x] Add support for native rename/drop column commands #45258)
  • Add support for native renaming on legacy MySQL versions (< 8.0) and MariaDB prior to 10.5.2
  • Remove dependency of doctrine/dbal package when renaming columns
• Dropping columns on SQLite
  • Prerequisite native support (added on Laravel 9.44 [9.x] Add support for native rename/drop column commands #45258)
  • Remove dependency of doctrine/dbal package when dropping columns on SQLite
• Modifying columns
  • Prerequisite native support (added on Laravel 10.0 (except SQLite) [10.x] Add support for native column modifying #45487)
  • Add support for native column modifying on SQLite
  • Remove dependency of doctrine/dbal package when modifying columns
• Get the data type of a column Schema::getColumnType()
  • Prerequisite native support (added on Laravel 10.30 [10.x] Get columns of a table #48357)
  • Remove dependency of doctrine/dbal package when retrieving column type
• Renaming Indexes on SQLite
  • Prerequisite Schema::getIndexes() (added on Laravel 10.37 [10.x] Get indexes of a table #49204)
  • Remove dependency of doctrine/dbal package when renaming and index on SQLite
• Database Truncation when testing using Dusk (Docs)
  • Prerequisite Schema::getTables() (added on Laravel 10.34 [10.x] Get tables and views info #49020)
  • Remove dependency of doctrine/dbal package when truncating database
• Database Inspection Artisan Commands
  • Prerequisite Schema::getTables() (added on Laravel 10.34 [10.x] Get tables and views info #49020)
  • Prerequisite Schema::getViews() (added on Laravel 10.34 [10.x] Get tables and views info #49020)
  • Prerequisite Schema::getTypes() (added on Laravel 10.37.1 [10.x] Get user-defined types on PostgreSQL #49303)
  • Prerequisite Schema::getColumns() (added on Laravel 10.30 [10.x] Get columns of a table #48357)
  • Prerequisite Schema::getIndexes() (added on Laravel 10.37 [10.x] Get indexes of a table #49204)
  • Prerequisite Schema::getForeignKeys() (added on Laravel 10.37 [10.x] Get foreign keys of a table #49264)
  • Refactor db:show artisan command and remove doctrine/dbal dependency
  • Refactor db:table artisan command and remove doctrine/dbal dependency
  • Refactor model:show artisan command and remove doctrine/dbal dependency

Changes

• Adds DB::getServerVersion() method
• Removes Schema::$alwaysUsesNativeSchemaOperationsIfPossible class property
• Removes Schema::useNativeSchemaOperationsIfPossible() method
• Removes DB::getDoctrineConnection() and the whole \Illuminate\Database\PDO directory
• Removes DB::usingNativeSchemaOperations() method
• Removes DB::isDoctrineAvailable() method
• Removes DB::getDoctrineColumn() method
• Removes DB::getDoctrineSchemaManager() method
• Removes DB::registerDoctrineType() method (both \Illuminate\Database\DatabaseManager::registerDoctrineType() and \Illuminate\Database\Connection::registerDoctrineType() methods)
• Removes database.dbal.types config property
• Removes \Illuminate\Database\DBAL\TimestampType class
• Removes \Illuminate\Database\Schema\Grammars\ChangeColumn class
• Removes \Illuminate\Database\Schema\Grammars\RenameColumn class
• Removes \Illuminate\Database\Schema\Grammars\Grammar::getDoctrineTableDiff() method

Upgrade Guide

SQLite 3.35.0+

If your application is utilizing an SQLite database, you should update SQLite to 3.35.0+ (laravel/docs#9017).

Removal of Doctrine DBAL

You may remove doctrine/dbal composer dependency.

composer remove doctrine/dbal

Modifying Columns

As already noted on Laravel 10.x docs, When modifying a column, you must explicitly include all of the modifiers you want to keep on the column definition - any missing attribute will be dropped. For example, to retain the unsigned, default, and comment attributes, you must call each modifier explicitly when changing the column:

Schema::table('users', function (Blueprint $table) {
    $table->integer('votes')->unsigned()->default(1)->comment('my comment')->change();
});

Schema builder getColumnType() method

The Schema::getColumnType() method now always returns actual database type of the given column, not the doctrine equivalent type, even if you have doctrine/dbal installed.

Registering Custom Doctrine Types

As we are not using Doctrine DBAL for modifying/renaming columns, registering custom doctrine types are not supported anymore. The database.dbal.types config key and DB::registerDoctrineType() method are removed.

[juanparati]

If you are replacing DBAL in 11.x, please consider to take a look in order to find possible improvement ideas:

• MariaDB field types
• Views instropection

[taylorotwell]

Thanks!

[driesvints]

Thanks @hafezdivandari!