[12.x] Support for Attaching Databases as Schemas in SQLite

[hafezdivandari]

• Related to [12.x] Enhance multi-database support #54274

Continuing the work on #54274 to enhance multi-schema support, this PR introduces a new schemas config property that adds support for attaching databases as schemas to SQLite connections. The ATTACH DATABASE query is not persistent between SQLite connections, which is why we need to attach schemas every time the connection is established.

'connections' => [

    'sqlite' => [
        'driver' => 'sqlite',
        'database' => env('DB_DATABASE', database_path('database.sqlite')),
+       'schemas' => [
+           'secondary' => env('DB_SECONDARY_DATABASE', database_path('secondary.sqlite')),
+           'tertiary' => env('DB_TERTIARY_DATABASE', ':memory:'),
+       ],
        // ...
    ],

],

Note: When attaching databases to a SQLite connection using this new schemas config property, the following commands, testing traits and methods will drop tables/views in the attached databases (schemas) as well (This behavior is the same for PostgreSQL and SQL Server schemas):

• db:wipe and migrate:fresh commands.
• \Illuminate\Foundation\Testing\RefreshDatabase and \Illuminate\Foundation\Testing\DatabaseTruncation traits.
• Schema::dropAllTables() and Schema::dropAllViews() methods.

This PR also moves the connection configurations logic from the SQLiteConnection class to the SQLiteConnector class, following the pattern of other database drivers. SQLite was the only DB driver that configured its connection in the Connection class instead of the Connector class. As part of this change, redundant Builder and Grammar methods have been removed. There are many pragma key/value pairs, so it doesn't make sense to have a method in both classes for each pragma key/value (added recently on #52052).

Summary

• New schemas config property for the sqlite connection.
• New Schema::connection('sqlite')->pragma($key, $value = null) method to get/set a pragma value.
  • This method also accepts schema-qualified keys, for example: Schema::pragma('schema_name.journal_mode', 'wal')
• Moved SQLite connection configuration logic from the SQLiteConnection class to the SQLiteConnector class to be consistent with other DB drivers.
• Removed redundant SQLiteGrammar::compileSetBusyTimeout(), compileSetJournalMode(), compileSetSynchronous(), compileEnableWriteableSchema(), and compileDisableWriteableSchema() methods.
• Removed redundant SQLiteBuilder::setBusyTimeout(), setJournalMode(), and setSynchronous() methods:
  • Schema::setBusyTimeout(12345) -> Schema::pragma('busy_timeout', 12345)
  • Schema::setJournalMode('wal') -> Schema::pragma('journal_mode', 'wal')
  • Schema::setSynchronous('normal') -> Schema::pragma('synchronous', 'normal')

[github-actions]

Thanks for submitting a PR!

Note that draft PR's are not reviewed. If you would like a review, please mark your pull request as ready for review in the GitHub user interface.

Pull requests that are abandoned in draft may be closed due to inactivity.

[Sophist-UK]

Given how much SQLite is starting to be used for scalable web services, this PR seems to me to be an excellent direction.

[taylorotwell]

Given how much SQLite is starting to be used for scalable web services, this PR seems to me to be an excellent direction.

Do we have any real data on this? This feels incredibly edge case in Laravel at least 😅

[taylorotwell]

I want to hold off on this until there is more demand for this kind of thing.