activerecord 6.0.0

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

data/lib/active_record/connection_adapters/sqlite3_adapter.rb

@@ -0,0 +1,557 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/abstract_adapter"
+require "active_record/connection_adapters/statement_pool"
+require "active_record/connection_adapters/sqlite3/explain_pretty_printer"
+require "active_record/connection_adapters/sqlite3/quoting"
+require "active_record/connection_adapters/sqlite3/database_statements"
+require "active_record/connection_adapters/sqlite3/schema_creation"
+require "active_record/connection_adapters/sqlite3/schema_definitions"
+require "active_record/connection_adapters/sqlite3/schema_dumper"
+require "active_record/connection_adapters/sqlite3/schema_statements"
+
+gem "sqlite3", "~> 1.4"
+require "sqlite3"
+
+module ActiveRecord
+  module ConnectionHandling # :nodoc:
+    def sqlite3_connection(config)
+      config = config.symbolize_keys
+
+      # Require database.
+      unless config[:database]
+        raise ArgumentError, "No database file specified. Missing argument: database"
+      end
+
+      # Allow database path relative to Rails.root, but only if the database
+      # path is not the special path that tells sqlite to build a database only
+      # in memory.
+      if ":memory:" != config[:database]
+        config[:database] = File.expand_path(config[:database], Rails.root) if defined?(Rails.root)
+        dirname = File.dirname(config[:database])
+        Dir.mkdir(dirname) unless File.directory?(dirname)
+      end
+
+      db = SQLite3::Database.new(
+        config[:database].to_s,
+        config.merge(results_as_hash: true)
+      )
+
+      ConnectionAdapters::SQLite3Adapter.new(db, logger, nil, config)
+    rescue Errno::ENOENT => error
+      if error.message.include?("No such file or directory")
+        raise ActiveRecord::NoDatabaseError
+      else
+        raise
+      end
+    end
+  end
+
+  module ConnectionAdapters #:nodoc:
+    # The SQLite3 adapter works SQLite 3.6.16 or newer
+    # with the sqlite3-ruby drivers (available as gem from https://rubygems.org/gems/sqlite3).
+    #
+    # Options:
+    #
+    # * <tt>:database</tt> - Path to the database file.
+    class SQLite3Adapter < AbstractAdapter
+      ADAPTER_NAME = "SQLite"
+
+      include SQLite3::Quoting
+      include SQLite3::SchemaStatements
+      include SQLite3::DatabaseStatements
+
+      NATIVE_DATABASE_TYPES = {
+        primary_key:  "integer PRIMARY KEY AUTOINCREMENT NOT NULL",
+        string:       { name: "varchar" },
+        text:         { name: "text" },
+        integer:      { name: "integer" },
+        float:        { name: "float" },
+        decimal:      { name: "decimal" },
+        datetime:     { name: "datetime" },
+        time:         { name: "time" },
+        date:         { name: "date" },
+        binary:       { name: "blob" },
+        boolean:      { name: "boolean" },
+        json:         { name: "json" },
+      }
+
+      def self.represent_boolean_as_integer=(value) # :nodoc:
+        if value == false
+          raise "`.represent_boolean_as_integer=` is now always true, so make sure your application can work with it and remove this settings."
+        end
+
+        ActiveSupport::Deprecation.warn(
+          "`.represent_boolean_as_integer=` is now always true, so setting this is deprecated and will be removed in Rails 6.1."
+        )
+      end
+
+      class StatementPool < ConnectionAdapters::StatementPool # :nodoc:
+        private
+          def dealloc(stmt)
+            stmt.close unless stmt.closed?
+          end
+      end
+
+      def initialize(connection, logger, connection_options, config)
+        super(connection, logger, config)
+        configure_connection
+      end
+
+      def self.database_exists?(config)
+        config = config.symbolize_keys
+        if config[:database] == ":memory:"
+          return true
+        else
+          database_file = defined?(Rails.root) ? File.expand_path(config[:database], Rails.root) : config[:database]
+          File.exist?(database_file)
+        end
+      end
+
+      def supports_ddl_transactions?
+        true
+      end
+
+      def supports_savepoints?
+        true
+      end
+
+      def supports_partial_index?
+        true
+      end
+
+      def supports_expression_index?
+        database_version >= "3.9.0"
+      end
+
+      def requires_reloading?
+        true
+      end
+
+      def supports_foreign_keys?
+        true
+      end
+
+      def supports_views?
+        true
+      end
+
+      def supports_datetime_with_precision?
+        true
+      end
+
+      def supports_json?
+        true
+      end
+
+      def supports_insert_on_conflict?
+        database_version >= "3.24.0"
+      end
+      alias supports_insert_on_duplicate_skip? supports_insert_on_conflict?
+      alias supports_insert_on_duplicate_update? supports_insert_on_conflict?
+      alias supports_insert_conflict_target? supports_insert_on_conflict?
+
+      def active?
+        !@connection.closed?
+      end
+
+      def reconnect!
+        super
+        connect if @connection.closed?
+      end
+
+      # Disconnects from the database if already connected. Otherwise, this
+      # method does nothing.
+      def disconnect!
+        super
+        @connection.close rescue nil
+      end
+
+      def supports_index_sort_order?
+        true
+      end
+
+      # Returns 62. SQLite supports index names up to 64
+      # characters. The rest is used by Rails internally to perform
+      # temporary rename operations
+      def allowed_index_name_length
+        index_name_length - 2
+      end
+
+      def native_database_types #:nodoc:
+        NATIVE_DATABASE_TYPES
+      end
+
+      # Returns the current database encoding format as a string, eg: 'UTF-8'
+      def encoding
+        @connection.encoding.to_s
+      end
+
+      def supports_explain?
+        true
+      end
+
+      def supports_lazy_transactions?
+        true
+      end
+
+      # REFERENTIAL INTEGRITY ====================================
+
+      def disable_referential_integrity # :nodoc:
+        old_foreign_keys = query_value("PRAGMA foreign_keys")
+        old_defer_foreign_keys = query_value("PRAGMA defer_foreign_keys")
+
+        begin
+          execute("PRAGMA defer_foreign_keys = ON")
+          execute("PRAGMA foreign_keys = OFF")
+          yield
+        ensure
+          execute("PRAGMA defer_foreign_keys = #{old_defer_foreign_keys}")
+          execute("PRAGMA foreign_keys = #{old_foreign_keys}")
+        end
+      end
+
+      #--
+      # DATABASE STATEMENTS ======================================
+      #++
+      def explain(arel, binds = [])
+        sql = "EXPLAIN QUERY PLAN #{to_sql(arel, binds)}"
+        SQLite3::ExplainPrettyPrinter.new.pp(exec_query(sql, "EXPLAIN", []))
+      end
+
+      # SCHEMA STATEMENTS ========================================
+
+      def primary_keys(table_name) # :nodoc:
+        pks = table_structure(table_name).select { |f| f["pk"] > 0 }
+        pks.sort_by { |f| f["pk"] }.map { |f| f["name"] }
+      end
+
+      def remove_index(table_name, options = {}) #:nodoc:
+        index_name = index_name_for_remove(table_name, options)
+        exec_query "DROP INDEX #{quote_column_name(index_name)}"
+      end
+
+      # Renames a table.
+      #
+      # Example:
+      #   rename_table('octopuses', 'octopi')
+      def rename_table(table_name, new_name)
+        exec_query "ALTER TABLE #{quote_table_name(table_name)} RENAME TO #{quote_table_name(new_name)}"
+        rename_table_indexes(table_name, new_name)
+      end
+
+      def add_column(table_name, column_name, type, options = {}) #:nodoc:
+        if invalid_alter_table_type?(type, options)
+          alter_table(table_name) do |definition|
+            definition.column(column_name, type, options)
+          end
+        else
+          super
+        end
+      end
+
+      def remove_column(table_name, column_name, type = nil, options = {}) #:nodoc:
+        alter_table(table_name) do |definition|
+          definition.remove_column column_name
+          definition.foreign_keys.delete_if do |_, fk_options|
+            fk_options[:column] == column_name.to_s
+          end
+        end
+      end
+
+      def change_column_default(table_name, column_name, default_or_changes) #:nodoc:
+        default = extract_new_default_value(default_or_changes)
+
+        alter_table(table_name) do |definition|
+          definition[column_name].default = default
+        end
+      end
+
+      def change_column_null(table_name, column_name, null, default = nil) #:nodoc:
+        unless null || default.nil?
+          exec_query("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL")
+        end
+        alter_table(table_name) do |definition|
+          definition[column_name].null = null
+        end
+      end
+
+      def change_column(table_name, column_name, type, options = {}) #:nodoc:
+        alter_table(table_name) do |definition|
+          definition[column_name].instance_eval do
+            self.type    = type
+            self.limit   = options[:limit] if options.include?(:limit)
+            self.default = options[:default] if options.include?(:default)
+            self.null    = options[:null] if options.include?(:null)
+            self.precision = options[:precision] if options.include?(:precision)
+            self.scale = options[:scale] if options.include?(:scale)
+            self.collation = options[:collation] if options.include?(:collation)
+          end
+        end
+      end
+
+      def rename_column(table_name, column_name, new_column_name) #:nodoc:
+        column = column_for(table_name, column_name)
+        alter_table(table_name, rename: { column.name => new_column_name.to_s })
+        rename_column_indexes(table_name, column.name, new_column_name)
+      end
+
+      def add_reference(table_name, ref_name, **options) # :nodoc:
+        super(table_name, ref_name, type: :integer, **options)
+      end
+      alias :add_belongs_to :add_reference
+
+      def foreign_keys(table_name)
+        fk_info = exec_query("PRAGMA foreign_key_list(#{quote(table_name)})", "SCHEMA")
+        fk_info.map do |row|
+          options = {
+            column: row["from"],
+            primary_key: row["to"],
+            on_delete: extract_foreign_key_action(row["on_delete"]),
+            on_update: extract_foreign_key_action(row["on_update"])
+          }
+          ForeignKeyDefinition.new(table_name, row["table"], options)
+        end
+      end
+
+      def build_insert_sql(insert) # :nodoc:
+        sql = +"INSERT #{insert.into} #{insert.values_list}"
+
+        if insert.skip_duplicates?
+          sql << " ON CONFLICT #{insert.conflict_target} DO NOTHING"
+        elsif insert.update_duplicates?
+          sql << " ON CONFLICT #{insert.conflict_target} DO UPDATE SET "
+          sql << insert.updatable_columns.map { |column| "#{column}=excluded.#{column}" }.join(",")
+        end
+
+        sql
+      end
+
+      def get_database_version # :nodoc:
+        SQLite3Adapter::Version.new(query_value("SELECT sqlite_version(*)"))
+      end
+
+      def check_version # :nodoc:
+        if database_version < "3.8.0"
+          raise "Your version of SQLite (#{database_version}) is too old. Active Record supports SQLite >= 3.8."
+        end
+      end
+
+      private
+        # See https://www.sqlite.org/limits.html,
+        # the default value is 999 when not configured.
+        def bind_params_length
+          999
+        end
+
+        def initialize_type_map(m = type_map)
+          super
+          register_class_with_limit m, %r(int)i, SQLite3Integer
+        end
+
+        def table_structure(table_name)
+          structure = exec_query("PRAGMA table_info(#{quote_table_name(table_name)})", "SCHEMA")
+          raise(ActiveRecord::StatementInvalid, "Could not find table '#{table_name}'") if structure.empty?
+          table_structure_with_collation(table_name, structure)
+        end
+        alias column_definitions table_structure
+
+        # See: https://www.sqlite.org/lang_altertable.html
+        # SQLite has an additional restriction on the ALTER TABLE statement
+        def invalid_alter_table_type?(type, options)
+          type.to_sym == :primary_key || options[:primary_key]
+        end
+
+        def alter_table(table_name, foreign_keys = foreign_keys(table_name), **options)
+          altered_table_name = "a#{table_name}"
+
+          caller = lambda do |definition|
+            rename = options[:rename] || {}
+            foreign_keys.each do |fk|
+              if column = rename[fk.options[:column]]
+                fk.options[:column] = column
+              end
+              to_table = strip_table_name_prefix_and_suffix(fk.to_table)
+              definition.foreign_key(to_table, fk.options)
+            end
+
+            yield definition if block_given?
+          end
+
+          transaction do
+            disable_referential_integrity do
+              move_table(table_name, altered_table_name, options.merge(temporary: true))
+              move_table(altered_table_name, table_name, &caller)
+            end
+          end
+        end
+
+        def move_table(from, to, options = {}, &block)
+          copy_table(from, to, options, &block)
+          drop_table(from)
+        end
+
+        def copy_table(from, to, options = {})
+          from_primary_key = primary_key(from)
+          options[:id] = false
+          create_table(to, options) do |definition|
+            @definition = definition
+            if from_primary_key.is_a?(Array)
+              @definition.primary_keys from_primary_key
+            end
+            columns(from).each do |column|
+              column_name = options[:rename] ?
+                (options[:rename][column.name] ||
+                 options[:rename][column.name.to_sym] ||
+                 column.name) : column.name
+
+              @definition.column(column_name, column.type,
+                limit: column.limit, default: column.default,
+                precision: column.precision, scale: column.scale,
+                null: column.null, collation: column.collation,
+                primary_key: column_name == from_primary_key
+              )
+            end
+
+            yield @definition if block_given?
+          end
+          copy_table_indexes(from, to, options[:rename] || {})
+          copy_table_contents(from, to,
+            @definition.columns.map(&:name),
+            options[:rename] || {})
+        end
+
+        def copy_table_indexes(from, to, rename = {})
+          indexes(from).each do |index|
+            name = index.name
+            if to == "a#{from}"
+              name = "t#{name}"
+            elsif from == "a#{to}"
+              name = name[1..-1]
+            end
+
+            columns = index.columns
+            if columns.is_a?(Array)
+              to_column_names = columns(to).map(&:name)
+              columns = columns.map { |c| rename[c] || c }.select do |column|
+                to_column_names.include?(column)
+              end
+            end
+
+            unless columns.empty?
+              # index name can't be the same
+              opts = { name: name.gsub(/(^|_)(#{from})_/, "\\1#{to}_"), internal: true }
+              opts[:unique] = true if index.unique
+              opts[:where] = index.where if index.where
+              add_index(to, columns, opts)
+            end
+          end
+        end
+
+        def copy_table_contents(from, to, columns, rename = {})
+          column_mappings = Hash[columns.map { |name| [name, name] }]
+          rename.each { |a| column_mappings[a.last] = a.first }
+          from_columns = columns(from).collect(&:name)
+          columns = columns.find_all { |col| from_columns.include?(column_mappings[col]) }
+          from_columns_to_copy = columns.map { |col| column_mappings[col] }
+          quoted_columns = columns.map { |col| quote_column_name(col) } * ","
+          quoted_from_columns = from_columns_to_copy.map { |col| quote_column_name(col) } * ","
+
+          exec_query("INSERT INTO #{quote_table_name(to)} (#{quoted_columns})
+                     SELECT #{quoted_from_columns} FROM #{quote_table_name(from)}")
+        end
+
+        def translate_exception(exception, message:, sql:, binds:)
+          case exception.message
+          # SQLite 3.8.2 returns a newly formatted error message:
+          #   UNIQUE constraint failed: *table_name*.*column_name*
+          # Older versions of SQLite return:
+          #   column *column_name* is not unique
+          when /column(s)? .* (is|are) not unique/, /UNIQUE constraint failed: .*/
+            RecordNotUnique.new(message, sql: sql, binds: binds)
+          when /.* may not be NULL/, /NOT NULL constraint failed: .*/
+            NotNullViolation.new(message, sql: sql, binds: binds)
+          when /FOREIGN KEY constraint failed/i
+            InvalidForeignKey.new(message, sql: sql, binds: binds)
+          else
+            super
+          end
+        end
+
+        COLLATE_REGEX = /.*\"(\w+)\".*collate\s+\"(\w+)\".*/i.freeze
+
+        def table_structure_with_collation(table_name, basic_structure)
+          collation_hash = {}
+          sql = <<~SQL
+            SELECT sql FROM
+              (SELECT * FROM sqlite_master UNION ALL
+               SELECT * FROM sqlite_temp_master)
+            WHERE type = 'table' AND name = #{quote(table_name)}
+          SQL
+
+          # Result will have following sample string
+          # CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+          #                       "password_digest" varchar COLLATE "NOCASE");
+          result = exec_query(sql, "SCHEMA").first
+
+          if result
+            # Splitting with left parentheses and discarding the first part will return all
+            # columns separated with comma(,).
+            columns_string = result["sql"].split("(", 2).last
+
+            columns_string.split(",").each do |column_string|
+              # This regex will match the column name and collation type and will save
+              # the value in $1 and $2 respectively.
+              collation_hash[$1] = $2 if COLLATE_REGEX =~ column_string
+            end
+
+            basic_structure.map! do |column|
+              column_name = column["name"]
+
+              if collation_hash.has_key? column_name
+                column["collation"] = collation_hash[column_name]
+              end
+
+              column
+            end
+          else
+            basic_structure.to_a
+          end
+        end
+
+        def arel_visitor
+          Arel::Visitors::SQLite.new(self)
+        end
+
+        def build_statement_pool
+          StatementPool.new(self.class.type_cast_config_to_integer(@config[:statement_limit]))
+        end
+
+        def connect
+          @connection = ::SQLite3::Database.new(
+            @config[:database].to_s,
+            @config.merge(results_as_hash: true)
+          )
+          configure_connection
+        end
+
+        def configure_connection
+          @connection.busy_timeout(self.class.type_cast_config_to_integer(@config[:timeout])) if @config[:timeout]
+
+          execute("PRAGMA foreign_keys = ON", "SCHEMA")
+        end
+
+        class SQLite3Integer < Type::Integer # :nodoc:
+          private
+            def _limit
+              # INTEGER storage class can be stored 8 bytes value.
+              # See https://www.sqlite.org/datatype3.html#storage_classes_and_datatypes
+              limit || 8
+            end
+        end
+
+        ActiveRecord::Type.register(:integer, SQLite3Integer, adapter: :sqlite3)
+    end
+    ActiveSupport.run_load_hooks(:active_record_sqlite3adapter, SQLite3Adapter)
+  end
+end