From 5a19236fca13c6caf43fe13c41c83b33aa6c6c69 Mon Sep 17 00:00:00 2001 From: Robby Russell Date: Wed, 2 Dec 2009 13:35:28 +0800 Subject: Updating documentation for Console. Now mentioniing sandbox and including a link to the irb section in the online Pickaxe. --- railties/README | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/railties/README b/railties/README index 221e8486d1..ccfec5ac56 100644 --- a/railties/README +++ b/railties/README @@ -1,7 +1,7 @@ == Welcome to Rails -Rails is a web-application framework that includes everything needed to create -database-backed web applications according to the Model-View-Control pattern. +Rails is a web-application framework that includes everything needed to create +database-backed web applications according to the Model-View-Control pattern. This pattern splits the view (also called the presentation) into "dumb" templates that are primarily responsible for inserting pre-built data in between HTML tags. @@ -131,7 +131,7 @@ and also on programming in general. Debugger support is available through the debugger command when you start your Mongrel or Webrick server with --debugger. This means that you can break out of execution at any point -in the code, investigate and change the model, AND then resume execution! +in the code, investigate and change the model, AND then resume execution! You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug' Example: @@ -163,13 +163,20 @@ Finally, when you're ready to resume execution, you enter "cont" == Console -You can interact with the domain model by starting the console through script/console. -Here you'll have all parts of the application configured, just like it is when the +The console is a ruby shell, which allows you to interact with your application's domain +model. Here you'll have all parts of the application configured, just like it is when the application is running. You can inspect domain models, change values, and save to the database. Starting the script without arguments will launch it in the development environment. -Passing an argument will specify a different environment, like script/console production. -To reload your controllers and models after launching the console run reload! +To start the console, just run script/console from the application directory. + +Options: + +* Passing the -s, --sandbox argument will rollback any modifications made to the database. +* Passing an environment name as an argument will load the corresponding environment. + Example: script/console production. + +More information about irb can be found at link:http://www.rubycentral.com/pickaxe/irb.html == dbconsole -- cgit v1.2.3