Class: SQL::TableModifier

Inherits:
Object
  • Object
show all
Defined in:
lib/dm-migrations/sql/table_modifier.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(adapter, table_name, opts = {}, &block) ⇒ TableModifier

Returns a new instance of TableModifier.



5
6
7
8
9
10
11
12
13
# File 'lib/dm-migrations/sql/table_modifier.rb', line 5

def initialize(adapter, table_name, opts = {}, &block)
  @adapter = adapter
  @table_name = table_name.to_s
  @opts = (opts)

  @statements = []

  self.instance_eval &block
end

Instance Attribute Details

#adapterObject

Returns the value of attribute adapter.



3
4
5
# File 'lib/dm-migrations/sql/table_modifier.rb', line 3

def adapter
  @adapter
end

#optsObject

Returns the value of attribute opts.



3
4
5
# File 'lib/dm-migrations/sql/table_modifier.rb', line 3

def opts
  @opts
end

#statementsObject

Returns the value of attribute statements.



3
4
5
# File 'lib/dm-migrations/sql/table_modifier.rb', line 3

def statements
  @statements
end

#table_nameObject

Returns the value of attribute table_name.



3
4
5
# File 'lib/dm-migrations/sql/table_modifier.rb', line 3

def table_name
  @table_name
end

Instance Method Details

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



15
16
17
18
# File 'lib/dm-migrations/sql/table_modifier.rb', line 15

def add_column(name, type, opts = {})
  column = SQL::TableCreator::Column.new(@adapter, name, type, opts)
  @statements << "ALTER TABLE #{quoted_table_name} ADD COLUMN #{column.to_sql}"
end

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



38
39
40
41
# File 'lib/dm-migrations/sql/table_modifier.rb', line 38

def change_column(name, type, opts = {})
  # raise NotImplemented for SQLite3
  @statements << "ALTER TABLE #{quoted_table_name} ALTER COLUMN #{quote_column_name(name)} TYPE #{type}"
end

#drop_column(name) ⇒ Object Also known as: drop_columns



20
21
22
23
24
25
26
27
28
29
30
# File 'lib/dm-migrations/sql/table_modifier.rb', line 20

def drop_column(name)
  # raise NotImplemented for SQLite3. Can't ALTER TABLE, need to copy table.
  # We'd have to inspect it, and we can't, since we aren't executing any queries yet.
  # TODO instead of building the SQL queries when executing the block, create AddColumn,
  # AlterColumn and DropColumn objects that get #to_sql'd
  if name.is_a?(Array)
    name.each{ |n| drop_column(n) }
  else
    @statements << "ALTER TABLE #{quoted_table_name} DROP COLUMN #{quote_column_name(name)}"
  end
end

#quote_column_name(name) ⇒ Object



43
44
45
# File 'lib/dm-migrations/sql/table_modifier.rb', line 43

def quote_column_name(name)
  @adapter.send(:quote_name, name.to_s)
end

#quoted_table_nameObject



47
48
49
# File 'lib/dm-migrations/sql/table_modifier.rb', line 47

def quoted_table_name
  @adapter.send(:quote_name, table_name)
end

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



33
34
35
36
# File 'lib/dm-migrations/sql/table_modifier.rb', line 33

def rename_column(name, new_name, opts = {})
  # raise NotImplemented for SQLite3
  @statements << "ALTER TABLE #{quoted_table_name} RENAME COLUMN #{quote_column_name(name)} TO #{quote_column_name(new_name)}"
end