Support per-operation database selection using `IsDatabaseModel`

[laylatichy]

Description

When using multiple databases it's not possible to specifically set which database queries built by IsDatabaseModel should target

On My test project I forked that trait and added $database param to methods but maybe you will think of something better
Or maybe add handling OnDatabase trait

Benefits

allow for multi database setup when using IsDatabaseModel

[innocenzi]

@brendt maybe we should add support for an attribute on the model class?

#[OnDatabase('sqlite')]
final class User
{
    use IsDatabaseModel;
}

Can't find a name that wouldn't conflict with an existing interface or trait though

[laylatichy]

@brendt maybe we should add support for an attribute on the model class?

#[OnDatabase('sqlite')]
final class User
{
use IsDatabaseModel;
}

Can't find a name that wouldn't conflict with an existing interface or trait though

@innocenzi

Just to chip in that approach wiil not work in a lot of scenarios, where you do inserts/updates on primary and selects on replica etc, unless you plan to add some options to pass like read/write to attribute

[innocenzi]

I might have not understood your need then, can you show some code so I can understand what you meant?

[laylatichy]

@innocenzi no, you understood, just that without using IsDatabaseModel trait you can specify database on a per operation basis, with your approach there to add attribute like this without option to specify multiple databases all will target single one unless you plan to do something like

#[OnDatabase(write: 'mysql', read: 'mysql-replica')]
final class User

what I mean in a lot of setups you will have primary dbs and read only replicas so it would be nice to have option to specify database for write operations, and separate one if needed for read only operations

[brendt]

Could you share a code sample of what the ideal situation would look like for you? I'm happy to make improvements here but it's easier to read some actual code to understand it :)

[laylatichy]

@brendt I mean proposed solution from @innocenzi was good enough just that if the attribute could have read/write

#[OnDatabase(write: 'mysql', read: 'mysql-replica')]

with specifying both being optional, will have some time over the weekend so will try to prepare some pr

[brendt]

Right. I personally dislike that you'd configure this on the model itself. The goal of our ORM is for models to be decoupled from the database (as much as possible).

But from your feature request, I think that's exactly what you want to do, right? Because something like this isn't what you're looking for (because of the duplication)? Just trying to make sure I understand the use case

        $books = query(Book::class)
            ->select()
            ->where('published_at < ?', '2025-01-01')
            ->onDatabase('mysql-replica')
            ->all();

        query(Book::class)
            ->insert(...$books)
            ->onDatabase('mysql')
            ->execute();

[laylatichy]

@brendt yes, if I didnt use isDatabaseModel trait I would do as the above, I personally forked that trait and just added these onDatabase inside it because I couldn't be bothered more,

coming from laravel the trait is handy aside from being able to specify the database operation should be executed on. Was thinking also about just adding property onDatabase on the model but then we kinda go into laravel mess with too much magic

the use case is in a lot of production systems you will run a few databases, being it backup/replica in different region for faster access for select operations and it would be nice to still be able to use that trait and have the option

[innocenzi]

Honestly in your case it seems like you'd benefit from using repositories or CQRS instead of qerying through the model directly