def list_users_raw do prefix = UniEcto.Plugin.get_tenant_prefix() Repo.query("SELECT * FROM #prefix.users") end What if your Settings table is global and Orders is per-tenant?
defmodule MyApp.Repo.Migrations.AddNotesToOrders do use Ecto.Migration import UniEcto.MigrationHelpers def up do # Runs on all existing tenants + public for tenant <- UniEcto.Plugin.all_tenants() do execute("SET search_path TO #tenant") alter table(:orders) do add :notes, :text end end end end
def create_new_tenant(subdomain, company_name) do # 1. Create schema in DB prefix = "tenant_#subdomain" Ecto.Adapters.SQL.query!(MyApp.Repo, "CREATE SCHEMA IF NOT EXISTS #prefix") UniEcto.Plugin.run_migrations_for(prefix) 3. Insert tenant record into public tenants table %Tenantprefix: prefix, name: company_name |> Repo.insert!() # Runs in 'public' schema
Unlike basic foreign key scoping ( WHERE tenant_id = ? ), the uni_ecto_plugin often supports (separate schemas or separate databases). It seamlessly switches between tenants at the connection level.
# Bad user = Repo.get(User, 1) |> Repo.preload(:orders) user = Repo.get(User, 1) orders = Repo.preload(user, :orders, prefix: UniEcto.Plugin.get_tenant_prefix()) 3. Mix Tasks Crashing Error: Running mix phx.server fails because no tenant is set during compilation. Fix: Guard your plugin calls:
pipeline :api do plug :accepts, ["json"] plug MyApp.Plugs.TenantResolver end Create the resolver:
# config/config.exs config :uni_ecto_plugin, :cache, enabled: true, ttl: :timer.hours(1) The plugin will cache the list of valid tenants in an ETS table. Validating a prefix becomes an O(1) memory read instead of a SQL query. 1. The "Prefix Not Set" Error Error: (Ecto.NoResultsError) expected query to return a prefix, but none was set Fix: Ensure your TenantResolver plug runs before any database calls in your controller pipeline. 2. Association Loading Fails If you have a belongs_to across schemas, Ecto may struggle with prefixes. Fix: Define associations with explicit prefixes or use Repo.assoc with the tenant prefix manually.
Uni Ecto Plugin <Firefox>
def list_users_raw do prefix = UniEcto.Plugin.get_tenant_prefix() Repo.query("SELECT * FROM #prefix.users") end What if your Settings table is global and Orders is per-tenant?
defmodule MyApp.Repo.Migrations.AddNotesToOrders do use Ecto.Migration import UniEcto.MigrationHelpers def up do # Runs on all existing tenants + public for tenant <- UniEcto.Plugin.all_tenants() do execute("SET search_path TO #tenant") alter table(:orders) do add :notes, :text end end end end uni ecto plugin
def create_new_tenant(subdomain, company_name) do # 1. Create schema in DB prefix = "tenant_#subdomain" Ecto.Adapters.SQL.query!(MyApp.Repo, "CREATE SCHEMA IF NOT EXISTS #prefix") UniEcto.Plugin.run_migrations_for(prefix) 3. Insert tenant record into public tenants table %Tenantprefix: prefix, name: company_name |> Repo.insert!() # Runs in 'public' schema def list_users_raw do prefix = UniEcto
Unlike basic foreign key scoping ( WHERE tenant_id = ? ), the uni_ecto_plugin often supports (separate schemas or separate databases). It seamlessly switches between tenants at the connection level. # Bad user = Repo
# Bad user = Repo.get(User, 1) |> Repo.preload(:orders) user = Repo.get(User, 1) orders = Repo.preload(user, :orders, prefix: UniEcto.Plugin.get_tenant_prefix()) 3. Mix Tasks Crashing Error: Running mix phx.server fails because no tenant is set during compilation. Fix: Guard your plugin calls:
pipeline :api do plug :accepts, ["json"] plug MyApp.Plugs.TenantResolver end Create the resolver:
# config/config.exs config :uni_ecto_plugin, :cache, enabled: true, ttl: :timer.hours(1) The plugin will cache the list of valid tenants in an ETS table. Validating a prefix becomes an O(1) memory read instead of a SQL query. 1. The "Prefix Not Set" Error Error: (Ecto.NoResultsError) expected query to return a prefix, but none was set Fix: Ensure your TenantResolver plug runs before any database calls in your controller pipeline. 2. Association Loading Fails If you have a belongs_to across schemas, Ecto may struggle with prefixes. Fix: Define associations with explicit prefixes or use Repo.assoc with the tenant prefix manually.
Scroll to top