Class: Sequel::Schema::AlterTableGenerator

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

Overview

Schema::AlterTableGenerator is an internal class that the user is not expected to instantiate directly. Instances are created by Database#alter_table. It is used to specify table alteration parameters. It takes a Database object and a block of operations to perform on the table, and gives the Database a table an array of operations, which the database uses to alter a table’s description.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(db, &block) ⇒ AlterTableGenerator

Set the Database object to which to apply the DDL, and evaluate the block in the context of this object.



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

def initialize(db, &block)
  @db = db
  @operations = []
  instance_eval(&block) if block
end

Instance Attribute Details

#operations ⇒ Object (readonly)

An array of DDL operations to perform



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

def operations
  @operations
end

Instance Method Details

#add_column(name, type, opts = {}) ⇒ Object

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



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

def add_column(name, type, opts = {})
  @operations << {:op => :add_column, :name => name, :type => type}.merge(opts)
end

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

Add a constraint with the given name and args to the DDL for the table. See Generator#constraint.



222
223
224
225
 
# File 'lib/sequel/database/schema_generator.rb', line 222

def add_constraint(name, *args, &block)
  @operations << {:op => :add_constraint, :name => name, :type => :check, \
    :constraint_type => :check, :check => block || args}
end

#add_foreign_key(name, table, opts = {}) ⇒ Object

Add a foreign key with the given name and referencing the given table to the DDL for the table. See Generator#column for the available options.

You can also pass an array of column names for creating composite foreign keys. In this case, it will assume the columns exists and will only add the constraint.

NOTE: If you need to add a foreign key constraint to an existing column use the composite key syntax even if it is only one column.



241
242
243
244
 
# File 'lib/sequel/database/schema_generator.rb', line 241

def add_foreign_key(name, table, opts = {})
  return add_composite_foreign_key(name, table, opts) if name.is_a?(Array)
  add_column(name, Integer, {:table=>table}.merge(opts))
end

#add_full_text_index(columns, opts = {}) ⇒ Object

Add a full text index on the given columns to the DDL for the table. See Generator#index for available options.



248
249
250
 
# File 'lib/sequel/database/schema_generator.rb', line 248

def add_full_text_index(columns, opts = {})
  add_index(columns, {:type=>:full_text}.merge(opts))
end

#add_index(columns, opts = {}) ⇒ Object

Add an index on the given columns to the DDL for the table. See Generator#index for available options.



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

def add_index(columns, opts = {})
  @operations << {:op => :add_index, :columns => Array(columns)}.merge(opts)
end

#add_primary_key(name, opts = {}) ⇒ Object

Add a primary key to the DDL for the table. See Generator#column for the available options.



260
261
262
263
264
 
# File 'lib/sequel/database/schema_generator.rb', line 260

def add_primary_key(name, opts = {})
  return add_composite_primary_key(name, opts) if name.is_a?(Array)
  opts = @db.serial_primary_key_options.merge(opts)
  add_column(name, opts.delete(:type), opts)
end

#add_spatial_index(columns, opts = {}) ⇒ Object

Add a spatial index on the given columns to the DDL for the table. See Generator#index for available options.



268
269
270
 
# File 'lib/sequel/database/schema_generator.rb', line 268

def add_spatial_index(columns, opts = {})
  add_index(columns, {:type=>:spatial}.merge(opts))
end

#add_unique_constraint(columns, opts = {}) ⇒ Object 



227
228
229
230
 
# File 'lib/sequel/database/schema_generator.rb', line 227

def add_unique_constraint(columns, opts = {})
  @operations << {:op => :add_constraint, :type => :check,
    :constraint_type => :unique, :columns => Array(columns)}.merge(opts)
end

#drop_column(name) ⇒ Object

Remove a column from the DDL for the table.



273
274
275
 
# File 'lib/sequel/database/schema_generator.rb', line 273

def drop_column(name)
  @operations << {:op => :drop_column, :name => name}
end

#drop_constraint(name) ⇒ Object

Remove a constraint from the DDL for the table.



278
279
280
 
# File 'lib/sequel/database/schema_generator.rb', line 278

def drop_constraint(name)
  @operations << {:op => :drop_constraint, :name => name}
end

#drop_index(columns) ⇒ Object

Remove an index from the DDL for the table.



283
284
285
 
# File 'lib/sequel/database/schema_generator.rb', line 283

def drop_index(columns)
  @operations << {:op => :drop_index, :columns => Array(columns)}
end

#rename_column(name, new_name, opts = {}) ⇒ Object

Modify a column’s name in the DDL for the table.



288
289
290
 
# File 'lib/sequel/database/schema_generator.rb', line 288

def rename_column(name, new_name, opts = {})
  @operations << {:op => :rename_column, :name => name, :new_name => new_name}.merge(opts)
end

#set_column_allow_null(name, allow_null) ⇒ Object

Modify a column’s NOT NULL constraint.



303
304
305
 
# File 'lib/sequel/database/schema_generator.rb', line 303

def set_column_allow_null(name, allow_null)
  @operations << {:op => :set_column_null, :name => name, :null => allow_null}
end

#set_column_default(name, default) ⇒ Object

Modify a column’s default value in the DDL for the table.



293
294
295
 
# File 'lib/sequel/database/schema_generator.rb', line 293

def set_column_default(name, default)
  @operations << {:op => :set_column_default, :name => name, :default => default}
end

#set_column_type(name, type, opts = {}) ⇒ Object

Modify a column’s type in the DDL for the table.



298
299
300
 
# File 'lib/sequel/database/schema_generator.rb', line 298

def set_column_type(name, type, opts={})
  @operations << {:op => :set_column_type, :name => name, :type => type}.merge(opts)
end