class Jennifer::Migration::TableBuilder::CreateTable

• Jennifer::Migration::TableBuilder::CreateTable
• Jennifer::Migration::TableBuilder::Base
• Reference
• Object

Overview

Component responsible for creating a new table based on specified columns and properties.

create_table(:contacts) do |t|
  t.string :name, {:size => 30}
  t.integer :age
  t.integer :tags, {:array => true}
  t.decimal :ballance
  t.field :gender, :gender_enum
  t.timestamps true
end

Defined in:

Instance Method Summary

• #bigint(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #bigint with given options.

• #blchar(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #blchar with given options.

• #blob(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #blob with given options.

• #bool(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #bool with given options.

• #box(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #box with given options.

• #bytea(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #bytea with given options.

• #char(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #char with given options.

• #circle(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #circle with given options.

• #column(name, type, options = DbOptions.new)

  Alias for #field.

• #date(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #date with given options.

• #date_time(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #date_time with given options.

• #decimal(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #decimal with given options.

• #double(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #double with given options.

• #enum(name : String | Symbol, values : Array(String), options : Hash(Symbol, AAllowedTypes) = DbOptions.new)

  Defines new enum column name with given options.

• #explain

  Returns string presentation of invoked changes.

• #field(name : String | Symbol, type : Symbol | String, options : Hash(Symbol, AAllowedTypes) = DbOptions.new)

  Defines field name of type type with with given options.

• #fields : Hash(String, Hash(Symbol, Array(Bool | Float32 | Float64 | Int32 | Int64 | JSON::Any | String | Symbol | Nil) | Bool | Float32 | Float64 | Int32 | Int64 | JSON::Any | String | Symbol | Nil))
• #float(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #float with given options.

• #foreign_key(to_table : String | Symbol, column = nil, primary_key = nil, name = nil, *, on_update : Symbol = DEFAULT_ON_EVENT_ACTION, on_delete : Symbol = DEFAULT_ON_EVENT_ACTION)

  Creates a foreign key constraint to to_table table.

• #index(fields : Array(Symbol), type : Symbol? = nil, name : String? = nil, lengths : Hash(Symbol, Int32) = {} of Symbol => Int32, orders : Hash(Symbol, Symbol) = {} of Symbol => Symbol)

  Adds index.

• #index(field : Symbol, type : Symbol? = nil, name : String? = nil, length : Int32? = nil, order : Symbol? = nil)

  Adds index.

• #integer(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #integer with given options.

• #json(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #json with given options.

• #jsonb(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #jsonb with given options.

• #line(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #line with given options.

• #lseg(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #lseg with given options.

• #numeric(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #numeric with given options.

• #oid(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #oid with given options.

• #path(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #path with given options.

• #point(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #point with given options.

• #polygon(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #polygon with given options.

• #process

  Invokes current command.

• #reference(name, type : Symbol = :integer, options : Hash(Symbol, AAllowedTypes) = DbOptions.new)

  Adds a reference.

• #short(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #short with given options.

• #string(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #string with given options.

• #text(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #text with given options.

• #timestamp(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #timestamp with given options.

• #timestamps(null : Bool = false)

  Defines created_at and updated_at timestamp fields.

• #timestamptz(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #timestamptz with given options.

• #tinyint(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #tinyint with given options.

• #uuid(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #uuid with given options.

• #varchar(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #varchar with given options.

• #xml(name : String | Symbol, options = DbOptions.new)

  Defines new column name of type #xml with given options.

Instance Method Detail

create_enum :gender_enum, %w(unspecified female male)

create_table :users do |t|
  t.field :gender, :gender_enum
end

reference :user
reference :order, :bigint
reference :taggable, {:polymorphic => true}