aboutsummaryrefslogblamecommitdiffstats
path: root/activerecord/lib/active_record/schema_dumper.rb
blob: be749224539980472daf37fd40db39bf1c9e7256 (plain) (tree)
1
2
3
4
5
6
7
8
9
                  
 
                   

                                 

                                                                              
                             
                             
 

                        
                                                                

                                                                            
                                 
                        
 















                                                                            












                                                                                                    



                    
                        






                     
                                              
                                
                                                       
                          


                        

                                                              
                            
                                                                             

                                                                                 
 
                                                                          


                                                                                      

                                                                            
                                                                                      
 
                                                
 
      





                         


                                                      





                                                                                                       


           
                        
                                                                         


                                                               
           



                                                                               
                                                          

             


                              
                                            

                            
 
                                         
                                             
 
                                                                               


                     
                                                                      
                                                       
                                                                      
                                 


                                              
               

                                                    
              
                                   
             
                                       

                                                          



                                                                      
             
 

                            
                                                 
                                                
                                                                                                                                            
                                     
                                           
                     

                                                      
                                           

                                                                      








                                                    

                                                                                                 




                                                         

                                                           







                                                                                
 
                             
 
                                        
                                                                                                             
                                         
                                                                 


                    

                                       

                          
 




                                                                                               

                     
 
              

         
                                               
                                

                                                       

                                                                         


                                                          
                     
           
         
 













                                                          
                                                     












                                                                                                        
                                     


                                                                        


                                                                                            

                                                                                             
                                                              


                                              
                                                                        


                                                            
                                                          

               

                                                                                           
 
                                   


                                                                


           
                                         
                                                                                                      
         

                              
                                                                                                                                                   
                                                          

           
     
   
require "stringio"

module ActiveRecord
  # = Active Record Schema Dumper
  #
  # This class is used to dump the database schema for some connection to some
  # output format (i.e., ActiveRecord::Schema).
  class SchemaDumper #:nodoc:
    private_class_method :new

    ##
    # :singleton-method:
    # A list of tables which should not be dumped to the schema.
    # Acceptable values are strings as well as regexp.
    # This setting is only used if ActiveRecord::Base.schema_format == :ruby
    cattr_accessor :ignore_tables
    @@ignore_tables = []

    ##
    # :singleton-method:
    # Define whether column arguments are lined up in dump.
    # Acceptable values are true or false.
    # This setting is only used if ActiveRecord::Base.schema_format == :ruby
    cattr_accessor :standardized_argument_widths
    @@standardized_argument_widths = true

    ##
    # :singleton-method:
    # Define whether columns types are lined up in dump.
    # Acceptable values are true or false.
    # This setting is only used if ActiveRecord::Base.schema_format == :ruby
    cattr_accessor :standardized_type_widths
    @@standardized_type_widths = true

    class << self
      def dump(connection=ActiveRecord::Base.connection, stream=STDOUT, config = ActiveRecord::Base)
        new(connection, generate_options(config)).dump(stream)
        stream
      end

      private
        def generate_options(config)
          {
            table_name_prefix: config.table_name_prefix,
            table_name_suffix: config.table_name_suffix
          }
        end
    end

    def dump(stream)
      header(stream)
      extensions(stream)
      tables(stream)
      trailer(stream)
      stream
    end

    private

      def initialize(connection, options = {})
        @connection = connection
        @version = Migrator::current_version rescue nil
        @options = options
      end

      def header(stream)
        define_params = @version ? "version: #{@version}" : ""

        stream.puts <<HEADER
# This file is auto-generated from the current state of the database. Instead
# of editing this file, please use the migrations feature of Active Record to
# incrementally modify your database, and then regenerate this schema definition.
#
# Note that this schema.rb definition is the authoritative source for your
# database schema. If you need to create the application database on another
# system, you should be using db:schema:load, not running all the migrations
# from scratch. The latter is a flawed and unsustainable approach (the more migrations
# you'll amass, the slower it'll run and the greater likelihood for issues).
#
# It's strongly recommended that you check this file into your version control system.

