aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord
diff options
context:
space:
mode:
authorZachary Scott <e@zzak.io>2015-04-12 21:01:55 -0700
committerZachary Scott <e@zzak.io>2015-04-12 21:01:55 -0700
commite83c398f60ac3f8aaa33ec30b1450f4d07542573 (patch)
tree604bababfa7c29ba999b7baaf79c7cbd5eb54aca /activerecord
parentdc70f710018689dc4e487de534c0d40d5724ef6d (diff)
downloadrails-e83c398f60ac3f8aaa33ec30b1450f4d07542573.tar.gz
rails-e83c398f60ac3f8aaa33ec30b1450f4d07542573.tar.bz2
rails-e83c398f60ac3f8aaa33ec30b1450f4d07542573.zip
Add a note regarding add_column restricted API [ci skip]
We should document current behavior, and this is design of API for now. Closes #17597
Diffstat (limited to 'activerecord')
-rw-r--r--activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb4
1 files changed, 4 insertions, 0 deletions
diff --git a/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb b/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
index f0909aabb5..466b076571 100644
--- a/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
+++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
@@ -390,6 +390,10 @@ module ActiveRecord
# Adds a new column to the named table.
# See TableDefinition#column for details of the options you can use.
+ #
+ # Note: Not all options will be available, generally this command should
+ # ignore most of them. In favor of doing a low-level call to simply
+ # create a column.
def add_column(table_name, column_name, type, options = {})
at = create_alter_table table_name
at.add_column(column_name, type, options)