README.rdoc

WARNING: The Project Has Been Suspended

Please note, that this project has been suspended. No updates will be
provided and no Rails versions beyond 3.2.x will be supported. For more
information please check out this blog post: kovyrin.net/2014/11/14/dbcharmer-suspended/

DB Charmer - ActiveRecord Connection Magic Plugin

DbCharmer is a simple yet powerful plugin for ActiveRecord that
significantly extends its ability to work with multiple databases and/or
database servers. The major features we add to ActiveRecord are:

Installation

using the gem (recommended and the only way of using it with Rails 3.2+)

install as a Rails plugin (works in Rails 2.x only)

To install as a gem, add this to your Gemfile:

gem 'db-charmer', :require => 'db_charmer'

To install DbCharmer as a Rails plugin use the following command:

./script/plugin install git://github.com/kovyrin/db-charmer.git

Notice: If you use DbCharmer in a non-rails project, you
may need to set DbCharmer.env to a correct value before using any
of its connection management methods. Correct value here is a valid
database.yml first-level section name.

Documentation/Questions

For more information about the library, please visit our site at dbcharmer.net. If you need more defails on
DbCharmer internals, please check out the source code. All the plugin's
code is ~100% covered with tests. The project located in
test-project directory has unit tests for all or, at least, the
most actively used code paths.

If you have any questions regarding this project, you could contact the
author using the DbCharmer Users Group mailing list:

In addition to CI testing, this gem is used in production on Scribd.com
(one of the largest RoR sites in the world) with Ruby Enterprise Edition
and Rails 2.2, Rails 2.3, Sinatra and plain Rack applications.

Starting with version 1.8.0 we support Rails versions 3.2.8 and higher.
Please note, that Rails 3.2.4 is not officially supported. Your code may
work on that version, but no bug reports will be accepted about this
version.

Is it Thread-Safe?

Starting with version 1.9.0 we have started working on making the code
thread-safe and making sure DbCharmer works correctly in multi-threaded
environments. At this moment we consider multi-threaded mode experimental.
If you use it and it works for you - please let us know, if it does not -
please make sure to file a ticket so that we could improve the code and
make it work in your situation.

Who are the authors?

This plugin has been created in Scribd.com for our internal use and then
the sources were opened for other people to use. Most of the code in this
package has been developed by Oleksiy Kovyrin for Scribd.com and is
released under the MIT license. For more details, see the LICENSE file.

Other contributors who have helped with the development of this library are
(alphabetically ordered):