API Reference Tenant v#2.0.0

View Source

Modules

Useful functions for any tenant mix task.

This is the main module of Tenant.

All the configuration for Tenant basic functionality is here

This is a basic plug that ensure the tenant is loaded.

This is a struct that holds the configuration for Tenant.EnsurePlug.

This is a basic plug that loads the current tenant assign from a given param.

This is a struct that holds all configuration for Tenant.ParamPlug.

This module have some basic functions for our tenant plugs.

This is a basic plug that loads the current tenant assign from a given value set on session.

This is a struct that holds the configuration for Tenant.SessionPlug.

This is a basic plug that loads the current tenant assign from a given value set on subdomain.

This is a struct that holds the configuration for Tenant.SubdomainPlug.

Mix Tasks

Generates a migration.

Runs the pending tenant migrations for the given repository.

Displays the up / down migration status for the given repository.

Generates a migration to create the tenant table in the default database (MySQL only).

Reverts applied migrations in the given repository.