activerecord 5.2.3 → 6.1.0

data/lib/active_record/connection_adapters/schema_cache.rb

@@ -1,8 +1,29 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/file/atomic"
+
 module ActiveRecord
   module ConnectionAdapters
     class SchemaCache
+      def self.load_from(filename)
+        return unless File.file?(filename)
+
+        read(filename) do |file|
+          filename.include?(".dump") ? Marshal.load(file) : YAML.load(file)
+        end
+      end
+
+      def self.read(filename, &block)
+        if File.extname(filename) == ".gz"
+          Zlib::GzipReader.open(filename) { |gz|
+            yield gz.read
+          }
+        else
+          yield File.read(filename)
+        end
+      end
+      private_class_method :read
+
       attr_reader :version
       attr_accessor :connection
 
@@ -13,6 +34,7 @@ module ActiveRecord
         @columns_hash = {}
         @primary_keys = {}
         @data_sources = {}
+        @indexes      = {}
       end
 
       def initialize_dup(other)
@@ -21,26 +43,37 @@ module ActiveRecord
         @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["version"] = connection.migration_context.current_version
+        reset_version!
+
+        coder["columns"]          = @columns
+        coder["primary_keys"]     = @primary_keys
+        coder["data_sources"]     = @data_sources
+        coder["indexes"]          = @indexes
+        coder["version"]          = @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"]
-        @version = coder["version"]
+        @columns          = coder["columns"]
+        @primary_keys     = coder["primary_keys"]
+        @data_sources     = coder["data_sources"]
+        @indexes          = coder["indexes"] || {}
+        @version          = coder["version"]
+        @database_version = coder["database_version"]
+
+        derive_columns_hash_and_deduplicate_values
       end
 
       def primary_keys(table_name)
-        @primary_keys[table_name] ||= data_source_exists?(table_name) ? connection.primary_key(table_name) : nil
+        @primary_keys.fetch(table_name) do
+          if data_source_exists?(table_name)
+            @primary_keys[deep_deduplicate(table_name)] = deep_deduplicate(connection.primary_key(table_name))
+          end
+        end
       end
 
       # A cached lookup for table existence.
@@ -48,7 +81,7 @@ module ActiveRecord
         prepare_data_sources if @data_sources.empty?
         return @data_sources[name] if @data_sources.key? name
 
-        @data_sources[name] = connection.data_source_exists?(name)
+        @data_sources[deep_deduplicate(name)] = connection.data_source_exists?(name)
       end
 
       # Add internal cache for table with +table_name+.
@@ -57,6 +90,7 @@ module ActiveRecord
           primary_keys(table_name)
           columns(table_name)
           columns_hash(table_name)
+          indexes(table_name)
         end
       end
 
@@ -66,15 +100,32 @@ module ActiveRecord
 
       # Get the columns for a table
       def columns(table_name)
-        @columns[table_name] ||= connection.columns(table_name)
+        @columns.fetch(table_name) do
+          @columns[deep_deduplicate(table_name)] = deep_deduplicate(connection.columns(table_name))
+        end
       end
 
       # Get the columns for a table as a hash, key is the column name
       # value is the column object.
       def columns_hash(table_name)
-        @columns_hash[table_name] ||= Hash[columns(table_name).map { |col|
-          [col.name, col]
-        }]
+        @columns_hash.fetch(table_name) do
+          @columns_hash[deep_deduplicate(table_name)] = columns(table_name).index_by(&:name).freeze
+        end
+      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.fetch(table_name) do
+          @indexes[deep_deduplicate(table_name)] = deep_deduplicate(connection.indexes(table_name))
+        end
+      end
+
+      def database_version # :nodoc:
+        @database_version ||= connection.get_database_version
       end
 
       # Clears out internal caches
@@ -83,11 +134,13 @@ module ActiveRecord
         @columns_hash.clear
         @primary_keys.clear
         @data_sources.clear
+        @indexes.clear
         @version = nil
+        @database_version = nil
       end
 
       def size
-        [@columns, @columns_hash, @primary_keys, @data_sources].map(&:size).inject :+
+        [@columns, @columns_hash, @primary_keys, @data_sources].sum(&:size)
       end
 
       # Clear out internal caches for the data source +name+.
@@ -96,23 +149,76 @@ module ActiveRecord
         @columns_hash.delete name
         @primary_keys.delete name
         @data_sources.delete name
+        @indexes.delete name
+      end
+
+      def dump_to(filename)
+        clear!
+        connection.data_sources.each { |table| add(table) }
+        open(filename) { |f|
+          if filename.include?(".dump")
+            f.write(Marshal.dump(self))
+          else
+            f.write(YAML.dump(self))
+          end
+        }
       end
 
       def marshal_dump
-        # if we get current version during initialization, it happens stack over flow.
-        @version = connection.migration_context.current_version
-        [@version, @columns, @columns_hash, @primary_keys, @data_sources]
+        reset_version!
+
+        [@version, @columns, {}, @primary_keys, @data_sources, @indexes, database_version]
       end
 
       def marshal_load(array)
