activerecord 4.2.0 → 6.0.0

data/lib/active_record/connection_adapters/schema_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     class SchemaCache
@@ -10,32 +12,63 @@ module ActiveRecord
         @columns      = {}
         @columns_hash = {}
         @primary_keys = {}
-        @tables       = {}
+        @data_sources = {}
+        @indexes      = {}
+      end
+
+      def initialize_dup(other)
+        super
+        @columns      = @columns.dup
+        @columns_hash = @columns_hash.dup
+        @primary_keys = @primary_keys.dup
+        @data_sources = @data_sources.dup
+        @indexes      = @indexes.dup
+      end
+
+      def encode_with(coder)
+        coder["columns"]          = @columns
+        coder["columns_hash"]     = @columns_hash
+        coder["primary_keys"]     = @primary_keys
+        coder["data_sources"]     = @data_sources
+        coder["indexes"]          = @indexes
+        coder["version"]          = connection.migration_context.current_version
+        coder["database_version"] = database_version
+      end
+
+      def init_with(coder)
+        @columns          = coder["columns"]
+        @columns_hash     = coder["columns_hash"]
+        @primary_keys     = coder["primary_keys"]
+        @data_sources     = coder["data_sources"]
+        @indexes          = coder["indexes"] || {}
+        @version          = coder["version"]
+        @database_version = coder["database_version"]
       end
 
       def primary_keys(table_name)
-        @primary_keys[table_name] ||= table_exists?(table_name) ? connection.primary_key(table_name) : nil
+        @primary_keys[table_name] ||= data_source_exists?(table_name) ? connection.primary_key(table_name) : nil
       end
 
       # A cached lookup for table existence.
-      def table_exists?(name)
-        prepare_tables if @tables.empty?
-        return @tables[name] if @tables.key? name
+      def data_source_exists?(name)
+        prepare_data_sources if @data_sources.empty?
+        return @data_sources[name] if @data_sources.key? name
 
-        @tables[name] = connection.table_exists?(name)
+        @data_sources[name] = connection.data_source_exists?(name)
       end
 
       # Add internal cache for table with +table_name+.
       def add(table_name)
-        if table_exists?(table_name)
+        if data_source_exists?(table_name)
           primary_keys(table_name)
           columns(table_name)
           columns_hash(table_name)
+          indexes(table_name)
         end
       end
 
-      def tables(name)
-        @tables[name]
+      def data_sources(name)
+        @data_sources[name]
       end
 
       # Get the columns for a table
@@ -51,43 +84,57 @@ module ActiveRecord
         }]
       end
 
+      # Checks whether the columns hash is already cached for a table.
+      def columns_hash?(table_name)
+        @columns_hash.key?(table_name)
+      end
+
+      def indexes(table_name)
+        @indexes[table_name] ||= connection.indexes(table_name)
+      end
+
+      def database_version # :nodoc:
+        @database_version ||= connection.get_database_version
+      end
+
       # Clears out internal caches
       def clear!
         @columns.clear
         @columns_hash.clear
         @primary_keys.clear
-        @tables.clear
+        @data_sources.clear
+        @indexes.clear
         @version = nil
+        @database_version = nil
       end
 
       def size
-        [@columns, @columns_hash, @primary_keys, @tables].map { |x|
-          x.size
-        }.inject :+
+        [@columns, @columns_hash, @primary_keys, @data_sources].sum(&:size)
       end
 
-      # Clear out internal caches for table with +table_name+.
-      def clear_table_cache!(table_name)
-        @columns.delete table_name
-        @columns_hash.delete table_name
-        @primary_keys.delete table_name
-        @tables.delete table_name
+      # Clear out internal caches for the data source +name+.
+      def clear_data_source_cache!(name)
+        @columns.delete name
+        @columns_hash.delete name
+        @primary_keys.delete name
+        @data_sources.delete name
+        @indexes.delete name
       end
 
       def marshal_dump
         # if we get current version during initialization, it happens stack over flow.
-        @version = ActiveRecord::Migrator.current_version
-        [@version, @columns, @columns_hash, @primary_keys, @tables]
+        @version = connection.migration_context.current_version
+        [@version, @columns, @columns_hash, @primary_keys, @data_sources, @indexes, database_version]
       end
 
       def marshal_load(array)
