5 # This class is used to dump the database schema for some connection to some
6 # output format (i.e., ActiveRecord::Schema).
7 class SchemaDumper #:nodoc:
8 private_class_method :new
10 # A list of tables which should not be dumped to the schema.
11 # Acceptable values are strings as well as regexp.
12 # This setting is only used if ActiveRecord::Base.schema_format == :ruby
13 cattr_accessor :ignore_tables
16 def self.dump(connection=ActiveRecord::Base.connection, stream=STDOUT)
17 new(connection).dump(stream)
30 def initialize(connection)
31 @connection = connection
32 @types = @connection.native_database_types
33 @info = @connection.select_one("SELECT * FROM schema_info") rescue nil
37 define_params = @info ? ":version => #{@info['version']}" : ""
40 # This file is auto-generated from the current state of the database. Instead of editing this file,
41 # please use the migrations feature of ActiveRecord to incrementally modify your database, and
42 # then regenerate this schema definition.
44 # Note that this schema.rb definition is the authoritative source for your database schema. If you need
45 # to create the application database on another system, you should be using db:schema:load, not running
46 # all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
47 # you'll amass, the slower it'll run and the greater likelihood for issues).
49 # It's strongly recommended to check this file into your version control system.
51 ActiveRecord::Schema.define(#{define_params}) do
61 @connection.tables.sort.each do |tbl|
62 next if ["schema_info", ignore_tables].flatten.any? do |ignored|
64 when String; tbl == ignored
65 when Regexp; tbl =~ ignored
67 raise StandardError, 'ActiveRecord::SchemaDumper.ignore_tables accepts an array of String and / or Regexp values.'
74 def table(table, stream)
75 columns = @connection.columns(table)
79 if @connection.respond_to?(:pk_and_sequence_for)
80 pk, pk_seq = @connection.pk_and_sequence_for(table)
84 tbl.print " create_table #{table.inspect}"
85 if columns.detect { |c| c.name == pk }
87 tbl.print %Q(, :primary_key => "#{pk}")
90 tbl.print ", :id => false"
92 tbl.print ", :force => true"
95 column_specs = columns.map do |column|
96 raise StandardError, "Unknown type '#{column.sql_type}' for column '#{column.name}'" if @types[column.type].nil?
97 next if column.name == pk
99 spec[:name] = column.name.inspect
100 spec[:type] = column.type.to_s
101 spec[:limit] = column.limit.inspect if column.limit != @types[column.type][:limit] && column.type != :decimal
102 spec[:precision] = column.precision.inspect if !column.precision.nil?
103 spec[:scale] = column.scale.inspect if !column.scale.nil?
104 spec[:null] = 'false' if !column.null
105 spec[:default] = default_string(column.default) if !column.default.nil?
106 (spec.keys - [:name, :type]).each{ |k| spec[k].insert(0, "#{k.inspect} => ")}
110 # find all migration keys used in this table
111 keys = [:name, :limit, :precision, :scale, :default, :null] & column_specs.map(&:keys).flatten
113 # figure out the lengths for each column based on above keys
114 lengths = keys.map{ |key| column_specs.map{ |spec| spec[key] ? spec[key].length + 2 : 0 }.max }
116 # the string we're going to sprintf our values against, with standardized column widths
117 format_string = lengths.map{ |len| "%-#{len}s" }
119 # find the max length for the 'type' column, which is special
120 type_length = column_specs.map{ |column| column[:type].length }.max
122 # add column type definition to our format string
123 format_string.unshift " t.%-#{type_length}s "
127 column_specs.each do |colspec|
128 values = keys.zip(lengths).map{ |key, len| colspec.key?(key) ? colspec[key] + ", " : " " * len }
129 values.unshift colspec[:type]
130 tbl.print((format_string % values).gsub(/,\s*$/, ''))
140 stream.print tbl.read
142 stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
143 stream.puts "# #{e.message}"
150 def default_string(value)
154 when Date, DateTime, Time
155 "'" + value.to_s(:db) + "'"
161 def indexes(table, stream)
162 indexes = @connection.indexes(table)
163 indexes.each do |index|
164 stream.print " add_index #{index.table.inspect}, #{index.columns.inspect}, :name => #{index.name.inspect}"
165 stream.print ", :unique => true" if index.unique
168 stream.puts unless indexes.empty?