README.md in apartment-1.0.1 vs README.md in apartment-1.0.2
- old
+ new
@@ -6,11 +6,24 @@
Apartment provides tools to help you deal with multiple tenants 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 tenant, Apartment can help.
+## Excessive Memory Issues on ActiveRecord 4.x
+> If you're noticing ever growing memory issues (ie growing with each tenant you add)
+> when using Apartment, that's because there's [an issue](https://github.com/rails/rails/issues/19578)
+> with how ActiveRecord maps Postgresql data types into AR data types.
+> This has been patched and will be release for AR 4.2.2. It's apparently hard
+> to backport to 4.1 unfortunately.
+> If you want to use this today, you can use our [4.2.1 patched version](https://github.com/influitive/rails/tree/v4.2.1.memfix) on our github account using the code sample below.
+
+```ruby
+gem 'rails', '4.2.1', github: 'influitive/rails', tag: 'v4.2.1.memfix'
+```
+
+
## Installation
### Rails
Add the following to your Gemfile:
@@ -34,10 +47,13 @@
> NOTE: If using [postgresql schemas](http://www.postgresql.org/docs/9.0/static/ddl-schemas.html) you must use:
>
> * for Rails 3.1.x: _Rails ~> 3.1.2_, it contains a [patch](https://github.com/rails/rails/pull/3232) that makes prepared statements work with multiple schemas
## Usage
+### Video Tutorial
+How to separate your application data into different accounts or companies.
+[GoRails #47](https://gorails.com/episodes/multitenancy-with-apartment)
### Creating new Tenants
Before you can switch to a new apartment tenant, you will need to create it. Whenever
you need to create a new tenant, you can run the following command:
@@ -282,11 +298,11 @@
2. Run `heroku pg:psql` from your command line
3. And then `DROP EXTENSION hstore;` (**Note:** This will drop all columns that use `hstore` type, so proceed with caution; only do this with a fresh PostgreSQL instance)
4. Next: `CREATE SCHEMA IF NOT EXISTS hstore;`
5. Finally: `CREATE EXTENSION IF NOT EXISTS hstore SCHEMA hstore;` and hit enter (`\q` to exit)
-To double check, login to the console of your Heroku app and see if `Apartment.connection.default_search_path` is `public,hstore`
+To double check, login to the console of your Heroku app and see if `Apartment.connection.schema_search_path` is `public,hstore`
#### 3. Ensure the schema is in the apartment config
```ruby
# config/initializers/apartment.rb
...
@@ -324,11 +340,11 @@
```
### Managing Migrations
-In order to migrate all of your tenants (or posgresql schemas) you need to provide a list
+In order to migrate all of your tenants (or postgresql 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 tenant name. Example:
```ruby
# Dynamically get tenant names to migrate
@@ -376,5 +392,7 @@
* If you're looking to help, check out the TODO file for some upcoming changes I'd like to implement in Apartment.
## License
Apartment is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+[](https://bitdeli.com/free "Bitdeli Badge")