-        @version, @columns, @columns_hash, @primary_keys, @tables = array
+        @version, @columns, @columns_hash, @primary_keys, @data_sources, @indexes, @database_version = array
+        @indexes = @indexes || {}
       end
 
       private
-
-        def prepare_tables
-          connection.tables.each { |table| @tables[table] = true }
+        def prepare_data_sources
+          connection.data_sources.each { |source| @data_sources[source] = true }
         end
     end
   end

data/lib/active_record/connection_adapters/sql_type_metadata.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  # :stopdoc:
+  module ConnectionAdapters
+    class SqlTypeMetadata
+      attr_reader :sql_type, :type, :limit, :precision, :scale
+
+      def initialize(sql_type: nil, type: nil, limit: nil, precision: nil, scale: nil)
+        @sql_type = sql_type
+        @type = type
+        @limit = limit
+        @precision = precision
+        @scale = scale
+      end
+
+      def ==(other)
+        other.is_a?(SqlTypeMetadata) &&
+          sql_type == other.sql_type &&
+          type == other.type &&
+          limit == other.limit &&
+          precision == other.precision &&
+          scale == other.scale
+      end
+      alias eql? ==
+
+      def hash
+        SqlTypeMetadata.hash ^
+          sql_type.hash ^
+          type.hash ^
+          limit.hash ^
+          precision.hash >> 1 ^
+          scale.hash >> 2
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/sqlite3/database_statements.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      module DatabaseStatements
+        READ_QUERY = ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp(:begin, :commit, :explain, :select, :pragma, :release, :savepoint, :rollback) # :nodoc:
+        private_constant :READ_QUERY
+
+        def write_query?(sql) # :nodoc:
+          !READ_QUERY.match?(sql)
+        end
+
+        def execute(sql, name = nil) #:nodoc:
+          if preventing_writes? && write_query?(sql)
+            raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
+          end
+
+          materialize_transactions
+
+          log(sql, name) do
+            ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+              @connection.execute(sql)
+            end
+          end
+        end
+
+        def exec_query(sql, name = nil, binds = [], prepare: false)
+          if preventing_writes? && write_query?(sql)
+            raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
+          end
+
+          materialize_transactions
+
+          type_casted_binds = type_casted_binds(binds)
+
+          log(sql, name, binds, type_casted_binds) do
+            ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+              # Don't cache statements if they are not prepared
+              unless prepare
+                stmt = @connection.prepare(sql)
+                begin
+                  cols = stmt.columns
+                  unless without_prepared_statement?(binds)
+                    stmt.bind_params(type_casted_binds)
+                  end
+                  records = stmt.to_a
+                ensure
+                  stmt.close
+                end
+              else
+                stmt = @statements[sql] ||= @connection.prepare(sql)
+                cols = stmt.columns
+                stmt.reset!
+                stmt.bind_params(type_casted_binds)
+                records = stmt.to_a
+              end
+
+              ActiveRecord::Result.new(cols, records)
+            end
+          end
+        end
+
+        def exec_delete(sql, name = "SQL", binds = [])
+          exec_query(sql, name, binds)
+          @connection.changes
+        end
+        alias :exec_update :exec_delete
+
+        def begin_db_transaction #:nodoc:
+          log("begin transaction", nil) { @connection.transaction }
+        end
+
+        def commit_db_transaction #:nodoc:
+          log("commit transaction", nil) { @connection.commit }
+        end
+
+        def exec_rollback_db_transaction #:nodoc:
+          log("rollback transaction", nil) { @connection.rollback }
+        end
+
+
+        private
+          def execute_batch(sql, name = nil)
+            if preventing_writes? && write_query?(sql)
+              raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
+            end
+
+            materialize_transactions
+
+            log(sql, name) do
+              ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+                @connection.execute_batch2(sql)
+              end
+            end
+          end
+
+          def last_inserted_id(result)
+            @connection.last_insert_row_id
+          end
+
+          def build_fixture_statements(fixture_set)
+            fixture_set.flat_map do |table_name, fixtures|
+              next if fixtures.empty?
+              fixtures.map { |fixture| build_fixture_sql([fixture], table_name) }
+            end.compact
+          end
+
+          def build_truncate_statements(*table_names)
+            truncate_tables = table_names.map do |table_name|
+              "DELETE FROM #{quote_table_name(table_name)}"
+            end
+            combine_multi_statements(truncate_tables)
+          end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/sqlite3/explain_pretty_printer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      class ExplainPrettyPrinter # :nodoc:
+        # Pretty prints the result of an EXPLAIN QUERY PLAN in a way that resembles
+        # the output of the SQLite shell:
+        #
+        #   0|0|0|SEARCH TABLE users USING INTEGER PRIMARY KEY (rowid=?) (~1 rows)
+        #   0|1|1|SCAN TABLE posts (~100000 rows)
+        #
+        def pp(result)
+          result.rows.map do |row|
+            row.join("|")
+          end.join("\n") + "\n"
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/sqlite3/quoting.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      module Quoting # :nodoc:
+        def quote_string(s)
+          @connection.class.quote(s)
+        end
+
+        def quote_table_name_for_assignment(table, attr)
+          quote_column_name(attr)
+        end
+
+        def quote_table_name(name)
+          self.class.quoted_table_names[name] ||= super.gsub(".", "\".\"").freeze
+        end
+
+        def quote_column_name(name)
+          self.class.quoted_column_names[name] ||= %Q("#{super.gsub('"', '""')}")
+        end
+
+        def quoted_time(value)
+          value = value.change(year: 2000, month: 1, day: 1)
+          quoted_date(value).sub(/\A\d\d\d\d-\d\d-\d\d /, "2000-01-01 ")
+        end
+
+        def quoted_binary(value)
+          "x'#{value.hex}'"
+        end
+
+        def quoted_true
+          "1"
+        end
+
+        def unquoted_true
+          1
+        end
+
+        def quoted_false
+          "0"
+        end
+
+        def unquoted_false
+          0
+        end
+
+        def column_name_matcher
+          COLUMN_NAME
+        end
+
+        def column_name_with_order_matcher
+          COLUMN_NAME_WITH_ORDER
+        end
+
+        COLUMN_NAME = /
+          \A
+          (
+            (?:
+              # "table_name"."column_name" | function(one or no argument)
+              ((?:\w+\.|"\w+"\.)?(?:\w+|"\w+")) | \w+\((?:|\g<2>)\)
+            )
+            (?:\s+AS\s+(?:\w+|"\w+"))?
+          )
+          (?:\s*,\s*\g<1>)*
+          \z
+        /ix
+
+        COLUMN_NAME_WITH_ORDER = /
+          \A
+          (
+            (?:
+              # "table_name"."column_name" | function(one or no argument)
+              ((?:\w+\.|"\w+"\.)?(?:\w+|"\w+")) | \w+\((?:|\g<2>)\)
+            )
+            (?:\s+ASC|\s+DESC)?
+          )
+          (?:\s*,\s*\g<1>)*
+          \z
+        /ix
+
+        private_constant :COLUMN_NAME, :COLUMN_NAME_WITH_ORDER
+
+        private
+
+          def _type_cast(value)
+            case value
+            when BigDecimal
+              value.to_f
+            when String
+              if value.encoding == Encoding::ASCII_8BIT
+                super(value.encode(Encoding::UTF_8))
+              else
+                super
+              end
+            else
+              super
+            end
+          end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/sqlite3/schema_creation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      class SchemaCreation < AbstractAdapter::SchemaCreation # :nodoc:
+        private
+          def add_column_options!(sql, options)
+            if options[:collation]
+              sql << " COLLATE \"#{options[:collation]}\""
+            end
+            super
+          end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/sqlite3/schema_definitions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      class TableDefinition < ActiveRecord::ConnectionAdapters::TableDefinition
+        def references(*args, **options)
+          super(*args, type: :integer, **options)
+        end
+        alias :belongs_to :references
+
+        private
+          def integer_like_primary_key_type(type, options)
+            :primary_key
+          end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/sqlite3/schema_dumper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      class SchemaDumper < ConnectionAdapters::SchemaDumper # :nodoc:
+        private
+          def default_primary_key?(column)
+            schema_type(column) == :integer
+          end
+
+          def explicit_primary_key_default?(column)
+            column.bigint?
+          end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/sqlite3/schema_statements.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      module SchemaStatements # :nodoc:
+        # Returns an array of indexes for the given table.
+        def indexes(table_name)
+          exec_query("PRAGMA index_list(#{quote_table_name(table_name)})", "SCHEMA").map do |row|
+            # Indexes SQLite creates implicitly for internal use start with "sqlite_".
+            # See https://www.sqlite.org/fileformat2.html#intschema
+            next if row["name"].starts_with?("sqlite_")
+
+            index_sql = query_value(<<~SQL, "SCHEMA")
+              SELECT sql
+              FROM sqlite_master
+              WHERE name = #{quote(row['name'])} AND type = 'index'
+              UNION ALL
+              SELECT sql
+              FROM sqlite_temp_master
+              WHERE name = #{quote(row['name'])} AND type = 'index'
+            SQL
+
+            /\bON\b\s*"?(\w+?)"?\s*\((?<expressions>.+?)\)(?:\s*WHERE\b\s*(?<where>.+))?\z/i =~ index_sql
+
+            columns = exec_query("PRAGMA index_info(#{quote(row['name'])})", "SCHEMA").map do |col|
+              col["name"]
+            end
+
+            orders = {}
+
+            if columns.any?(&:nil?) # index created with an expression
+              columns = expressions
+            else
+              # Add info on sort order for columns (only desc order is explicitly specified,
+              # asc is the default)
+              if index_sql # index_sql can be null in case of primary key indexes
+                index_sql.scan(/"(\w+)" DESC/).flatten.each { |order_column|
+                  orders[order_column] = :desc
+                }
+              end
+            end
+
+            IndexDefinition.new(
+              table_name,
+              row["name"],
+              row["unique"] != 0,
+              columns,
+              where: where,
+              orders: orders
+            )
+          end.compact
+        end
+
+        def add_foreign_key(from_table, to_table, **options)
+          alter_table(from_table) do |definition|
+            to_table = strip_table_name_prefix_and_suffix(to_table)
+            definition.foreign_key(to_table, options)
+          end
+        end
+
+        def remove_foreign_key(from_table, to_table = nil, **options)
+          to_table ||= options[:to_table]
+          options = options.except(:name, :to_table)
+          foreign_keys = foreign_keys(from_table)
+
+          fkey = foreign_keys.detect do |fk|
+            table = to_table || begin
+              table = options[:column].to_s.delete_suffix("_id")
+              Base.pluralize_table_names ? table.pluralize : table
+            end
+            table = strip_table_name_prefix_and_suffix(table)
+            fk_to_table = strip_table_name_prefix_and_suffix(fk.to_table)
+            fk_to_table == table && options.all? { |k, v| fk.options[k].to_s == v.to_s }
+          end || raise(ArgumentError, "Table '#{from_table}' has no foreign key for #{to_table || options}")
+
+          foreign_keys.delete(fkey)
+          alter_table(from_table, foreign_keys)
+        end
+
+        def create_schema_dumper(options)
+          SQLite3::SchemaDumper.create(self, options)
+        end
+
+        private
+          def schema_creation
+            SQLite3::SchemaCreation.new(self)
+          end
+
+          def create_table_definition(*args)
+            SQLite3::TableDefinition.new(self, *args)
+          end
+
+          def new_column_from_field(table_name, field)
+            default = \
+              case field["dflt_value"]
+              when /^null$/i
+                nil
+              when /^'(.*)'$/m
+                $1.gsub("''", "'")
+              when /^"(.*)"$/m
+                $1.gsub('""', '"')
+              else
+                field["dflt_value"]
+              end
+
+            type_metadata = fetch_type_metadata(field["type"])
+            Column.new(field["name"], default, type_metadata, field["notnull"].to_i == 0, collation: field["collation"])
+          end
+
+          def data_source_sql(name = nil, type: nil)
+            scope = quoted_scope(name, type: type)
+            scope[:type] ||= "'table','view'"
+
+            sql = +"SELECT name FROM sqlite_master WHERE name <> 'sqlite_sequence'"
+            sql << " AND name = #{scope[:name]}" if scope[:name]
+            sql << " AND type IN (#{scope[:type]})"
+            sql
+          end
+
+          def quoted_scope(name = nil, type: nil)
+            type = \
+              case type
+              when "BASE TABLE"
+                "'table'"
+              when "VIEW"
+                "'view'"
+              end
+            scope = {}
+            scope[:name] = quote(name) if name
+            scope[:type] = type if type
+            scope
+          end
+      end
+    end
+  end
+end