Download the PHP package enriquejlicona/tenanti without Composer
On this page you can find all versions of the php package enriquejlicona/tenanti. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download enriquejlicona/tenanti
More information about enriquejlicona/tenanti
Files in enriquejlicona/tenanti
Package tenanti
Short Description Tenant based Database Schema Manager for Laravel
License MIT
Informations about the package tenanti
Multi-tenant Database Schema Manager for Laravel
Tenanti allow you to manage multi-tenant data schema and migration manager for your Laravel application.
Version Compatibility
Laravel | Tenanti |
---|---|
5.5.x | 3.5.x |
5.6.x | 3.6.x |
5.7.x | 3.7.x |
5.8.x | 3.8.x |
6.x | 4.x |
7.x | 5.x |
8.x | 6.x |
Installation
To install through composer, run the following command from terminal:
Configuration
Next add the following service provider in config/app.php
.
The command utility is enabled via
Orchestra\Tenanti\CommandServiceProvider
.
Aliases
To make development easier, you could add Orchestra\Support\Facades\Tenanti
alias for easier reference:
Publish Configuration
To make it easier to configuration your tenant setup, publish the configuration:
Usage
Configuration Tenant Driver for Single Database
Open config/orchestra/tenanti.php
and customize the drivers.
You can customize, or add new driver in the configuration. It is important to note that model
configuration only work with Eloquent
instance.
Setup migration autoload
For each driver, you should also consider adding the migration path into autoload (if it not already defined). To do this you can edit your composer.json
.
composer.json
Setup Tenantor Model
Now that we have setup the configuration, let add an observer to our User
class:
and your App\Observers\UserObserver
class should consist of the following:
Console Support
Tenanti include additional command to help you run bulk migration when a new schema is created, the available command resemble the usage available from php artisan migrate
namespace.
Command | Description |
---|---|
php artisan tenanti:install {driver} | Setup migration table on each entry for a given driver. |
php artisan tenanti:make {driver} {name} | Make a new Schema generator for a given driver. |
php artisan tenanti:migrate {driver} | Run migration on each entry for a given driver. |
php artisan tenanti:rollback {driver} | Rollback migration on each entry for a given driver. |
php artisan tenanti:reset {driver} | Reset migration on each entry for a given driver. |
php artisan tenanti:refresh {driver} | Refresh migration (reset and migrate) on each entry for a given driver. |
php artisan tenanti:queue {driver} {action} | Execute any of above action using separate queue to minimize impact on current process. |
php artisan tenanti:tinker {driver} {id} | Run tinker using a given driver and ID. |
Multi Database Connection Setup
Instead of using Tenanti with a single database connection, you could also setup a database connection for each tenant.
Configuration Tenant Driver for Multiple Database
Open config/orchestra/tenanti.php
and customize the drivers.
By introducing a migration
config, you can now setup the migration table name to be tenant_migrations
instead of user_{id}_migrations
.
Database Connection Resolver
For tenanti to automatically resolve your multiple database connection, we need to setup the resolver. You can do this via:
Behind the scene, $config
will contain the template database configuration fetch from "database.connections.tenants"
(based on the first parameter tenants
). We can dynamically modify the connection configuration and return the updated configuration for the tenant.
Setting Default Database Connection
Alternatively you can also use Tenanti to set the default database connection for your application:
Most of the time, this would be use in a Middleware Class when you resolve the tenant ID based on
Illuminate\Http\Request
object.
All versions of tenanti with dependencies
illuminate/console Version ^9.0
illuminate/filesystem Version ^9.0
illuminate/support Version ^9.0
enriquejlicona/model Version ^8.0
enriquejlicona/support Version ^8.0