Class: ActiveRecord::ConnectionAdapters::Table
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
ColumnMethods
|
|
Inherits: | Object |
Defined in: | activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb |
Overview
Represents an SQL table in an abstract way for updating a table. Also see TableDefinition
and connection.create_table
Available transformations are:
change_table :table do |t|
t.primary_key
t.column
t.index
t.rename_index
t.
t.change
t.change_default
t.change_null
t.rename
t.references
t.belongs_to
t.check_constraint
t.string
t.text
t.integer
t.bigint
t.float
t.decimal
t.numeric
t.datetime
t.
t.time
t.date
t.binary
t.blob
t.boolean
t.foreign_key
t.json
t.virtual
t.remove
t.remove_foreign_key
t.remove_references
t.remove_belongs_to
t.remove_index
t.remove_check_constraint
t.
end
ColumnMethods
- Attributes & Methods
Class Method Summary
- .new(table_name, base) ⇒ Table constructor
Instance Attribute Summary
- #name readonly
Instance Method Summary
-
#belongs_to(*args, **options)
Alias for #references.
-
#change(column_name, type, **options)
Changes the column’s definition according to the new options.
-
#change_default(column_name, default_or_changes)
Sets a new default value for a column.
-
#change_null(column_name, null, default = nil)
Sets or removes a NOT NULL constraint on a column.
-
#check_constraint(*args, **options)
Adds a check constraint.
-
#check_constraint_exists?(*args, **options) ⇒ Boolean
Checks if a check_constraint exists on a table.
-
#column(column_name, type, index: nil, **options)
Adds a new column to the named table.
-
#column_exists?(column_name, type = nil, **options) ⇒ Boolean
Checks to see if a column exists.
-
#foreign_key(*args, **options)
Adds a foreign key to the table using a supplied table name.
-
#foreign_key_exists?(*args, **options) ⇒ Boolean
Checks to see if a foreign key exists.
-
#index(column_name, **options)
Adds a new index to the table.
-
#index_exists?(column_name, **options) ⇒ Boolean
Checks to see if an index exists.
-
#references(*args, **options)
(also: #belongs_to)
Adds a reference.
-
#remove(*column_names, **options)
Removes the column(s) from the table definition.
-
#remove_belongs_to(*args, **options)
Alias for #remove_references.
-
#remove_check_constraint(*args, **options)
Removes the given check constraint from the table.
-
#remove_foreign_key(*args, **options)
Removes the given foreign key from the table.
-
#remove_index(column_name = nil, **options)
Removes the given index from the table.
-
#remove_references(*args, **options)
(also: #remove_belongs_to)
Removes a reference.
-
#remove_timestamps(**options)
Removes the timestamp columns (
created_at
andupdated_at
) from the table. -
#rename(column_name, new_column_name)
Renames a column.
-
#rename_index(index_name, new_index_name)
Renames the given index on the table.
-
#timestamps(**options)
Adds timestamps (
created_at
andupdated_at
) columns to the table.
ColumnMethods
- Included
#column | Appends a column or columns of a specified type. |
#primary_key | Appends a primary key definition to the table definition. |
Constructor Details
.new(table_name, base) ⇒ Table
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 711
def initialize(table_name, base) @name = table_name @base = base end
Instance Attribute Details
#name (readonly)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 709
attr_reader :name
Instance Method Details
#belongs_to(*args, **options)
Alias for #references.
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 868
alias :belongs_to :references
#blob
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 324
alias :blob :binary
#change(column_name, type, **options)
Changes the column’s definition according to the new options.
t.change(:name, :string, limit: 80)
t.change(:description, :text)
See TableDefinition#column for details of the options you can use.
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 788
def change(column_name, type, ** ) ( ) @base.change_column(name, column_name, type, ** ) end
#change_default(column_name, default_or_changes)
Sets a new default value for a column.
t.change_default(:qualification, 'new')
t.change_default(:, 1)
t.change_default(:status, from: nil, to: "draft")
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 800
def change_default(column_name, default_or_changes) @base.change_column_default(name, column_name, default_or_changes) end
#change_null(column_name, null, default = nil)
Sets or removes a NOT NULL constraint on a column.
t.change_null(:qualification, true)
t.change_null(:qualification, false, 0)
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 810
def change_null(column_name, null, default = nil) @base.change_column_null(name, column_name, null, default) end
#check_constraint(*args, **options)
Adds a check constraint.
t.check_constraint("price > 0", name: "price_check")
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 920
def check_constraint(*args, ** ) @base.add_check_constraint(name, *args, ** ) end
#check_constraint_exists?(*args, **options) ⇒ Boolean
Checks if a check_constraint exists on a table.
unless t.check_constraint_exists?(name: "price_check")
t.check_constraint("price > 0", name: "price_check")
end
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 940
def check_constraint_exists?(*args, ** ) @base.check_constraint_exists?(name, *args, ** ) end
#column(column_name, type, index: nil, **options)
Adds a new column to the named table.
t.column(:name, :string)
See TableDefinition#column for details of the options you can use.
#column_exists?(column_name, type = nil, **options) ⇒ Boolean
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 735
def column_exists?(column_name, type = nil, ** ) @base.column_exists?(name, column_name, type, ** ) end
#foreign_key(*args, **options)
Adds a foreign key to the table using a supplied table name.
t.foreign_key(: )
t.foreign_key(:, column: :, primary_key: "id")
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 890
def foreign_key(*args, ** ) ( ) @base.add_foreign_key(name, *args, ** ) end
#foreign_key_exists?(*args, **options) ⇒ Boolean
Checks to see if a foreign key exists.
t.foreign_key(: ) unless t.foreign_key_exists?(: )
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 911
def foreign_key_exists?(*args, ** ) @base.foreign_key_exists?(name, *args, ** ) end
#index(column_name, **options)
Adds a new index to the table. column_name
can be a single ::Symbol
, or an ::Array
of Symbols.
t.index(:name)
t.index([:branch_id, :party_id], unique: true)
t.index([:branch_id, :party_id], unique: true, name: 'by_branch_party')
See connection.add_index for details of the options you can use.
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 747
def index(column_name, ** ) ( ) @base.add_index(name, column_name, ** ) end
#index_exists?(column_name, **options) ⇒ Boolean
Checks to see if an index exists.
unless t.index_exists?(:branch_id)
t.index(:branch_id)
end
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 759
def index_exists?(column_name, ** ) @base.index_exists?(name, column_name, ** ) end
#numeric
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 325
alias :numeric :decimal
#references(*args, **options) Also known as: #belongs_to
Adds a reference.
t.references(:user)
t.belongs_to(:supplier, foreign_key: true)
See connection.add_reference for details of the options you can use.
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 862
def references(*args, ** ) ( ) args.each do |ref_name| @base.add_reference(name, ref_name, ** ) end end
#remove(*column_names, **options)
Removes the column(s) from the table definition.
t.remove(:qualification)
t.remove(:qualification, :experience)
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 820
def remove(*column_names, ** ) ( ) @base.remove_columns(name, *column_names, ** ) end
#remove_belongs_to(*args, **options)
Alias for #remove_references.
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 882
alias :remove_belongs_to :remove_references
#remove_check_constraint(*args, **options)
Removes the given check constraint from the table.
t.remove_check_constraint(name: "price_check")
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 929
def remove_check_constraint(*args, ** ) @base.remove_check_constraint(name, *args, ** ) end
#remove_foreign_key(*args, **options)
Removes the given foreign key from the table.
t.remove_foreign_key(: )
t.remove_foreign_key(column: : )
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 901
def remove_foreign_key(*args, ** ) ( ) @base.remove_foreign_key(name, *args, ** ) end
#remove_index(column_name = nil, **options)
Removes the given index from the table.
t.remove_index(:branch_id)
t.remove_index(column: [:branch_id, :party_id])
t.remove_index(name: :by_branch_party)
t.remove_index(:branch_id, name: :by_branch_party)
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 833
def remove_index(column_name = nil, ** ) ( ) @base.remove_index(name, column_name, ** ) end
#remove_references(*args, **options) Also known as: #remove_belongs_to
Removes a reference. Optionally removes a type
column.
t.remove_references(:user)
t.remove_belongs_to(:supplier, polymorphic: true)
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 876
def remove_references(*args, ** ) ( ) args.each do |ref_name| @base.remove_reference(name, ref_name, ** ) end end
#remove_timestamps(**options)
Removes the timestamp columns (created_at
and updated_at
) from the table.
t.
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 843
def (** ) @base. (name, ** ) end
#rename(column_name, new_column_name)
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 852
def rename(column_name, new_column_name) @base.rename_column(name, column_name, new_column_name) end
#rename_index(index_name, new_index_name)
Renames the given index on the table.
t.rename_index(:user_id, :account_id)
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 768
def rename_index(index_name, new_index_name) @base.rename_index(name, index_name, new_index_name) end
#timestamps(**options)
Adds timestamps (created_at
and updated_at
) columns to the table.
t. (null: false)
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 777
def (** ) ( ) @base. (name, ** ) end