Skip to content

Commit

Permalink
Fill in docs and details for the new generator and release
Browse files Browse the repository at this point in the history
  • Loading branch information
nicksieger committed Oct 1, 2009
1 parent 911ccee commit 7ea0326
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 13 deletions.
8 changes: 8 additions & 0 deletions History.txt
@@ -1,5 +1,10 @@
== 0.9.2

- The main, highly awaited fix for this release is a solution to the
rake db:create/db:drop issue. The main change is a new 'jdbc' rails
generator that should be run once to prepare a Rails application to
use JDBC. The upside of this generator is that you no longer will
need to alter database.yml for JDBC. See the README.txt for details.
- Cleanup and reconnect if errors occur during begin/rollback
(Jean-Dominique Morani, Christian Seiler)
- ACTIVERECORD_JDBC-1: Add #drop_database method for oracle (does the
Expand All @@ -22,6 +27,9 @@
- Improves the SQLite adapter by fixing rename_column, change_column,
change_column_default, changing remove_column, and adding
remove_columns (Ryan Baumann)
- More oracle love courtesy Ben Browning and Jens Himmelreich
- JRUBY-3608: Add missing change_column_null method for postgres
- JRUBY-3508: Fix quoting of integer and float columns

== 0.9.1

Expand Down
49 changes: 36 additions & 13 deletions README.txt
Expand Up @@ -2,6 +2,13 @@ activerecord-jdbc-adapter is a database adapter for Rails' ActiveRecord
component that can be used with JRuby[http://www.jruby.org/]. It allows use of
virtually any JDBC-compliant database with your JRuby on Rails application.

== Project Info

* Mailing Lists: http://kenai.com/projects/activerecord-jdbc/lists
* Issues: http://kenai.com/jira/browse/ACTIVERECORD_JDBC
* Source: git://kenai.com/activerecord-jdbc~main
git://github.com/nicksieger/activerecord-jdbc-adapter.git

== Databases

What's there, and what is not there:
Expand Down Expand Up @@ -49,25 +56,35 @@ To use activerecord-jdbc-adapter with JRuby on Rails:
* derby (<tt>activerecord-jdbcderby-adapter</tt>)
* hsqldb (<tt>activerecord-jdbchsqldb-adapter</tt>)
* h2 (<tt>activerecord-jdbch2-adapter</tt>)
* sqlite3 (<tt>activerecord-jdbcsqlite3-adapter</tt>)

2. Run the "jdbc" generator to prepare your Rails application for
JDBC.

jruby script/generate jdbc

The initializer and rake task files generated are guarded such that
they won't be loaded if you still run your application un C Ruby.

2. If you're using Rails 2.0, you may skip to the next step. For Rails prior to
version 2.0, you'll need to add one-time setup to your config/environment.rb
file in your Rails application. Add the following lines just before the
<code>Rails::Initializer</code>. (If you're using activerecord-jdbc-adapter
under the old gem name used in versions 0.5 and earlier (ActiveRecord-JDBC),
replace 'activerecord-jdbc-adapter' with 'ActiveRecord-JDBC' below.)
Legacy: If you're using Rails prior to version 2.0, you'll need to
add one-time setup to your config/environment.rb file in your Rails
application. Add the following lines just before the
<code>Rails::Initializer</code>. (If you're using
activerecord-jdbc-adapter under the old gem name used in versions
0.5 and earlier (ActiveRecord-JDBC), replace
'activerecord-jdbc-adapter' with 'ActiveRecord-JDBC' below.)

if RUBY_PLATFORM =~ /java/
require 'rubygems'
gem 'activerecord-jdbc-adapter'
require 'jdbc_adapter'
end

3. Configure your database.yml to use the <code>jdbc</code> adapter. For mysql,
postgres, derby, oracle, hsqldb, h2, and informix you can simply configure
the database in the normal Rails style. If you use one of the convenience
'activerecord-jdbcXXX-adapter' adapters, be sure and put a 'jdbc' prefix in
front of the databas adapter name as below.
3. Configure your database.yml in the normal Rails style.

Legacy configuration: If you use one of the convenience
'activerecord-jdbcXXX-adapter' adapters, you can still put a 'jdbc'
prefix in front of the databas adapter name as below.

development:
adapter: jdbcmysql
Expand All @@ -76,8 +93,8 @@ To use activerecord-jdbc-adapter with JRuby on Rails:
hostname: localhost
database: weblog_development

For other databases, you'll need to know the database driver class and URL.
Example:
For other databases, you'll need to know the database driver class
and URL. Example:

development:
adapter: jdbc
Expand Down Expand Up @@ -126,6 +143,12 @@ The source for activerecord-jdbc-adapter is available using git.

git clone git://github.com/nicksieger/activerecord-jdbc-adapter.git

== Feedback

Please file bug reports at
http://kenai.com/jira/browse/ACTIVERECORD_JDBC. If you're not sure if
something's a bug, feel free to pre-report it on the mailing lists.

== Running AR-JDBC's Tests

Drivers for 6 open-source databases are included. Provided you have MySQL
Expand Down

0 comments on commit 7ea0326

Please sign in to comment.