edge badge

The SQLite3 adapter works SQLite 3.6.16 or newer 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
L
N
R
S
Included Modules
Constants
ADAPTER_NAME = "SQLite"
 
COLLATE_REGEX = /.*\"(\w+)\".*collate\s+\"(\w+)\".*/i.freeze
 
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" }, }
 
Class Public methods
new(connection, logger, connection_options, config)
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 96
def initialize(connection, logger, connection_options, config)
  super(connection, logger, config)
  configure_connection
end
Instance Public methods
active?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 144
def active?
  !@connection.closed?
end
allowed_index_name_length()

Returns 62. SQLite supports index names up to 64 characters. The rest is used by Rails internally to perform temporary rename operations

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 167
def allowed_index_name_length
  index_name_length - 2
end
disconnect!()

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

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 155
def disconnect!
  super
  @connection.close rescue nil
end
encoding()

Returns the current database encoding format as a string, eg: 'UTF-8'

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 176
def encoding
  @connection.encoding.to_s
end
exec_delete(sql, name = "SQL", binds = [])
Also aliased as: exec_update
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 256
def exec_delete(sql, name = "SQL", binds = [])
  exec_query(sql, name, binds)
  @connection.changes
end
exec_query(sql, name = nil, binds = [], prepare: false)
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 220
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
exec_update(sql, name = "SQL", binds = [])
Alias for: exec_delete
explain(arel, binds = [])
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 215
def explain(arel, binds = [])
  sql = "EXPLAIN QUERY PLAN #{to_sql(arel, binds)}"
  SQLite3::ExplainPrettyPrinter.new.pp(exec_query(sql, "EXPLAIN", []))
end
foreign_keys(table_name)
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 374
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
last_inserted_id(result)
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 262
def last_inserted_id(result)
  @connection.last_insert_row_id
end
reconnect!()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 148
def reconnect!
  super
  connect if @connection.closed?
end
rename_table(table_name, new_name)

Renames a table.

Example:

rename_table('octopuses', 'octopi')
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 308
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
requires_reloading?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 117
def requires_reloading?
  true
end
supports_datetime_with_precision?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 129
def supports_datetime_with_precision?
  true
end
supports_ddl_transactions?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 101
def supports_ddl_transactions?
  true
end
supports_explain?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 180
def supports_explain?
  true
end
supports_expression_index?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 113
def supports_expression_index?
  sqlite_version >= "3.9.0"
end
supports_foreign_keys?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 121
def supports_foreign_keys?
  true
end
supports_index_sort_order?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 160
def supports_index_sort_order?
  true
end
supports_insert_conflict_target?()
supports_insert_on_conflict?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 137
def supports_insert_on_conflict?
  sqlite_version >= "3.24.0"
end
supports_insert_on_duplicate_skip?()
supports_insert_on_duplicate_update?()
supports_json?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 133
def supports_json?
  true
end
supports_lazy_transactions?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 184
def supports_lazy_transactions?
  true
end
supports_partial_index?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 109
def supports_partial_index?
  true
end
supports_savepoints?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 105
def supports_savepoints?
  true
end
supports_views?()
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 125
def supports_views?
  true
end