README.md in rails3_sequel-0.2.2 vs README.md in rails3_sequel-0.3.0
- old
+ new
@@ -1,19 +1,20 @@
Rails 3 Sequel integration
==========================
+**There has been some confusions with how the logging works. if you are using Rails 3 beta 3, please use the released gem or the beta3 branch on github. if you are using edge Rails 3, then please use this master branch**
+
Features:
+ Generators
- Models - models and migrations
- Migrations - for table alters
- Scaffold
- Controller uses Sequel specific methods.
- Views recognize migration data types.
+ Rake tasks
- - mostly everything except db:test:prepare, db:setup, and db:create:all (should be ready next version)
+ Railties
- uses database.yml configuration
- db connection
- query logging
@@ -22,16 +23,17 @@
+ Gemspec
*What is still need done:*
-+ More testing
++ Write tests
+ i18n
+ Session Store
+ Observers
+ more rake tasks
-+ adapter specific after_create proc
++ adapter specific encoding / charset options
++ namespaced config (config.sequel.xxxx)
Installation
------------
gem install rails3_sequel
@@ -40,10 +42,12 @@
gem 'rails3_sequel'
then run bundle install.
+Please see the note at the top of this README for what version you should use.
+
Usage - Railties
----------------
In your config/application.rb, take out the require "all" line and choose what frameworks you want to include like this:
@@ -74,11 +78,13 @@
Rake tasks usage:
db:create
Creates the database defined in your Rails environment. Unlike AR, this does not create test database with your development. You must specify your Rails environment manually.
- ex. RAILS_ENV=test rake db:create
+ ex. rake db:create[test] or RAILS_ENV=test rake db:create
+ db:create:all
+ Does the above for all environments
db:migrate
You know what this does.
db:migrate:up
Alias to db:migrate.
db:migrate:down
@@ -88,16 +94,21 @@
db:migrate:rollback
Alias to db:migrate:down. Can use VERSION and STEP also.
db:schema:dump
Uses Sequel's schema_dumper. Stores output in db/schema.rb.
db:schema:load
- Does not work yet, but you can just run Sequel::Migrator on the schema file.
+ Uses Sequel's migration. Reads from db/schema.rb.
db:seed
- Load the seed data from db/seeds.rb
+ Load the seed data from db/seeds.rb.
db:version
- Shows the current migration version
- db:setup, db:test:load, db:test:purge
- Not implemented yet
+ Shows the current migration version.
+ db:setup
+ Create the database, load the schema, and initialize with the seed data.
+ db:test:load
+ Recreate the test database from the current schema.rb.
+ db:test:purge
+ Empty the test database.
+
Please note that db:create currently only works with PostgreSQL, MySQL, and SQLite. If you have other DBs, please contribute if you can!
Usage - Generators