ActiveRecord::Schema.define(#{define_params}) do

HEADER
      end

      def trailer(stream)
        stream.puts "end"
      end

      def extensions(stream)
        return unless @connection.supports_extensions?
        extensions = @connection.extensions
        if extensions.any?
          stream.puts "  # These are extensions that must be enabled in order to support this database"
          extensions.each do |extension|
            stream.puts "  enable_extension #{extension.inspect}"
          end
          stream.puts
        end
      end

      def tables(stream)
        sorted_tables = @connection.data_sources.sort - @connection.views

        sorted_tables.each do |table_name|
          table(table_name, stream) unless ignored?(table_name)
        end

        # dump foreign keys at the end to make sure all dependent tables exist.
        if @connection.supports_foreign_keys?
          sorted_tables.each do |tbl|
            foreign_keys(tbl, stream) unless ignored?(tbl)
          end
        end
      end

      def table(table, stream)
        columns = @connection.columns(table)
        begin
          tbl = StringIO.new

          # first dump primary key column
          pk = @connection.primary_key(table)

          tbl.print "  create_table #{remove_prefix_and_suffix(table).inspect}"

          case pk
          when String
            tbl.print ", primary_key: #{pk.inspect}" unless pk == "id"
            pkcol = columns.detect { |c| c.name == pk }
            pkcolspec = @connection.column_spec_for_primary_key(pkcol)
            if pkcolspec.present?
              pkcolspec.each do |key, value|
                tbl.print ", #{key}: #{value}"
              end
            end
          when Array
            tbl.print ", primary_key: #{pk.inspect}"
          else
            tbl.print ", id: false"
          end
          tbl.print ", force: :cascade"

          table_options = @connection.table_options(table)
          if table_options.present?
            table_options.each do |key, value|
              tbl.print ", #{key}: #{value.inspect}" if value.present?
            end
          end

          tbl.puts " do |t|"

          # then dump all non-primary key columns
          column_specs = columns.map do |column|
            raise StandardError, "Unknown type '#{column.sql_type}' for column '#{column.name}'" unless @connection.valid_type?(column.type)
            next if column.name == pk
            @connection.column_spec(column)
          end.compact

          # find all migration keys used in this table
          keys = @connection.migration_keys

          # figure out the lengths for each column based on above keys
          lengths = if standardized_argument_widths
            keys.map { |key|
              column_specs.map { |spec|
                spec[key] ? spec[key].length + 2 : 0
              }.max
            }
          else
            [0] * keys.length
          end

          # the string we're going to sprintf our values against, with standardized column widths
          format_string = if standardized_argument_widths
            lengths.map { |len| "%-#{len}s" }
          else
            ["%s"] * keys.length
          end

          # add column type definition to our format string
          if standardized_type_widths
            # find the max length for the 'type' column, which is special
            type_length = column_specs.map { |column| column[:type].length }.max

            format_string.unshift "    t.%-#{type_length}s "
          else
            format_string.unshift "    t.%s "
          end

          format_string *= ""

          column_specs.each do |colspec|
            values = keys.zip(lengths).map { |key, len| colspec.key?(key) ? colspec[key] + ", " : " " * len }
            values.unshift colspec[:type]
            tbl.print((format_string % values).gsub(/,\s*$/, ""))
            tbl.puts
          end

          indexes_in_create(table, tbl)

          tbl.puts "  end"
          tbl.puts

          tbl.rewind
          stream.print tbl.read
        rescue => e
          stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
          stream.puts "#   #{e.message}"
          stream.puts
        end

        stream
      end

      # Keep it for indexing materialized views
      def indexes(table, stream)
        if (indexes = @connection.indexes(table)).any?
          add_index_statements = indexes.map do |index|
            table_name = remove_prefix_and_suffix(index.table).inspect
            "  add_index #{([table_name]+index_parts(index)).join(', ')}"
          end

          stream.puts add_index_statements.sort.join("\n")
          stream.puts
        end
      end

      def indexes_in_create(table, stream)
        if (indexes = @connection.indexes(table)).any?
          index_statements = indexes.map do |index|
            "    t.index #{index_parts(index).join(', ')}"
          end
          stream.puts index_statements.sort.join("\n")
        end
      end

      def index_parts(index)
        index_parts = [
          index.columns.inspect,
          "name: #{index.name.inspect}",
        ]
        index_parts << "unique: true" if index.unique

        index_lengths = (index.lengths || []).compact
        index_parts << "length: #{Hash[index.columns.zip(index.lengths)].inspect}" if index_lengths.any?

        index_orders = index.orders || {}
        index_parts << "order: #{index.orders.inspect}" if index_orders.any?
        index_parts << "where: #{index.where.inspect}" if index.where
        index_parts << "using: #{index.using.inspect}" if index.using
        index_parts << "type: #{index.type.inspect}" if index.type
        index_parts << "comment: #{index.comment.inspect}" if index.comment
        index_parts
      end

      def foreign_keys(table, stream)
        if (foreign_keys = @connection.foreign_keys(table)).any?
          add_foreign_key_statements = foreign_keys.map do |foreign_key|
            parts = [
              "add_foreign_key #{remove_prefix_and_suffix(foreign_key.from_table).inspect}",
              remove_prefix_and_suffix(foreign_key.to_table).inspect,
            ]

            if foreign_key.column != @connection.foreign_key_column_for(foreign_key.to_table)
              parts << "column: #{foreign_key.column.inspect}"
            end

            if foreign_key.custom_primary_key?
              parts << "primary_key: #{foreign_key.primary_key.inspect}"
            end

            if foreign_key.name !~ /^fk_rails_[0-9a-f]{10}$/
              parts << "name: #{foreign_key.name.inspect}"
            end

            parts << "on_update: #{foreign_key.on_update.inspect}" if foreign_key.on_update
            parts << "on_delete: #{foreign_key.on_delete.inspect}" if foreign_key.on_delete

            "  #{parts.join(', ')}"
          end

          stream.puts add_foreign_key_statements.sort.join("\n")
        end
      end

      def remove_prefix_and_suffix(table)
        table.gsub(/^(#{@options[:table_name_prefix]})(.+)(#{@options[:table_name_suffix]})$/,  "\\2")
      end

      def ignored?(table_name)
        [ActiveRecord::Base.schema_migrations_table_name, ActiveRecord::Base.internal_metadata_table_name, ignore_tables].flatten.any? do |ignored|
          ignored === remove_prefix_and_suffix(table_name)
        end
      end
  end
end