Class Sequel::Schema::AlterTableGenerator
In: lib/sequel/database/schema_generator.rb
Parent: Object

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.

Methods

Attributes

operations  [R]  An array of DDL operations to perform

Public Class methods

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 208
208:       def initialize(db, &block)
209:         @db = db
210:         @operations = []
211:         instance_eval(&block) if block
212:       end

Public Instance methods

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 216
216:       def add_column(name, type, opts = {})
217:         @operations << {:op => :add_column, :name => name, :type => type}.merge(opts)
218:       end

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 222
222:       def add_constraint(name, *args, &block)
223:         @operations << {:op => :add_constraint, :name => name, :type => :check, :check => block || args}
224:       end

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.

[Source]

     # File lib/sequel/database/schema_generator.rb, line 240
240:       def add_foreign_key(name, table, opts = {})
241:         return add_composite_foreign_key(name, table, opts) if name.is_a?(Array)
242:         add_column(name, Integer, {:table=>table}.merge(opts))
243:       end

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 247
247:       def add_full_text_index(columns, opts = {})
248:         add_index(columns, {:type=>:full_text}.merge(opts))
249:       end

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 253
253:       def add_index(columns, opts = {})
254:         @operations << {:op => :add_index, :columns => Array(columns)}.merge(opts)
255:       end

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 259
259:       def add_primary_key(name, opts = {})
260:         return add_composite_primary_key(name, opts) if name.is_a?(Array)
261:         opts = @db.serial_primary_key_options.merge(opts)
262:         add_column(name, opts.delete(:type), opts)
263:       end

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 267
267:       def add_spatial_index(columns, opts = {})
268:         add_index(columns, {:type=>:spatial}.merge(opts))
269:       end

Add a unique constraint to the given column(s)

[Source]

     # File lib/sequel/database/schema_generator.rb, line 227
227:       def add_unique_constraint(columns, opts = {})
228:         @operations << {:op => :add_constraint, :type => :unique, :columns => Array(columns)}.merge(opts)
229:       end

Remove a column from the DDL for the table.

[Source]

     # File lib/sequel/database/schema_generator.rb, line 272
272:       def drop_column(name)
273:         @operations << {:op => :drop_column, :name => name}
274:       end

Remove a constraint from the DDL for the table.

[Source]

     # File lib/sequel/database/schema_generator.rb, line 277
277:       def drop_constraint(name)
278:         @operations << {:op => :drop_constraint, :name => name}
279:       end

Remove an index from the DDL for the table.

[Source]

     # File lib/sequel/database/schema_generator.rb, line 282
282:       def drop_index(columns, options={})
283:         @operations << {:op => :drop_index, :columns => Array(columns)}.merge(options)
284:       end

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 287
287:       def rename_column(name, new_name, opts = {})
288:         @operations << {:op => :rename_column, :name => name, :new_name => new_name}.merge(opts)
289:       end

Modify a column‘s NOT NULL constraint.

[Source]

     # File lib/sequel/database/schema_generator.rb, line 302
302:       def set_column_allow_null(name, allow_null)
303:         @operations << {:op => :set_column_null, :name => name, :null => allow_null}
304:       end

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 292
292:       def set_column_default(name, default)
293:         @operations << {:op => :set_column_default, :name => name, :default => default}
294:       end

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

[Source]

     # File lib/sequel/database/schema_generator.rb, line 297
297:       def set_column_type(name, type, opts={})
298:         @operations << {:op => :set_column_type, :name => name, :type => type}.merge(opts)
299:       end

[Validate]