Changesets can be listed by changeset number.
The Git repository is here.
- Revision:
- 373
- Log:
Initial import of Radiant 0.9.1, which is now packaged as a gem. This is an
import of the tagged 0.9.1 source checked out from GitHub, which isn't quite
the same as the gem distribution - but it doesn't seem to be available in an
archived form and the installed gem already has modifications, so this is
the closest I can get.
- Author:
- rool
- Date:
- Mon Mar 21 13:40:05 +0000 2011
- Size:
- 19371 Bytes
1 | module ActiveRecord |
2 | module ConnectionAdapters # :nodoc: |
3 | module SchemaStatements |
4 | # Returns a Hash of mappings from the abstract data types to the native |
5 | # database types. See TableDefinition#column for details on the recognized |
6 | # abstract data types. |
7 | def native_database_types |
8 | {} |
9 | end |
10 | |
11 | # Truncates a table alias according to the limits of the current adapter. |
12 | def table_alias_for(table_name) |
13 | table_name[0..table_alias_length-1].gsub(/\./, '_') |
14 | end |
15 | |
16 | # def tables(name = nil) end |
17 | |
18 | def table_exists?(table_name) |
19 | tables.include?(table_name.to_s) |
20 | end |
21 | |
22 | # Returns an array of indexes for the given table. |
23 | # def indexes(table_name, name = nil) end |
24 | |
25 | # Returns an array of Column objects for the table specified by +table_name+. |
26 | # See the concrete implementation for details on the expected parameter values. |
27 | def columns(table_name, name = nil) end |
28 | |
29 | # Creates a new table with the name +table_name+. +table_name+ may either |
30 | # be a String or a Symbol. |
31 | # |
32 | # There are two ways to work with +create_table+. You can use the block |
33 | # form or the regular form, like this: |
34 | # |
35 | # === Block form |
36 | # # create_table() passes a TableDefinition object to the block. |
37 | # # This form will not only create the table, but also columns for the |
38 | # # table. |
39 | # create_table(:suppliers) do |t| |
40 | # t.column :name, :string, :limit => 60 |
41 | # # Other fields here |
42 | # end |
43 | # |
44 | # === Regular form |
45 | # # Creates a table called 'suppliers' with no columns. |
46 | # create_table(:suppliers) |
47 | # # Add a column to 'suppliers'. |
48 | # add_column(:suppliers, :name, :string, {:limit => 60}) |
49 | # |
50 | # The +options+ hash can include the following keys: |
51 | # [<tt>:id</tt>] |
52 | # Whether to automatically add a primary key column. Defaults to true. |
53 | # Join tables for +has_and_belongs_to_many+ should set <tt>:id => false</tt>. |
54 | # [<tt>:primary_key</tt>] |
55 | # The name of the primary key, if one is to be added automatically. |
56 | # Defaults to +id+. |
57 | # [<tt>:options</tt>] |
58 | # Any extra options you want appended to the table definition. |
59 | # [<tt>:temporary</tt>] |
60 | # Make a temporary table. |
61 | # [<tt>:force</tt>] |
62 | # Set to true to drop the table before creating it. |
63 | # Defaults to false. |
64 | # |
65 | # ===== Examples |
66 | # ====== Add a backend specific option to the generated SQL (MySQL) |
67 | # create_table(:suppliers, :options => 'ENGINE=InnoDB DEFAULT CHARSET=utf8') |
68 | # generates: |
69 | # CREATE TABLE suppliers ( |
70 | # id int(11) DEFAULT NULL auto_increment PRIMARY KEY |
71 | # ) ENGINE=InnoDB DEFAULT CHARSET=utf8 |
72 | # |
73 | # ====== Rename the primary key column |
74 | # create_table(:objects, :primary_key => 'guid') do |t| |
75 | # t.column :name, :string, :limit => 80 |
76 | # end |
77 | # generates: |
78 | # CREATE TABLE objects ( |
79 | # guid int(11) DEFAULT NULL auto_increment PRIMARY KEY, |
80 | # name varchar(80) |
81 | # ) |
82 | # |
83 | # ====== Do not add a primary key column |
84 | # create_table(:categories_suppliers, :id => false) do |t| |
85 | # t.column :category_id, :integer |
86 | # t.column :supplier_id, :integer |
87 | # end |
88 | # generates: |
89 | # CREATE TABLE categories_suppliers ( |
90 | # category_id int, |
91 | # supplier_id int |
92 | # ) |
93 | # |
94 | # See also TableDefinition#column for details on how to create columns. |
95 | def create_table(table_name, options = {}) |
96 | table_definition = TableDefinition.new(self) |
97 | table_definition.primary_key(options[:primary_key] || Base.get_primary_key(table_name.to_s.singularize)) unless options[:id] == false |
98 | |
99 | yield table_definition if block_given? |
100 | |
101 | if options[:force] && table_exists?(table_name) |
102 | drop_table(table_name, options) |
103 | end |
104 | |
105 | create_sql = "CREATE#{' TEMPORARY' if options[:temporary]} TABLE " |
106 | create_sql << "#{quote_table_name(table_name)} (" |
107 | create_sql << table_definition.to_sql |
108 | create_sql << ") #{options[:options]}" |
109 | execute create_sql |
110 | end |
111 | |
112 | # A block for changing columns in +table+. |
113 | # |
114 | # === Example |
115 | # # change_table() yields a Table instance |
116 | # change_table(:suppliers) do |t| |
117 | # t.column :name, :string, :limit => 60 |
118 | # # Other column alterations here |
119 | # end |
120 | # |
121 | # ===== Examples |
122 | # ====== Add a column |
123 | # change_table(:suppliers) do |t| |
124 | # t.column :name, :string, :limit => 60 |
125 | # end |
126 | # |
127 | # ====== Add 2 integer columns |
128 | # change_table(:suppliers) do |t| |
129 | # t.integer :width, :height, :null => false, :default => 0 |
130 | # end |
131 | # |
132 | # ====== Add created_at/updated_at columns |
133 | # change_table(:suppliers) do |t| |
134 | # t.timestamps |
135 | # end |
136 | # |
137 | # ====== Add a foreign key column |
138 | # change_table(:suppliers) do |t| |
139 | # t.references :company |
140 | # end |
141 | # |
142 | # Creates a <tt>company_id(integer)</tt> column |
143 | # |
144 | # ====== Add a polymorphic foreign key column |
145 | # change_table(:suppliers) do |t| |
146 | # t.belongs_to :company, :polymorphic => true |
147 | # end |
148 | # |
149 | # Creates <tt>company_type(varchar)</tt> and <tt>company_id(integer)</tt> columns |
150 | # |
151 | # ====== Remove a column |
152 | # change_table(:suppliers) do |t| |
153 | # t.remove :company |
154 | # end |
155 | # |
156 | # ====== Remove several columns |
157 | # change_table(:suppliers) do |t| |
158 | # t.remove :company_id |
159 | # t.remove :width, :height |
160 | # end |
161 | # |
162 | # ====== Remove an index |
163 | # change_table(:suppliers) do |t| |
164 | # t.remove_index :company_id |
165 | # end |
166 | # |
167 | # See also Table for details on |
168 | # all of the various column transformation |
169 | def change_table(table_name) |
170 | yield Table.new(table_name, self) |
171 | end |
172 | |
173 | # Renames a table. |
174 | # ===== Example |
175 | # rename_table('octopuses', 'octopi') |
176 | def rename_table(table_name, new_name) |
177 | raise NotImplementedError, "rename_table is not implemented" |
178 | end |
179 | |
180 | # Drops a table from the database. |
181 | def drop_table(table_name, options = {}) |
182 | execute "DROP TABLE #{quote_table_name(table_name)}" |
183 | end |
184 | |
185 | # Adds a new column to the named table. |
186 | # See TableDefinition#column for details of the options you can use. |
187 | def add_column(table_name, column_name, type, options = {}) |
188 | add_column_sql = "ALTER TABLE #{quote_table_name(table_name)} ADD #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}" |
189 | add_column_options!(add_column_sql, options) |
190 | execute(add_column_sql) |
191 | end |
192 | |
193 | # Removes the column(s) from the table definition. |
194 | # ===== Examples |
195 | # remove_column(:suppliers, :qualification) |
196 | # remove_columns(:suppliers, :qualification, :experience) |
197 | def remove_column(table_name, *column_names) |
198 | column_names.flatten.each do |column_name| |
199 | execute "ALTER TABLE #{quote_table_name(table_name)} DROP #{quote_column_name(column_name)}" |
200 | end |
201 | end |
202 | alias :remove_columns :remove_column |
203 | |
204 | # Changes the column's definition according to the new options. |
205 | # See TableDefinition#column for details of the options you can use. |
206 | # ===== Examples |
207 | # change_column(:suppliers, :name, :string, :limit => 80) |
208 | # change_column(:accounts, :description, :text) |
209 | def change_column(table_name, column_name, type, options = {}) |
210 | raise NotImplementedError, "change_column is not implemented" |
211 | end |
212 | |
213 | # Sets a new default value for a column. If you want to set the default |
214 | # value to +NULL+, you are out of luck. You need to |
215 | # DatabaseStatements#execute the appropriate SQL statement yourself. |
216 | # ===== Examples |
217 | # change_column_default(:suppliers, :qualification, 'new') |
218 | # change_column_default(:accounts, :authorized, 1) |
219 | def change_column_default(table_name, column_name, default) |
220 | raise NotImplementedError, "change_column_default is not implemented" |
221 | end |
222 | |
223 | # Renames a column. |
224 | # ===== Example |
225 | # rename_column(:suppliers, :description, :name) |
226 | def rename_column(table_name, column_name, new_column_name) |
227 | raise NotImplementedError, "rename_column is not implemented" |
228 | end |
229 | |
230 | # Adds a new index to the table. +column_name+ can be a single Symbol, or |
231 | # an Array of Symbols. |
232 | # |
233 | # The index will be named after the table and the first column name, |
234 | # unless you pass <tt>:name</tt> as an option. |
235 | # |
236 | # When creating an index on multiple columns, the first column is used as a name |
237 | # for the index. For example, when you specify an index on two columns |
238 | # [<tt>:first</tt>, <tt>:last</tt>], the DBMS creates an index for both columns as well as an |
239 | # index for the first column <tt>:first</tt>. Using just the first name for this index |
240 | # makes sense, because you will never have to create a singular index with this |
241 | # name. |
242 | # |
243 | # ===== Examples |
244 | # |
245 | # ====== Creating a simple index |
246 | # add_index(:suppliers, :name) |
247 | # generates |
248 | # CREATE INDEX suppliers_name_index ON suppliers(name) |
249 | # |
250 | # ====== Creating a unique index |
251 | # add_index(:accounts, [:branch_id, :party_id], :unique => true) |
252 | # generates |
253 | # CREATE UNIQUE INDEX accounts_branch_id_party_id_index ON accounts(branch_id, party_id) |
254 | # |
255 | # ====== Creating a named index |
256 | # add_index(:accounts, [:branch_id, :party_id], :unique => true, :name => 'by_branch_party') |
257 | # generates |
258 | # CREATE UNIQUE INDEX by_branch_party ON accounts(branch_id, party_id) |
259 | # |
260 | # ====== Creating an index with specific key length |
261 | # add_index(:accounts, :name, :name => 'by_name', :length => 10) |
262 | # generates |
263 | # CREATE INDEX by_name ON accounts(name(10)) |
264 | # |
265 | # add_index(:accounts, [:name, :surname], :name => 'by_name_surname', :length => {:name => 10, :surname => 15}) |
266 | # generates |
267 | # CREATE INDEX by_name_surname ON accounts(name(10), surname(15)) |
268 | # |
269 | # Note: SQLite doesn't support index length |
270 | def add_index(table_name, column_name, options = {}) |
271 | column_names = Array(column_name) |
272 | index_name = index_name(table_name, :column => column_names) |
273 | |
274 | if Hash === options # legacy support, since this param was a string |
275 | index_type = options[:unique] ? "UNIQUE" : "" |
276 | index_name = options[:name] || index_name |
277 | else |
278 | index_type = options |
279 | end |
280 | |
281 | if index_name.length > index_name_length |
282 | @logger.warn("Index name '#{index_name}' on table '#{table_name}' is too long; the limit is #{index_name_length} characters. Skipping.") |
283 | return |
284 | end |
285 | if index_exists?(table_name, index_name, false) |
286 | @logger.warn("Index name '#{index_name}' on table '#{table_name}' already exists. Skipping.") |
287 | return |
288 | end |
289 | quoted_column_names = quoted_columns_for_index(column_names, options).join(", ") |
290 | |
291 | execute "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} (#{quoted_column_names})" |
292 | end |
293 | |
294 | # Remove the given index from the table. |
295 | # |
296 | # Remove the suppliers_name_index in the suppliers table. |
297 | # remove_index :suppliers, :name |
298 | # Remove the index named accounts_branch_id_index in the accounts table. |
299 | # remove_index :accounts, :column => :branch_id |
300 | # Remove the index named accounts_branch_id_party_id_index in the accounts table. |
301 | # remove_index :accounts, :column => [:branch_id, :party_id] |
302 | # Remove the index named by_branch_party in the accounts table. |
303 | # remove_index :accounts, :name => :by_branch_party |
304 | def remove_index(table_name, options = {}) |
305 | index_name = index_name(table_name, options) |
306 | unless index_exists?(table_name, index_name, true) |
307 | @logger.warn("Index name '#{index_name}' on table '#{table_name}' does not exist. Skipping.") |
308 | return |
309 | end |
310 | remove_index!(table_name, index_name) |
311 | end |
312 | |
313 | def remove_index!(table_name, index_name) #:nodoc: |
314 | execute "DROP INDEX #{quote_column_name(index_name)} ON #{table_name}" |
315 | end |
316 | |
317 | # Rename an index. |
318 | # |
319 | # Rename the index_people_on_last_name index to index_users_on_last_name |
320 | # rename_index :people, 'index_people_on_last_name', 'index_users_on_last_name' |
321 | def rename_index(table_name, old_name, new_name) |
322 | # this is a naive implementation; some DBs may support this more efficiently (Postgres, for instance) |
323 | old_index_def = indexes(table_name).detect { |i| i.name == old_name } |
324 | return unless old_index_def |
325 | remove_index(table_name, :name => old_name) |
326 | add_index(table_name, old_index_def.columns, :name => new_name, :unique => old_index_def.unique) |
327 | end |
328 | |
329 | def index_name(table_name, options) #:nodoc: |
330 | if Hash === options # legacy support |
331 | if options[:column] |
332 | "index_#{table_name}_on_#{Array(options[:column]) * '_and_'}" |
333 | elsif options[:name] |
334 | options[:name] |
335 | else |
336 | raise ArgumentError, "You must specify the index name" |
337 | end |
338 | else |
339 | index_name(table_name, :column => options) |
340 | end |
341 | end |
342 | |
343 | # Verify the existence of an index. |
344 | # |
345 | # The default argument is returned if the underlying implementation does not define the indexes method, |
346 | # as there's no way to determine the correct answer in that case. |
347 | def index_exists?(table_name, index_name, default) |
348 | return default unless respond_to?(:indexes) |
349 | indexes(table_name).detect { |i| i.name == index_name } |
350 | end |
351 | |
352 | # Returns a string of <tt>CREATE TABLE</tt> SQL statement(s) for recreating the |
353 | # entire structure of the database. |
354 | def structure_dump |
355 | end |
356 | |
357 | def dump_schema_information #:nodoc: |
358 | sm_table = ActiveRecord::Migrator.schema_migrations_table_name |
359 | migrated = select_values("SELECT version FROM #{sm_table}") |
360 | migrated.map { |v| "INSERT INTO #{sm_table} (version) VALUES ('#{v}');" }.join("\n\n") |
361 | end |
362 | |
363 | # Should not be called normally, but this operation is non-destructive. |
364 | # The migrations module handles this automatically. |
365 | def initialize_schema_migrations_table |
366 | sm_table = ActiveRecord::Migrator.schema_migrations_table_name |
367 | |
368 | unless tables.detect { |t| t == sm_table } |
369 | create_table(sm_table, :id => false) do |schema_migrations_table| |
370 | schema_migrations_table.column :version, :string, :null => false |
371 | end |
372 | add_index sm_table, :version, :unique => true, |
373 | :name => "#{Base.table_name_prefix}unique_schema_migrations#{Base.table_name_suffix}" |
374 | |
375 | # Backwards-compatibility: if we find schema_info, assume we've |
376 | # migrated up to that point: |
377 | si_table = Base.table_name_prefix + 'schema_info' + Base.table_name_suffix |
378 | |
379 | if tables.detect { |t| t == si_table } |
380 | |
381 | old_version = select_value("SELECT version FROM #{quote_table_name(si_table)}").to_i |
382 | assume_migrated_upto_version(old_version) |
383 | drop_table(si_table) |
384 | end |
385 | end |
386 | end |
387 | |
388 | def assume_migrated_upto_version(version, migrations_path = ActiveRecord::Migrator.migrations_path) |
389 | version = version.to_i |
390 | sm_table = quote_table_name(ActiveRecord::Migrator.schema_migrations_table_name) |
391 | |
392 | migrated = select_values("SELECT version FROM #{sm_table}").map(&:to_i) |
393 | versions = Dir["#{migrations_path}/[0-9]*_*.rb"].map do |filename| |
394 | filename.split('/').last.split('_').first.to_i |
395 | end |
396 | |
397 | unless migrated.include?(version) |
398 | execute "INSERT INTO #{sm_table} (version) VALUES ('#{version}')" |
399 | end |
400 | |
401 | inserted = Set.new |
402 | (versions - migrated).each do |v| |
403 | if inserted.include?(v) |
404 | raise "Duplicate migration #{v}. Please renumber your migrations to resolve the conflict." |
405 | elsif v < version |
406 | execute "INSERT INTO #{sm_table} (version) VALUES ('#{v}')" |
407 | inserted << v |
408 | end |
409 | end |
410 | end |
411 | |
412 | def type_to_sql(type, limit = nil, precision = nil, scale = nil) #:nodoc: |
413 | if native = native_database_types[type] |
414 | column_type_sql = (native.is_a?(Hash) ? native[:name] : native).dup |
415 | |
416 | if type == :decimal # ignore limit, use precision and scale |
417 | scale ||= native[:scale] |
418 | |
419 | if precision ||= native[:precision] |
420 | if scale |
421 | column_type_sql << "(#{precision},#{scale})" |
422 | else |
423 | column_type_sql << "(#{precision})" |
424 | end |
425 | elsif scale |
426 | raise ArgumentError, "Error adding decimal column: precision cannot be empty if scale if specified" |
427 | end |
428 | |
429 | elsif (type != :primary_key) && (limit ||= native.is_a?(Hash) && native[:limit]) |
430 | column_type_sql << "(#{limit})" |
431 | end |
432 | |
433 | column_type_sql |
434 | else |
435 | type |
436 | end |
437 | end |
438 | |
439 | def add_column_options!(sql, options) #:nodoc: |
440 | sql << " DEFAULT #{quote(options[:default], options[:column])}" if options_include_default?(options) |
441 | # must explicitly check for :null to allow change_column to work on migrations |
442 | if options[:null] == false |
443 | sql << " NOT NULL" |
444 | end |
445 | end |
446 | |
447 | # SELECT DISTINCT clause for a given set of columns and a given ORDER BY clause. |
448 | # Both PostgreSQL and Oracle overrides this for custom DISTINCT syntax. |
449 | # |
450 | # distinct("posts.id", "posts.created_at desc") |
451 | def distinct(columns, order_by) |
452 | "DISTINCT #{columns}" |
453 | end |
454 | |
455 | # ORDER BY clause for the passed order option. |
456 | # PostgreSQL overrides this due to its stricter standards compliance. |
457 | def add_order_by_for_association_limiting!(sql, options) |
458 | sql << " ORDER BY #{options[:order]}" |
459 | end |
460 | |
461 | # Adds timestamps (created_at and updated_at) columns to the named table. |
462 | # ===== Examples |
463 | # add_timestamps(:suppliers) |
464 | def add_timestamps(table_name) |
465 | add_column table_name, :created_at, :datetime |
466 | add_column table_name, :updated_at, :datetime |
467 | end |
468 | |
469 | # Removes the timestamp columns (created_at and updated_at) from the table definition. |
470 | # ===== Examples |
471 | # remove_timestamps(:suppliers) |
472 | def remove_timestamps(table_name) |
473 | remove_column table_name, :updated_at |
474 | remove_column table_name, :created_at |
475 | end |
476 | |
477 | protected |
478 | # Overridden by the mysql adapter for supporting index lengths |
479 | def quoted_columns_for_index(column_names, options = {}) |
480 | column_names.map {|name| quote_column_name(name) } |
481 | end |
482 | |
483 | def options_include_default?(options) |
484 | options.include?(:default) && !(options[:null] == false && options[:default].nil?) |
485 | end |
486 | end |
487 | end |
488 | end |