aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/schema_migration.rb
diff options
context:
space:
mode:
authorRichard Schneeman <richard.schneeman@gmail.com>2015-09-15 12:18:13 -0500
committerRichard Schneeman <richard.schneeman@gmail.com>2015-09-15 12:18:13 -0500
commit005ebe72df7d769ea739c4a17d17d250d98daa42 (patch)
treea77693594d1289c6373e433c4f2625441a54ace3 /activerecord/lib/active_record/schema_migration.rb
parent49316d8a6357bbb19c2032faa3dfec8f7e0f0253 (diff)
parent5c5bc8a5af361d43207ca3f1d321e6feba7d7030 (diff)
downloadrails-005ebe72df7d769ea739c4a17d17d250d98daa42.tar.gz
rails-005ebe72df7d769ea739c4a17d17d250d98daa42.tar.bz2
rails-005ebe72df7d769ea739c4a17d17d250d98daa42.zip
Merge pull request #21623 from schneems/schneems/schema-migration-docs
Doc SchemaMigration class.
Diffstat (limited to 'activerecord/lib/active_record/schema_migration.rb')
-rw-r--r--activerecord/lib/active_record/schema_migration.rb6
1 files changed, 5 insertions, 1 deletions
diff --git a/activerecord/lib/active_record/schema_migration.rb b/activerecord/lib/active_record/schema_migration.rb
index cb47bf23f7..b384529e75 100644
--- a/activerecord/lib/active_record/schema_migration.rb
+++ b/activerecord/lib/active_record/schema_migration.rb
@@ -2,7 +2,11 @@ require 'active_record/scoping/default'
require 'active_record/scoping/named'
module ActiveRecord
- class SchemaMigration < ActiveRecord::Base
+ # This class is used to create a table that keeps track of which migrations
+ # have been applied to a given database. When a migration is run, its schema
+ # number is inserted in to the `SchemaMigration.table_name` so it doesn't need
+ # to be executed the next time.
+ class SchemaMigration < ActiveRecord::Base # :nodoc:
class << self
def primary_key
nil