From c5647a08b4a6ece80379306d9f148608e2597d83 Mon Sep 17 00:00:00 2001 From: Francesco Rodriguez Date: Sun, 30 Sep 2012 18:48:22 -0500 Subject: =?UTF-8?q?add=20change=5Ftable=20transformation=20to=20Migration?= =?UTF-8?q?=20docs=C2=A0[ci=20skip]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- activerecord/lib/active_record/migration.rb | 35 ++++++++++++++++------------- 1 file changed, 19 insertions(+), 16 deletions(-) (limited to 'activerecord/lib/active_record/migration.rb') diff --git a/activerecord/lib/active_record/migration.rb b/activerecord/lib/active_record/migration.rb index c1d57855a9..ce9c2fbac0 100644 --- a/activerecord/lib/active_record/migration.rb +++ b/activerecord/lib/active_record/migration.rb @@ -50,7 +50,7 @@ module ActiveRecord # # class AddSsl < ActiveRecord::Migration # def up - # add_column :accounts, :ssl_enabled, :boolean, :default => true + # add_column :accounts, :ssl_enabled, :boolean, default: true # end # # def down @@ -62,7 +62,7 @@ module ActiveRecord # if you're backing out of the migration. It shows how all migrations have # two methods +up+ and +down+ that describes the transformations # required to implement or remove the migration. These methods can consist - # of both the migration specific methods like add_column and remove_column, + # of both the migration specific methods like +add_column+ and +remove_column+, # but may also contain regular Ruby code for generating data needed for the # transformations. # @@ -70,7 +70,7 @@ module ActiveRecord # # class AddSystemSettings < ActiveRecord::Migration # def up - # create_table :system_settings do |t| + # create_table system_settings: do |t| # t.string :name # t.string :label # t.text :value @@ -78,9 +78,9 @@ module ActiveRecord # t.integer :position # end # - # SystemSetting.create :name => "notice", - # :label => "Use notice?", - # :value => 1 + # SystemSetting.create name: 'notice', + # label: 'Use notice?', + # value: 1 # end # # def down @@ -88,19 +88,22 @@ module ActiveRecord # end # end # - # This migration first adds the system_settings table, then creates the very + # This migration first adds the +system_settings+ table, then creates the very # first row in it using the Active Record model that relies on the table. It - # also uses the more advanced create_table syntax where you can specify a + # also uses the more advanced +create_table+ syntax where you can specify a # complete table schema in one block call. # # == Available transformations # - # * create_table(name, options) Creates a table called +name+ and + # * create_table(name, options): Creates a table called +name+ and # makes the table object available to a block that can then add columns to it, - # following the same format as add_column. See example above. The options hash + # following the same format as +add_column+. See example above. The options hash # is for fragments like "DEFAULT CHARSET=UTF-8" that are appended to the create # table definition. # * drop_table(name): Drops the table called +name+. + # * change_table(name, options): Allows to make column alterations to + # the table called +name+. It makes the table object availabe to a block that + # can then add/remove columns, indexes or foreign keys to it. # * rename_table(old_name, new_name): Renames the table called +old_name+ # to +new_name+. # * add_column(table_name, column_name, type, options): Adds a new column @@ -109,9 +112,9 @@ module ActiveRecord # :string, :text, :integer, :float, # :decimal, :datetime, :timestamp, :time, # :date, :binary, :boolean. A default value can be - # specified by passing an +options+ hash like { :default => 11 }. + # specified by passing an +options+ hash like { default: 11 }. # Other options include :limit and :null (e.g. - # { :limit => 50, :null => false }) -- see + # { limit: 50, null: false }) -- see # ActiveRecord::ConnectionAdapters::TableDefinition#column for details. # * rename_column(table_name, column_name, new_column_name): Renames # a column but keeps the type and content. @@ -122,11 +125,11 @@ module ActiveRecord # * add_index(table_name, column_names, options): Adds a new index # with the name of the column. Other options include # :name, :unique (e.g. - # { :name => "users_name_index", :unique => true }) and :order - # (e.g. { :order => {:name => :desc} }). - # * remove_index(table_name, :column => column_name): Removes the index + # { name: 'users_name_index', unique: true }) and :order + # (e.g. { order: { name: :desc } }). + # * remove_index(table_name, column: column_name): Removes the index # specified by +column_name+. - # * remove_index(table_name, :name => index_name): Removes the index + # * remove_index(table_name, name: index_name): Removes the index # specified by +index_name+. # # == Irreversible transformations -- cgit v1.2.3