Storage Drivers

Storage drivers are used to store a list of all tenants, their domains and any extra information you store about your tenants (their plan, API keys, etc).

Currently, database and Redis storage drivers are available as part of the package. However, you can write your own (and contribute ❤️) storage drivers.

Database

The database storage driver lets you store tenant information in a relational database like MySQL, PostgreSQL and SQLite.

The benefit of this storage driver is that you don't have to use both Redis and a database for your data. Also you don't have to do as much configuration.

To use this driver, you need to have a tenants table and a domains table. You may also use a custom database connection. By default, tenancy.storage_drivers.db.connection is set to null, which means that your app's default database connection will be used to store tenants.

If you wish to use a different connection, e.g. central, you may create it in the config/database.php file and set tenancy.storage_drivers.db.connection to the name of that connection. It's recommended to do this for easier changes in the future.

To create the tenants and domains tables, you can use the migrations that come with this package. If you haven't published them during installation, publish them now:

php artisan vendor:publish --provider='Stancl\Tenancy\TenancyServiceProvider' --tag=migrations

By default, all of your data will be stored in the JSON column data. If you want to store some data in a dedicated column (to leverage indexing, for example), add the column to the migration and to the tenancy.custom_columns config.

If you have existing migrations related to your app in database/migrations, move them to database/migrations/tenant. You can read more about tenant migrations here.

Finally, run the migrations:

php artisan migrate

If you use a non-default connection, such as central, you have to specify which DB to migrate using the --database option.

Redis

The Redis storage driver lets you store tenant information in Redis, a high-performance key-value store.

The benefit of this storage driver is its performance.

Note that you need to configure persistence on your Redis instance if you don't want to lose all information about tenants.

Read the Redis documentation page on persistence. You should definitely use AOF and if you want to be even more protected from data loss, you can use RDB in conjunction with AOF.

If your cache driver is Redis and you don't want to use AOF with it, run two Redis instances. Otherwise, just make sure you use a different database (number) for tenancy and another for anything else.

To use this driver, create a new Redis connection in the database.redis configuration (config/database.php) called tenancy (or if you use another name, be sure to update it in the tenancy.storage_drivers.redis.connection configuration (config/tenancy.php)).

'tenancy' => [
    'host' => env('TENANCY_REDIS_HOST', '127.0.0.1'),
    'password' => env('TENANCY_REDIS_PASSWORD', null),
    'port' => env('TENANCY_REDIS_PORT', 6380), // different port = separate Redis instance
    'database' => env('TENANCY_REDIS_DB', 3), // alternatively, different database number
],

Note: You need phpredis. Predis support will dropped by Laravel in version 7.