-        @version, @columns, @columns_hash, @primary_keys, @data_sources = array
+        @version, @columns, _columns_hash, @primary_keys, @data_sources, @indexes, @database_version = array
+        @indexes ||= {}
+
+        derive_columns_hash_and_deduplicate_values
       end
 
       private
+        def reset_version!
+          @version = connection.migration_context.current_version
+        end
+
+        def derive_columns_hash_and_deduplicate_values
+          @columns      = deep_deduplicate(@columns)
+          @columns_hash = @columns.transform_values { |columns| columns.index_by(&:name) }
+          @primary_keys = deep_deduplicate(@primary_keys)
+          @data_sources = deep_deduplicate(@data_sources)
+          @indexes      = deep_deduplicate(@indexes)
+        end
+
+        def deep_deduplicate(value)
+          case value
+          when Hash
+            value.transform_keys { |k| deep_deduplicate(k) }.transform_values { |v| deep_deduplicate(v) }
+          when Array
+            value.map { |i| deep_deduplicate(i) }
+          when String, Deduplicable
+            -value
+          else
+            value
+          end
+        end
 
         def prepare_data_sources
           connection.data_sources.each { |source| @data_sources[source] = true }
         end
+
+        def open(filename)
+          File.atomic_write(filename) do |file|
+            if File.extname(filename) == ".gz"
+              zipper = Zlib::GzipWriter.new file
+              yield zipper
+              zipper.flush
+              zipper.close
+            else
+              yield file
+            end
+          end
+        end
     end
   end
 end

data/lib/active_record/connection_adapters/sql_type_metadata.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require "active_record/connection_adapters/deduplicable"
+
 module ActiveRecord
   # :stopdoc:
   module ConnectionAdapters
     class SqlTypeMetadata
+      include Deduplicable
+
       attr_reader :sql_type, :type, :limit, :precision, :scale
 
       def initialize(sql_type: nil, type: nil, limit: nil, precision: nil, scale: nil)
@@ -16,18 +20,27 @@ module ActiveRecord
 
       def ==(other)
         other.is_a?(SqlTypeMetadata) &&
-          attributes_for_hash == other.attributes_for_hash
+          sql_type == other.sql_type &&
+          type == other.type &&
+          limit == other.limit &&
+          precision == other.precision &&
+          scale == other.scale
       end
       alias eql? ==
 
       def hash
-        attributes_for_hash.hash
+        SqlTypeMetadata.hash ^
+          sql_type.hash ^
+          type.hash ^
+          limit.hash ^
+          precision.hash >> 1 ^
+          scale.hash >> 2
       end
 
