Class: Sequel::Schema::CreateTableGenerator

Inherits:
Object
  • Object
show all
Defined in:
lib/sequel/database/schema_generator.rb

Overview

Schema::CreateTableGenerator is an internal class that the user is not expected to instantiate directly. Instances are created by Database#create_table. It is used to specify table creation parameters. It takes a Database object and a block of column/index/constraint specifications, and gives the Database a table description, which the database uses to create a table.

Schema::CreateTableGenerator has some methods but also includes method_missing, allowing users to specify column type as a method instead of using the column method, which makes for a nicer DSL.

For more information on Sequel’s support for schema modification, see the “Schema Modification” guide.

Constant Summary collapse

GENERIC_TYPES =

Classes specifying generic types that Sequel will convert to database-specific types.

[String, Integer, Fixnum, Bignum, Float, Numeric, BigDecimal,
Date, DateTime, Time, File, TrueClass, FalseClass]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(db, &block) ⇒ CreateTableGenerator

Set the database in which to create the table, and evaluate the block in the context of this object.



33
34
35
36
37
38
39
40
41
 
# File 'lib/sequel/database/schema_generator.rb', line 33

def initialize(db, &block)
  @db = db
  @columns = []
  @indexes = []
  @constraints = []
  @primary_key = nil
  instance_eval(&block) if block
  @columns.unshift(@primary_key) if @primary_key && !has_column?(primary_key_name)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(type, name = nil, opts = OPTS) ⇒ Object

Add a column with the given type, name, and opts to the DDL. See column for available options.



210
211
212
 
# File 'lib/sequel/database/schema_generator.rb', line 210

def method_missing(type, name = nil, opts = OPTS)
  name ? column(name, type, opts) : super
end

Instance Attribute Details

#columns ⇒ Object (readonly)

Return the column hashes created by this generator



23
24
25
 
# File 'lib/sequel/database/schema_generator.rb', line 23

def columns
  @columns
end

#constraints ⇒ Object (readonly)

Return the constraint hashes created by this generator



26
27
28
 
# File 'lib/sequel/database/schema_generator.rb', line 26

def constraints
  @constraints
end

#indexes ⇒ Object (readonly)

Return the index hashes created by this generator



29
30
31
 
# File 'lib/sequel/database/schema_generator.rb', line 29

def indexes
  @indexes
end

Class Method Details

.add_type_method(*types) ⇒ Object

Add a method for each of the given types that creates a column with that type as a constant. Types given should either already be constants/classes or a capitalized string/symbol with the same name as a constant/class.

Do not call this method with untrusted input, as that can result in arbitrary code execution.



50
51
52
53
54
 
# File 'lib/sequel/database/schema_generator.rb', line 50

def self.add_type_method(*types)
  types.each do |type|
    class_eval("def #{type}(name, opts={}); column(name, #{type}, opts); end", __FILE__, __LINE__)
  end
end

Instance Method Details

#check(*args, &block) ⇒ Object

Add an unnamed constraint to the DDL, specified by the given block or args:

check(:num=>1..5) # CHECK num >= 1 AND num <= 5
check{num > 5} # CHECK num > 5



61
62
63
 
# File 'lib/sequel/database/schema_generator.rb', line 61

def check(*args, &block)
  constraint(nil, *args, &block)
end

#column(name, type, opts = OPTS) ⇒ Object

Add a column with the given name, type, and opts to the DDL.

column :num, :integer
# num INTEGER

column :name, String, :null=>false, :default=>'a'
# name varchar(255) NOT NULL DEFAULT 'a'

inet :ip
# ip inet

You can also create columns via method missing, so the following are equivalent:

column :number, :integer
integer :number

The following options are supported:

:default

The default value for the column.

:deferrable

For foreign key columns, this ensures referential integrity will work even if referencing table uses a foreign key value that does not yet exist on referenced table (but will exist before the transaction commits). Basically it adds DEFERRABLE INITIALLY DEFERRED on key creation. If you use :immediate as the value, uses DEFERRABLE INITIALLY IMMEDIATE.

:index

Create an index on this column. If given a hash, use the hash as the options for the index.

:key

For foreign key columns, the column in the associated table that this column references. Unnecessary if this column references the primary key of the associated table, except if you are using MySQL.

:null

Mark the column as allowing NULL values (if true), or not allowing NULL values (if false). If unspecified, will default to whatever the database default is.

:on_delete

Specify the behavior of this column when being deleted (:restrict, :cascade, :set_null, :set_default, :no_action).

:on_update

Specify the behavior of this column when being updated (:restrict, :cascade, :set_null, :set_default, :no_action).

:primary_key

Make the column as a single primary key column. This should only be used if you have a single, nonautoincrementing primary key column.

:primary_key_constraint_name

The name to give the primary key constraint

:type

Overrides the type given as the argument. Generally not used by column itself, but can be passed as an option to other methods that call column.

:unique

Mark the column as unique, generally has the same effect as creating a unique index on the column.

:unique_constraint_name

The name to give the unique key constraint



111
112
113
114
115
116
 
# File 'lib/sequel/database/schema_generator.rb', line 111

def column(name, type, opts = OPTS)
  columns << {:name => name, :type => type}.merge(opts)
  if index_opts = opts[:index]
    index(name, index_opts.is_a?(Hash) ? index_opts : {})
  end
end

#constraint(name, *args, &block) ⇒ Object

Adds a named constraint (or unnamed if name is nil) to the DDL, with the given block or args.

constraint(:blah, :num=>1..5) # CONSTRAINT blah CHECK num >= 1 AND num <= 5
check(:foo){num > 5} # CONSTRAINT foo CHECK num > 5



