On this page
class ActiveRecord::ConnectionAdapters::SQLite3Adapter
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.
Constants
- ADAPTER_NAME
- COLLATE_REGEX
- NATIVE_DATABASE_TYPES
Public Class Methods
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 95
def initialize(connection, logger, connection_options, config)
super(connection, logger, config)
@active = nil
@statements = StatementPool.new(self.class.type_cast_config_to_integer(config[:statement_limit]))
configure_connection
end
Public Instance Methods
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 142
def active?
@active != false
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 166
def allowed_index_name_length
index_name_length - 2
end
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 155
def clear_cache!
@statements.clear
end
Clears the prepared statements cache.
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 148
def disconnect!
super
@active = false
@connection.close rescue nil
end
Disconnects from the database if already connected. Otherwise, this method does nothing.
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 175
def encoding
@connection.encoding.to_s
end
Returns the current database encoding format as a string, eg: 'UTF-8'
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 238
def exec_delete(sql, name = "SQL", binds = [])
exec_query(sql, name, binds)
@connection.changes
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 205
def exec_query(sql, name = nil, binds = [], prepare: false)
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
cache = @statements[sql] ||= {
stmt: @connection.prepare(sql)
}
stmt = cache[:stmt]
cols = cache[:cols] ||= stmt.columns
stmt.reset!
stmt.bind_params(type_casted_binds)
records = stmt.to_a
end
ActiveRecord::Result.new(cols, records)
end
end
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 200
def explain(arel, binds = [])
sql = "EXPLAIN QUERY PLAN #{to_sql(arel, binds)}"
SQLite3::ExplainPrettyPrinter.new.pp(exec_query(sql, "EXPLAIN", []))
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 400
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
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 244
def last_inserted_id(result)
@connection.last_insert_row_id
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 270
def new_column_from_field(table_name, field) # :nondoc:
case field["dflt_value"]
when /^null$/i
field["dflt_value"] = nil
when /^'(.*)'$/m
field["dflt_value"] = $1.gsub("''", "'")
when /^"(.*)"$/m
field["dflt_value"] = $1.gsub('""', '"')
end
collation = field["collation"]
sql_type = field["type"]
type_metadata = fetch_type_metadata(sql_type)
new_column(field["name"], field["dflt_value"], type_metadata, field["notnull"].to_i == 0, table_name, nil, collation)
end
SCHEMA STATEMENTS ========================================
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 331
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
Renames a table.
Example:
rename_table('octopuses', 'octopi')
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 122
def requires_reloading?
true
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 134
def supports_datetime_with_precision?
true
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 104
def supports_ddl_transactions?
true
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 179
def supports_explain?
true
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 126
def supports_foreign_keys_in_create?
sqlite_version >= "3.6.19"
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 159
def supports_index_sort_order?
true
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 138
def supports_multi_insert?
sqlite_version >= "3.7.11"
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 112
def supports_partial_index?
sqlite_version >= "3.8.0"
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 108
def supports_savepoints?
true
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 118
def supports_statement_cache?
true
end
Returns true, since this connection adapter supports prepared statement caching.
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 130
def supports_views?
true
end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 338
def valid_alter_table_type?(type)
type.to_sym != :primary_key
end
See: www.sqlite.org/lang_altertable.html SQLite has an additional restriction on the ALTER TABLE statement
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.