Tenex

View Source

Version Downloads Coverage Status

A simple and effective way to build multitenant applications on top of Ecto.

Documentation

Tenex leverages database data segregation techniques (such as Postgres schemas) to keep tenant-specific data separated, while allowing you to continue using the Ecto functions you are familiar with.

Quick Start

  1. Add tenex to your list of dependencies in mix.exs:
def deps do
  [
    {:tenex, "~> 1.0.0"},
  ]
end
  1. Run in your shell:
mix deps.get

Configuration

Configure the Repo you will use to execute the database commands within your config/config.exs file:

config :tenex, repo: ExampleApp.Repo

Usage

Here is a quick overview of what you can do with tenex!

Creating, renaming and dropping tenants

To create a new tenant:

Tenex.create("your_tenant")

This will create a new database schema and run your migrations — which may take a while depending on your application.

Rename a tenant:

Tenex.rename("your_tenant", "my_tenant")

This is not something you should need to do often. :-)

Delete a tenant:

Tenex.drop("my_tenant")

More information on the API can be found in documentation.

Creating tenant migrations

To create a migration to run across tenant schemas:

mix tenex.gen.migration your_migration_name

If migrating an existing project to use Tenex, you can move some or all of your existing migrations from priv/YOUR_REPO/migrations to priv/YOUR_REPO/tenant_migrations.

Tenex and Ecto will automatically add prefixes to standard migration functions. If you have custom SQL in your migrations, you will need to use the prefix function provided by Ecto. e.g.

def up do
  execute "CREATE INDEX name_trgm_index ON #{prefix()}.users USING gin (nam gin_trgm_ops);"
end

Running tenant migrations: 

mix tenex.migrate

This will migrate all of your existing tenants, one by one. In the case of failure, the next run will continue from where it stopped.

Using Ecto

Your Ecto usage only needs the prefix option. Tenex provides a helper to coerce the tenant value into the proper format, e.g.:

Repo.all(User, prefix: Tenex.to_prefix("my_tenant"))
Repo.get!(User, 123, prefix: Tenex.to_prefix("my_tenant"))

Fetching the tenant with Plug

Tenex includes configurable plugs that you can use to load the current tenant in your application.

Here is an example loading the tenant from the current subdomain:

plug Tenex.SubdomainPlug, endpoint: MyApp.Endpoint

For more information, check the Tenex.Plug documentation for an overview of our plugs.

Thanks

This library was originally inspired by the Triplex hex package, which provided multi-tenancy support for Elixir applications. However, Triplex is no longer being actively maintained, with no updates since 2019. To address this, we have taken the original Triplex package, applied the outstanding pull requests, and introduced a new version under the name Tenex. This ensures continued improvements and support for those relying on a robust multi-tenancy solution in Elixir. Additionally, we have removed support for MySQL, focusing solely on databases that better align with our vision for Tenex and ensuring a more maintainable and optimized experience.