123
124
125
 
# File 'lib/sequel/database/schema_generator.rb', line 123

def constraint(name, *args, &block)
  constraints << {:name => name, :type => :check, :check => block || args}
end

#foreign_key(name, table = nil, opts = OPTS) ⇒ Object

Add a foreign key in the table that references another table to the DDL. See column for available options.

foreign_key(:artist_id) # artist_id INTEGER
foreign_key(:artist_id, :artists) # artist_id INTEGER REFERENCES artists
foreign_key(:artist_id, :artists, :key=>:id) # artist_id INTEGER REFERENCES artists(id)
foreign_key(:artist_id, :artists, :type=>String) # artist_id varchar(255) REFERENCES artists(id)

Additional Options:

:foreign_key_constraint_name

The name to give the foreign key constraint

If you want a foreign key constraint without adding a column (usually because it is a composite foreign key), you can provide an array of columns as the first argument, and you can provide the :name option to name the constraint:

foreign_key([:artist_name, :artist_location], :artists, :name=>:artist_fk)
# ADD CONSTRAINT artist_fk FOREIGN KEY (artist_name, artist_location) REFERENCES artists



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/sequel/database/schema_generator.rb', line 145

def foreign_key(name, table=nil, opts = OPTS)
  opts = case table
  when Hash
    table.merge(opts)
  when Symbol
    opts.merge(:table=>table)
  when NilClass
    opts
  else
    raise(Error, "The second argument to foreign_key should be a Hash, Symbol, or nil")
  end
  return composite_foreign_key(name, opts) if name.is_a?(Array)
  column(name, Integer, opts)
end

#full_text_index(columns, opts = OPTS) ⇒ Object

Add a full text index on the given columns to the DDL.

PostgreSQL specific options:

:index_type

Can be set to :gist to use a GIST index instead of the default GIN index.

:language

Set a language to use for the index (default: simple).

Microsoft SQL Server specific options:

:key_index

The KEY INDEX to use for the full text index.



169
170
171
 
# File 'lib/sequel/database/schema_generator.rb', line 169

def full_text_index(columns, opts = OPTS)
  index(columns, opts.merge(:type => :full_text))
end

#has_column?(name) ⇒ Boolean

True if the DDL includes the creation of a column with the given name.

Returns:

  • (Boolean) 


174
175
176
 
# File 'lib/sequel/database/schema_generator.rb', line 174

def has_column?(name)
  columns.any?{|c| c[:name] == name}
end

#index(columns, opts = OPTS) ⇒ Object

Add an index on the given column(s) with the given options to the DDL. General options:

:name

The name to use for the index. If not given, a default name based on the table and columns is used.

:type

The type of index to use (only supported by some databases)

:unique

Make the index unique, so duplicate values are not allowed.

:where

Create a partial index (only supported by some databases)

PostgreSQL specific options:

:concurrently

Create the index concurrently, so it doesn’t block operations on the table while the index is being built.

:opclass

Use a specific operator class in the index.

Microsoft SQL Server specific options:

:include

Include additional column values in the index, without actually indexing on those values.

index :name
# CREATE INDEX table_name_index ON table (name)

index [:artist_id, :name]
# CREATE INDEX table_artist_id_name_index ON table (artist_id, name)



204
205
206
 
# File 'lib/sequel/database/schema_generator.rb', line 204

def index(columns, opts = OPTS)
  indexes << {:columns => Array(columns)}.merge(opts)
end

#primary_key(name, *args) ⇒ Object

Adds an autoincrementing primary key column or a primary key constraint to the DDL. To just create a constraint, the first argument should be an array of column symbols specifying the primary key columns. To create an autoincrementing primary key column, a single symbol can be used. In both cases, an options hash can be used as the second argument.

If you want to create a primary key column that is not autoincrementing, you should not use this method. Instead, you should use the regular column method with a :primary_key=>true option.

If an array of column symbols is used, you can specify the :name option to name the constraint.

Examples:

primary_key(:id)
primary_key([:street_number, :house_number], :name=>:some constraint_name)



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/sequel/database/schema_generator.rb', line 235

def primary_key(name, *args)
  return composite_primary_key(name, *args) if name.is_a?(Array)
  @primary_key = @db.serial_primary_key_options.merge({:name => name})
  
  if opts = args.pop
    opts = {:type => opts} unless opts.is_a?(Hash)
    if type = args.pop
      opts.merge!(:type => type)
    end
    @primary_key.merge!(opts)
  end
  @primary_key
end

#primary_key_name ⇒ Object

The name of the primary key for this generator, if it has a primary key.



250
251
252
 
# File 'lib/sequel/database/schema_generator.rb', line 250

def primary_key_name
  @primary_key[:name] if @primary_key
end

#respond_to_missing?(meth, include_private) ⇒ Boolean

This object responds to all methods.

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/sequel/database/schema_generator.rb', line 215

def respond_to_missing?(meth, include_private)
  true
end

#spatial_index(columns, opts = OPTS) ⇒ Object

Add a spatial index on the given columns to the DDL.



255
256
257
 
# File 'lib/sequel/database/schema_generator.rb', line 255

def spatial_index(columns, opts = OPTS)
  index(columns, opts.merge(:type => :spatial))
end

#unique(columns, opts = OPTS) ⇒ Object

Add a unique constraint on the given columns to the DDL.

unique(:name) # UNIQUE (name)

Supports the same :deferrable option as #column. The :name option can be used to name the constraint.



265
266
267
 
# File 'lib/sequel/database/schema_generator.rb', line 265

def unique(columns, opts = OPTS)
  constraints << {:type => :unique, :columns => Array(columns)}.merge(opts)
end