class Avram::Migrator::AlterTableStatement

• Avram::Migrator::AlterTableStatement
• Reference
• Object

Included Modules

• Avram::Migrator::IndexStatementHelpers
• Avram::Migrator::MissingOnDeleteWithBelongsToError

Defined in:

Constructors

• .new(table_name : TableName, *, if_exists : Bool = false)

Macro Summary

• add(type_declaration, index = false, using = :btree, unique = false, default = nil, fill_existing_with = nil, **type_options)
• add_belongs_to(type_declaration, on_delete, references = nil, foreign_key_type = Int64, fill_existing_with = nil, unique = false, index = true)

  Adds a references column and index given a model class and references option.

• allow_nulls_for(column_name)

  Change the column's nullability from whatever it is currently to true.

  DEPRECATED Use make_optional instead

• change_default(type_declaration, default)

  Change the columns' default value to default alter table_for(Post) do change_default published_at : Time, default: :now end

• change_type(type_declaration, **type_options)

  Change the column's type from whatever it is currently to type_declaration.type.

• forbid_nulls_for(column_name)

  Change the column's nullability from whatever it is currently to false.

  DEPRECATED Use make_required instead

• remove(name)
• remove_belongs_to(association_name)
• rename(old_name, new_name)
• rename_belongs_to(old_association_name, new_association_name)
• symbol_expected_error(action, name)

Instance Method Summary

• #add_change_default_statement(column : Avram::Migrator::Columns::Base)
• #add_change_type_statement(column : Avram::Migrator::Columns::Base)
• #add_fill_existing_with_statements(column : Symbol | String, type, value, nilable)
• #alter_statements : Array(String)
• #build(&)

  Accepts a block to alter a table using the add method.

• #build_nullability_statement(column_name, nullability)
• #change_default_statements : Array(String)
• #change_nullability_statements : Array(String)
• #change_type_statements : Array(String)
• #dropped_rows : Array(String)
• #fill_existing_with_statements : Array(String)
• #if_exists_statement
• #renamed_rows : Array(String)
• #rows : Array(String)
• #statements

Constructor Detail

Macro Detail

alter table_for(User) do
  allow_nulls_for :email
end

alter table_for(Post) do
  change_default published_at : Time, default: :now
end

alter table_for(User) do
  change_type email : String, case_sensitive: false
end

alter table_for(User) do
  forbid_nulls_for :email
end

Instance Method Detail

built = Avram::Migrator::AlterTableStatement.new(:users).build do
  add name : String
  add age : Int32
  remove old_field
end

built.statements
# => [
"ALTER TABLE users
  ADD name text NOT NULL,
  ADD age int NOT NULL,
  DROP old_field"
]