Module: Sequel::SchemaDumper
- Defined in:
- lib/sequel/extensions/schema_dumper.rb
Instance Method Summary collapse
-
#dump_foreign_key_migration(options = OPTS) ⇒ Object
Dump foreign key constraints for all tables as a migration.
-
#dump_indexes_migration(options = OPTS) ⇒ Object
Dump indexes for all tables as a migration.
-
#dump_schema_migration(options = OPTS) ⇒ Object
Return a string that contains a Sequel::Migration subclass that when run would recreate the database structure.
-
#dump_table_schema(table, options = OPTS) ⇒ Object
Return a string with a create table block that will recreate the given table’s schema.
Instance Method Details
#dump_foreign_key_migration(options = OPTS) ⇒ Object
Dump foreign key constraints for all tables as a migration. This complements the :foreign_keys=>false option to dump_schema_migration. This only dumps the constraints (not the columns) using alter_table/add_foreign_key with an array of columns.
Note that the migration this produces does not have a down block, so you cannot reverse it.
22 23 24 25 26 27 28 29 30 31 |
# File 'lib/sequel/extensions/schema_dumper.rb', line 22 def dump_foreign_key_migration(=OPTS) ts = tables() <<END_MIG Sequel.migration do change do #{ts.sort_by{|t| t.to_s}.map{|t| dump_table_foreign_keys(t)}.reject{|x| x == ''}.join("\n\n").gsub(/^/o, ' ')} end end END_MIG end |
#dump_indexes_migration(options = OPTS) ⇒ Object
Dump indexes for all tables as a migration. This complements the :indexes=>false option to dump_schema_migration. Options:
- :same_db
-
Create a dump for the same database type, so don’t ignore errors if the index statements fail.
- :index_names
-
If set to false, don’t record names of indexes. If set to :namespace, prepend the table name to the index name if the database does not use a global index namespace.
40 41 42 43 44 45 46 47 48 49 |
# File 'lib/sequel/extensions/schema_dumper.rb', line 40 def dump_indexes_migration(=OPTS) ts = tables() <<END_MIG Sequel.migration do change do #{ts.sort_by{|t| t.to_s}.map{|t| dump_table_indexes(t, :add_index, )}.reject{|x| x == ''}.join("\n\n").gsub(/^/o, ' ')} end end END_MIG end |
#dump_schema_migration(options = OPTS) ⇒ Object
Return a string that contains a Sequel::Migration subclass that when run would recreate the database structure. Options:
- :same_db
-
Don’t attempt to translate database types to ruby types. If this isn’t set to true, all database types will be translated to ruby types, but there is no guarantee that the migration generated will yield the same type. Without this set, types that aren’t recognized will be translated to a string-like type.
- :foreign_keys
-
If set to false, don’t dump foreign_keys (they can be
added later via #dump_foreign_key_migration)
- :indexes
-
If set to false, don’t dump indexes (they can be added later via #dump_index_migration).
- :index_names
-
If set to false, don’t record names of indexes. If set to :namespace, prepend the table name to the index name.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/sequel/extensions/schema_dumper.rb', line 64 def dump_schema_migration(=OPTS) = .dup if [:indexes] == false && !.has_key?(:foreign_keys) # Unless foreign_keys option is specifically set, disable if indexes # are disabled, as foreign keys that point to non-primary keys rely # on unique indexes being created first [:foreign_keys] = false end ts = sort_dumped_tables(tables(), ) skipped_fks = if sfk = [:skipped_foreign_keys] # Handle skipped foreign keys by adding them at the end via # alter_table/add_foreign_key. Note that skipped foreign keys # probably result in a broken down migration. sfka = sfk.sort_by{|table, fks| table.to_s}.map{|table, fks| dump_add_fk_constraints(table, fks.values)} sfka.join("\n\n").gsub(/^/o, ' ') unless sfka.empty? end <<END_MIG Sequel.migration do change do #{ts.map{|t| dump_table_schema(t, )}.join("\n\n").gsub(/^/o, ' ')}#{"\n \n" if skipped_fks}#{skipped_fks} end end END_MIG end |
#dump_table_schema(table, options = OPTS) ⇒ Object
Return a string with a create table block that will recreate the given table’s schema. Takes the same options as dump_schema_migration.
93 94 95 96 97 98 |
# File 'lib/sequel/extensions/schema_dumper.rb', line 93 def dump_table_schema(table, =OPTS) table = table.value.to_s if table.is_a?(SQL::Identifier) gen = dump_table_generator(table, ) commands = [gen.dump_columns, gen.dump_constraints, gen.dump_indexes].reject{|x| x == ''}.join("\n\n") "create_table(#{table.inspect}#{', :ignore_index_errors=>true' if ![:same_db] && [:indexes] != false && !gen.indexes.empty?}) do\n#{commands.gsub(/^/o, ' ')}\nend" end |