-      protected
-
-        def attributes_for_hash
-          [self.class, sql_type, type, limit, precision, scale]
+      private
+        def deduplicated
+          @sql_type = -sql_type
+          super
         end
     end
   end

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

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      module DatabaseStatements
+        READ_QUERY = ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp(
+          :pragma
+        ) # :nodoc:
+        private_constant :READ_QUERY
+
+        def write_query?(sql) # :nodoc:
+          !READ_QUERY.match?(sql)
+        end
+
+        def explain(arel, binds = [])
+          sql = "EXPLAIN QUERY PLAN #{to_sql(arel, binds)}"
+          SQLite3::ExplainPrettyPrinter.new.pp(exec_query(sql, "EXPLAIN", []))
+        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
+          mark_transaction_written_if_write(sql)
+
+          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
+          mark_transaction_written_if_write(sql)
+
+          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
+
+              build_result(columns: cols, rows: 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_isolated_db_transaction(isolation) #:nodoc
+          raise TransactionIsolationError, "SQLite3 only supports the `read_uncommitted` transaction isolation level" if isolation != :read_uncommitted
+          raise StandardError, "You need to enable the shared-cache mode in SQLite mode before attempting to change the transaction isolation level" unless shared_cache?
+
+          Thread.current.thread_variable_set("read_uncommitted", @connection.get_first_value("PRAGMA read_uncommitted"))
+          @connection.read_uncommitted = true
+          begin_db_transaction
+        end
+
+        def begin_db_transaction #:nodoc:
+          log("begin transaction", "TRANSACTION") { @connection.transaction }
+        end
+
+        def commit_db_transaction #:nodoc:
+          log("commit transaction", "TRANSACTION") { @connection.commit }
+          reset_read_uncommitted
+        end
+
+        def exec_rollback_db_transaction #:nodoc:
+          log("rollback transaction", "TRANSACTION") { @connection.rollback }
+          reset_read_uncommitted
+        end
+
+        private
+          def reset_read_uncommitted
+            read_uncommitted = Thread.current.thread_variable_get("read_uncommitted")
+            return unless read_uncommitted
+
+            @connection.read_uncommitted = read_uncommitted
+          end
+
+          def execute_batch(statements, name = nil)
+            sql = combine_multi_statements(statements)
+
+            if preventing_writes? && write_query?(sql)
+              raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
+            end
+
+            materialize_transactions
+            mark_transaction_written_if_write(sql)
+
+            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_statement(table_name)
+            "DELETE FROM #{quote_table_name(table_name)}"
+          end
+      end
+    end
+  end
+end

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

@@ -13,11 +13,11 @@ module ActiveRecord
         end
 
         def quote_table_name(name)
-          @quoted_table_names[name] ||= super.gsub(".", "\".\"").freeze
+          self.class.quoted_table_names[name] ||= super.gsub(".", "\".\"").freeze
         end
 
         def quote_column_name(name)
-          @quoted_column_names[name] ||= %Q("#{super.gsub('"', '""')}").freeze
+          self.class.quoted_column_names[name] ||= %Q("#{super.gsub('"', '""')}")
         end
 
         def quoted_time(value)
@@ -30,23 +30,58 @@ module ActiveRecord
         end
 
         def quoted_true
-          ActiveRecord::ConnectionAdapters::SQLite3Adapter.represent_boolean_as_integer ? "1".freeze : "'t'".freeze
+          "1"
         end
 
         def unquoted_true
-          ActiveRecord::ConnectionAdapters::SQLite3Adapter.represent_boolean_as_integer ? 1 : "t".freeze
+          1
         end
 
         def quoted_false
-          ActiveRecord::ConnectionAdapters::SQLite3Adapter.represent_boolean_as_integer ? "0".freeze : "'f'".freeze
+          "0"
         end
 
         def unquoted_false
-          ActiveRecord::ConnectionAdapters::SQLite3Adapter.represent_boolean_as_integer ? 0 : "f".freeze
+          0
         end
 
-        private
+        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

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

@@ -3,8 +3,12 @@
 module ActiveRecord
   module ConnectionAdapters
     module SQLite3
-      class SchemaCreation < AbstractAdapter::SchemaCreation # :nodoc:
+      class SchemaCreation < SchemaCreation # :nodoc:
         private
+          def supports_index_using?
+            false
+          end
+
           def add_column_options!(sql, options)
             if options[:collation]
               sql << " COLLATE \"#{options[:collation]}\""

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

@@ -9,9 +9,9 @@ module ActiveRecord
           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_")
+            next if row["name"].start_with?("sqlite_")
 
-            index_sql = query_value(<<-SQL, "SCHEMA")
+            index_sql = query_value(<<~SQL, "SCHEMA")
               SELECT sql
               FROM sqlite_master
               WHERE name = #{quote(row['name'])} AND type = 'index'
@@ -21,19 +21,24 @@ module ActiveRecord
               WHERE name = #{quote(row['name'])} AND type = 'index'
             SQL
 
-            /\sWHERE\s+(?<where>.+)$/i =~ 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
 
-            # Add info on sort order for columns (only desc order is explicitly specified, asc is
-            # the default)
             orders = {}
-            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
-              }
+
+            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(
@@ -47,6 +52,61 @@ module ActiveRecord
           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, :validate)
+          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 check_constraints(table_name)
+          table_sql = query_value(<<-SQL, "SCHEMA")
+            SELECT sql
+            FROM sqlite_master
+            WHERE name = #{quote_table_name(table_name)} AND type = 'table'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name = #{quote_table_name(table_name)} AND type = 'table'
+          SQL
+
+          table_sql.to_s.scan(/CONSTRAINT\s+(?<name>\w+)\s+CHECK\s+\((?<expression>(:?[^()]|\(\g<expression>\))+)\)/i).map do |name, expression|
+            CheckConstraintDefinition.new(table_name, expression, name: name)
+          end
+        end
+
+        def add_check_constraint(table_name, expression, **options)
+          alter_table(table_name) do |definition|
+            definition.check_constraint(expression, **options)
+          end
+        end
+
+        def remove_check_constraint(table_name, expression = nil, **options)
+          check_constraints = check_constraints(table_name)
+          chk_name_to_delete = check_constraint_for!(table_name, expression: expression, **options).name
+          check_constraints.delete_if { |chk| chk.name == chk_name_to_delete }
+          alter_table(table_name, foreign_keys(table_name), check_constraints)
+        end
+
         def create_schema_dumper(options)
           SQLite3::SchemaDumper.create(self, options)
         end
@@ -56,8 +116,12 @@ module ActiveRecord
             SQLite3::SchemaCreation.new(self)
           end
 
-          def create_table_definition(*args)
-            SQLite3::TableDefinition.new(*args)
+          def create_table_definition(name, **options)
+            SQLite3::TableDefinition.new(self, name, **options)
+          end
+
+          def validate_index_length!(table_name, new_name, internal = false)
+            super unless internal
           end
 
           def new_column_from_field(table_name, field)
@@ -74,14 +138,14 @@ module ActiveRecord
               end
 
             type_metadata = fetch_type_metadata(field["type"])
-            Column.new(field["name"], default, type_metadata, field["notnull"].to_i == 0, table_name, nil, field["collation"])
+            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'".dup
+            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