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
- NATIVE_DATABASE_TYPES
Public Class Methods
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 112
def initialize(connection, logger, connection_options, config)
super(connection, logger)
@active = nil
@statements = StatementPool.new(@connection,
self.class.type_cast_config_to_integer(config.fetch(:statement_limit) { 1000 }))
@config = config
@visitor = Arel::Visitors::SQLite.new self
if self.class.type_cast_config_to_boolean(config.fetch(:prepared_statements) { true })
@prepared_statements = true
else
@prepared_statements = false
end
end Public Instance Methods
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 164 def active? @active != false end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 188 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 463
def change_column_null(table_name, column_name, null, default = nil)
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 # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 177 def clear_cache! @statements.clear end
Clears the prepared statements cache.
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 170 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 197 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 306 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 276
def exec_query(sql, name = nil, binds = [])
type_casted_binds = binds.map { |col, val|
[col, type_cast(val, col)]
}
log(sql, name, type_casted_binds) do
# Don't cache statements if they are not prepared
if without_prepared_statement?(binds)
stmt = @connection.prepare(sql)
begin
cols = stmt.columns
records = stmt.to_a
ensure
stmt.close
end
stmt = records
else
cache = @statements[sql] ||= {
:stmt => @connection.prepare(sql)
}
stmt = cache[:stmt]
cols = cache[:cols] ||= stmt.columns
stmt.reset!
stmt.bind_params type_casted_binds.map { |_, val| val }
end
ActiveRecord::Result.new(cols, stmt.to_a)
end
end # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 257
def explain(arel, binds = [])
sql = "EXPLAIN QUERY PLAN #{to_sql(arel, binds)}"
ExplainPrettyPrinter.new.pp(exec_query(sql, 'EXPLAIN', []))
end # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 312 def last_inserted_id(result) @connection.last_insert_row_id end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 235 def quote_table_name_for_assignment(table, attr) quote_column_name(attr) end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 430
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 156 def requires_reloading? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 336 def select_rows(sql, name = nil, binds = []) exec_query(sql, name, binds).rows end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 129 def supports_ddl_transactions? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 201 def supports_explain? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 181 def supports_index_sort_order? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 137 def supports_partial_index? sqlite_version >= '3.8.0' end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 133 def supports_savepoints? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 143 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 160 def supports_views? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 368 def table_exists?(table_name) table_name && tables(nil, table_name).any? end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 437 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
Protected Instance Methods
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 494 def initialize_type_map(m) super m.register_type(/binary/i, SQLite3Binary.new) end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 594
def sqlite_version
@sqlite_version ||= SQLite3Adapter::Version.new(select_value('select sqlite_version(*)'))
end # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 499
def table_structure(table_name)
structure = exec_query("PRAGMA table_info(#{quote_table_name(table_name)})", 'SCHEMA').to_hash
raise(ActiveRecord::StatementInvalid, "Could not find table '#{table_name}'") if structure.empty?
structure
end # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 598
def translate_exception(exception, message)
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, exception)
else
super
end
end
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.