Skip to Content Skip to Search

Active Record SQLite3 Adapter

The SQLite3 adapter works with the sqlite3-ruby drivers (available as gem from rubygems.org/gems/sqlite3).

Options:

  • :database - Path to the database file.

Methods
A
D
E
F
N
R
S
U
Included Modules

Constants

ADAPTER_NAME = "SQLite"
 
COLLATE_REGEX = /.*"(\w+)".*collate\s+"(\w+)".*/i
 
EXTENDED_TYPE_MAPS = Concurrent::Map.new
 
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" }, }
 
PRIMARY_KEY_AUTOINCREMENT_REGEX = /.*"(\w+)".+PRIMARY KEY AUTOINCREMENT/i
 
TYPE_MAP = Type::TypeMap.new.tap { |m| initialize_type_map(m) }
 

Class Public methods

dbconsole(config, options = {})

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 51
def dbconsole(config, options = {})
  args = []

  args << "-#{options[:mode]}" if options[:mode]
  args << "-header" if options[:header]
  args << File.expand_path(config.database, Rails.respond_to?(:root) ? Rails.root : nil)

  find_cmd_and_exec("sqlite3", *args)
end

new(...)

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 100
def initialize(...)
  super

  @memory_database = false
  case @config[:database].to_s
  when ""
    raise ArgumentError, "No database file specified. Missing argument: database"
  when ":memory:"
    @memory_database = true
  when /\Afile:/
  else
    # Otherwise we have a path relative to Rails.root
    @config[:database] = File.expand_path(@config[:database], Rails.root) if defined?(Rails.root)
    dirname = File.dirname(@config[:database])
    unless File.directory?(dirname)
      begin
        Dir.mkdir(dirname)
      rescue Errno::ENOENT => error
        if error.message.include?("No such file or directory")
          raise ActiveRecord::NoDatabaseError.new(connection_pool: @pool)
        else
          raise
        end
      end
    end
  end

  @config[:strict] = ConnectionAdapters::SQLite3Adapter.strict_strings_by_default unless @config.key?(:strict)
  @connection_parameters = @config.merge(database: @config[:database].to_s, results_as_hash: true)
  @use_insert_returning = @config.key?(:insert_returning) ? self.class.type_cast_config_to_boolean(@config[:insert_returning]) : true
end

new_client(config)

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 41
def new_client(config)
  ::SQLite3::Database.new(config[:database].to_s, config)
rescue Errno::ENOENT => error
  if error.message.include?("No such file or directory")
    raise ActiveRecord::NoDatabaseError
  else
    raise
  end
end

strict_strings_by_default

Configure the SQLite3Adapter to be used in a strict strings mode. This will disable double-quoted string literals, because otherwise typos can silently go unnoticed. For example, it is possible to create an index for a non existing column. If you wish to enable this mode you can add the following line to your application.rb file:

config.active_record.sqlite3_adapter_strict_strings_by_default = true

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 74
class_attribute :strict_strings_by_default, default: false

Instance Public methods

active?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 199
def active?
  @raw_connection && !@raw_connection.closed?
end

add_timestamps(table_name, **options)

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 350
def add_timestamps(table_name, **options)
  options[:null] = false if options[:null].nil?

  if !options.key?(:precision)
    options[:precision] = 6
  end

  alter_table(table_name) do |definition|
    definition.column :created_at, :datetime, **options
    definition.column :updated_at, :datetime, **options
  end
end

database_exists?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 132
def database_exists?
  @config[:database] == ":memory:" || File.exist?(@config[:database].to_s)
end

disconnect!()

Disconnects from the database if already connected. Otherwise, this method does nothing.

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 211
def disconnect!
  super

  @raw_connection&.close rescue nil
  @raw_connection = nil
end

encoding()

Returns the current database encoding format as a string, e.g. ‘UTF-8’

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 227
def encoding
  any_raw_connection.encoding.to_s
end

foreign_keys(table_name)

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 368
def foreign_keys(table_name)
  # SQLite returns 1 row for each column of composite foreign keys.
  fk_info = internal_exec_query("PRAGMA foreign_key_list(#{quote(table_name)})", "SCHEMA")
  grouped_fk = fk_info.group_by { |row| row["id"] }.values.each { |group| group.sort_by! { |row| row["seq"] } }
  grouped_fk.map do |group|
    row = group.first
    options = {
      on_delete: extract_foreign_key_action(row["on_delete"]),
      on_update: extract_foreign_key_action(row["on_update"])
    }

    if group.one?
      options[:column] = row["from"]
      options[:primary_key] = row["to"]
    else
      options[:column] = group.map { |row| row["from"] }
      options[:primary_key] = group.map { |row| row["to"] }
    end
    ForeignKeyDefinition.new(table_name, row["table"], options)
  end
end

rename_table(table_name, new_name, **options)

Renames a table.

Example:

rename_table('octopuses', 'octopi')

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 284
def rename_table(table_name, new_name, **options)
  validate_table_length!(new_name) unless options[:_uses_legacy_table_name]
  schema_cache.clear_data_source_cache!(table_name.to_s)
  schema_cache.clear_data_source_cache!(new_name.to_s)
  exec_query "ALTER TABLE #{quote_table_name(table_name)} RENAME TO #{quote_table_name(new_name)}"
  rename_table_indexes(table_name, new_name)
end

requires_reloading?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 156
def requires_reloading?
  true
end

supports_check_constraints?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 164
def supports_check_constraints?
  true
end

supports_common_table_expressions?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 180
def supports_common_table_expressions?
  database_version >= "3.8.3"
end

supports_concurrent_connections?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 195
def supports_concurrent_connections?
  !@memory_database
end

supports_datetime_with_precision?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 172
def supports_datetime_with_precision?
  true
end

supports_ddl_transactions?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 136
def supports_ddl_transactions?
  true
end

supports_explain?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 231
def supports_explain?
  true
end

supports_expression_index?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 152
def supports_expression_index?
  database_version >= "3.9.0"
end

supports_foreign_keys?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 160
def supports_foreign_keys?
  true
end

supports_index_sort_order?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 218
def supports_index_sort_order?
  true
end

supports_insert_conflict_target?()

Alias for: supports_insert_on_conflict?

supports_insert_on_conflict?()

Also aliased as: supports_insert_on_duplicate_skip?, supports_insert_on_duplicate_update?, supports_insert_conflict_target?

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 188
def supports_insert_on_conflict?
  database_version >= "3.24.0"
end

supports_insert_on_duplicate_skip?()

Alias for: supports_insert_on_conflict?

supports_insert_on_duplicate_update?()

Alias for: supports_insert_on_conflict?

supports_insert_returning?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 184
def supports_insert_returning?
  database_version >= "3.35.0"
end

supports_json?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 176
def supports_json?
  true
end

supports_lazy_transactions?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 235
def supports_lazy_transactions?
  true
end

supports_partial_index?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 148
def supports_partial_index?
  true
end

supports_savepoints?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 140
def supports_savepoints?
  true
end

supports_transaction_isolation?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 144
def supports_transaction_isolation?
  true
end

supports_views?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 168
def supports_views?
  true
end

use_insert_returning?()

Source: show | on GitHub 

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 413
def use_insert_returning?
  @use_insert_returning
end