Ruby Gem for managing multi-tenant applications
Pull request Compare This branch is 2 commits ahead, 39 commits behind bradrobertson:development.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Multitenancy for Rails 3 and ActiveRecord

Apartment provides tools to help you deal with multiple databases in your Rails application. If you need to have certain data sequestered based on account or company, but still allow some data to exist in a common database, Apartment can help.


Rails 3

Add the following to your Gemfile:

gem 'apartment'

That's all you need to set up the Apartment libraries. If you want to switch databases on a per-user basis, look under "Usage - Switching databases per request", below.

NOTE: If using postgresl schemas you must use:

  • for Rails 3.1.x: Rails ~> 3.1.2, it contains a patch that makes prepared statements work with multiple schemas


Creating new Databases

Before you can switch to a new apartment database, you will need to create it. Whenever you need to create a new database, you can run the following command:


Apartment will create a new database in the following format: "environment_database_name". In the case of a sqlite database, this will be created in your 'db/migrate' folder. With other databases, the database will be created as a new DB within the system.

When you create a new database, all migrations will be run against that database, so it will be up to date when create returns.

Notes on PostgreSQL

PostgreSQL works slightly differently than other databases when creating a new DB. If you are using PostgreSQL, Apartment by default will set up a new schema and migrate into there. This provides better performance, and allows Apartment to work on systems like Heroku, which would not allow a full new database to be created.

One can optionally use the full database creation instead if they want, though this is not recommended

Switching Databases

To switch databases using Apartment, use the following command:


When switch is called, all requests coming to ActiveRecord will be routed to the database you specify (with the exception of excluded models, see below). To return to the 'root' database, call switch with no arguments.

Switching Databases per request

You can have Apartment route to the appropriate database by adding some Rack middleware. Apartment can support many different "Elevators" that can take care of this routing to your data. In house, we use the subdomain elevator, which analyzes the subdomain of the request and switches to a database schema of the same name. It can be used like so:

# application.rb
module My Application
  class Application < Rails::Application

    config.middleware.use 'Apartment::Elevators::Subdomain'


The following config options should be set up in a Rails initializer such as:


To set config options, add this to your initializer:

Apartment.configure do |config|
  # set your options (described below) here

Excluding models

If you have some models that should always access the 'root' database, you can specify this by configuring Apartment using Apartment.configure. This will yield a config object for you. You can set excluded models like so:

config.excluded_models = ["User", "Company"]        # these models will not be multi-tenanted, but remain in the global (public) namespace

Note that a string representation of the model name is now the standard so that models are properly constantized when reloaded in development

Handling Environments

By default, when not using postgresql schemas, Apartment will prepend the environment to the database name to ensure there is no conflict between your environments. This is mainly for the benefit of your development and test environments. If you wish to turn this option off in production, you could do something like:

config.prepend_environment = !Rails.env.production?

Managing Migrations

In order to migrate all of your databases (or posgresql schemas) you need to provide a list of dbs to Apartment. You can make this dynamic by providing a Proc object to be called on migrations. This object should yield an array of string representing each database name. Example:

# Dynamically get database names to migrate
config.database_names = lambda{ }

# Use a static list of database names for migrate
config.database_names = ['db1', 'db2']

You can then migration your databases using the rake task:

rake apartment:migrate

This basically invokes Apartment::Database.migrate(#{db_name}) for each database name supplied from Apartment.database_names


If using Rails ~> 3.2, you must use delayed_job ~> 3.0. It has better Rails 3 support plus has some major changes that affect the serialization of models. I haven't been able to get psych working whatsoever as the YAML parser, so to get things to work properly, you must explicitly set the parser to syck before requiring delayed_job This can be done in the boot.rb of your rails config just above where Bundler requires the gems from the Gemfile. It will look something like:

require 'rubygems'
require 'yaml'
YAML::ENGINE.yamler = 'syck'

# Set up gems listed in the Gemfile.
gemfile = File.expand_path('../../Gemfile', __FILE__)

In order to make ActiveRecord models play nice with DJ and Apartment, include Apartment::Delayed::Requirements in any model that is being serialized by DJ. Also ensure that the database attribute (provided by Apartment::Delayed::Requirements) is set on this model before it is serialized, to ensure that when it is fetched again, it is done so in the proper Apartment db context. For example:

class SomeModel < ActiveRecord::Base
  include Apartment::Delayed::Requirements

Any classes that are being used as a Delayed::Job Job need to include the Apartment::Delayed::Job::Hooks module into the class. This ensures that when a job runs, it switches to the appropriate tenant before performing its task. It is also required (manually at the moment) that you set a @database attribute on your job so the hooks know what tennant to switch to

class SomeDJ

  include Apartment::Delayed::Job::Hooks

  def initialize
    @database = Apartment::Database.current_database

  def perform
    # do some stuff (will automatically switch to @database before performing and switch back after)

All jobs must stored in the global (public) namespace, so add it to the list of excluded models:

config.excluded_models = ["Delayed::Job"]


  • The Local setup for development assumes that a root user with no password exists for both mysql and postgresl
  • Rake tasks (see the Rakefile) will help you setup your dbs necessary to run tests
  • Please issue pull requests to the development branch. All development happens here, master is used for releases
  • Ensure that your code is accompanied with tests. No code will be merged without tests