класс ActiveRecord::ConnectionAdapters::SQLite3Adapter
Адаптер SQLite3 для Active Record
Адаптер SQLite3 работает с драйвером sqlite3.
Параметры
-
:database(String): путь в файловой системе к файлу базы данных. -
:statement_limit(Integer): максимальное количество подготовленных выражений, кэшируемых для каждого подключения к базе данных. (по умолчанию: 1000) -
:timeout(Integer): время ожидания блокировки в миллисекундах. (по умолчанию: без ожидания) -
:strict(логическое значение): включить или отключить строгий режим. Если режим включён, это запретит строковые литералы в двойных кавычках в инструкциях SQL. (по умолчанию: см.strict_strings_by_default) -
:extensions(Array): (требуется sqlite3 версии 2.4.0) каждый элемент задаёт расширение SQLite для загрузки в эту базу данных. Элементом может быть путь в файловой системе или имя класса, у которого есть метод.to_path, возвращающий путь в файловой системе к расширению. Подробнее см. в документации sqlite3-ruby.
Для драйвера SQLite3 могут быть доступны и другие параметры. См. документацию по методу SQLite3::Database.new.
Константы
- ADAPTER_NAME
- COLLATE_REGEX
- DEFAULT_PRAGMAS
- DEFERRABLE_REGEX
- EXTENDED_TYPE_MAPS
- FINAL_CLOSE_PARENS_REGEX
- FK_REGEX
- GENERATED_ALWAYS_AS_REGEX
- NATIVE_DATABASE_TYPES
- PRIMARY_KEY_AUTOINCREMENT_REGEX
- TYPE_MAP
- UNQUOTED_OPEN_PARENS_REGEX
- VIRTUAL_TABLE_REGEX
Открытые методы класса
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 60
def dbconsole(config, options = {})
args = []
args << "-#{options[:mode]}" if options[:mode]
args << "-header" if options[:header]
args << File.expand_path(config.database, defined?(Rails.root) ? Rails.root : nil)
find_cmd_and_exec(ActiveRecord.database_cli[:sqlite], *args)
end # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 129
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
FileUtils.mkdir_p(dirname)
rescue SystemCallError
raise ActiveRecord::NoDatabaseError.new(connection_pool: @pool)
end
end
end
@previous_read_uncommitted = nil
@config[:strict] = ConnectionAdapters::SQLite3Adapter.strict_strings_by_default unless @config.key?(:strict)
extensions = @config.fetch(:extensions, []).map do |extension|
extension.safe_constantize || extension
end
@connection_parameters = @config.merge(
database: @config[:database].to_s,
results_as_hash: true,
default_transaction_mode: :immediate,
extensions: extensions
)
end ActiveRecord::ConnectionAdapters::QueryCache::new # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 50
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 # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 94 class_attribute :strict_strings_by_default, default: false
Настраивает SQLite3Adapter для работы в режиме «строгих строк». Если режим включён, он запретит строковые литералы в двойных кавычках в инструкциях SQL, что поможет избежать некоторых опечаток, например создания индекса для несуществующего столбца. Значение по умолчанию — false.
Чтобы включить этот режим, добавьте следующую строку в файл application.rb:
config.active_record.sqlite3_adapter_strict_strings_by_default = true
Режим также можно настроить отдельно для каждой базы данных, задав параметр strict:.
Открытые методы экземпляра
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 242
def active?
if connected?
verified!
true
end
end # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 425
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 # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 238 def connected? !(@raw_connection.nil? || @raw_connection.closed?) end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 341
def create_virtual_table(table_name, module_name, values)
exec_query "CREATE VIRTUAL TABLE IF NOT EXISTS #{table_name} USING #{module_name} (#{values.join(", ")})"
end Создаёт виртуальную таблицу
Пример:
create_virtual_table :emails, :fts5, ['sender', 'title', 'body']
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 167 def database_exists? @config[:database] == ":memory:" || File.exist?(@config[:database].to_s) end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 253 def disconnect! super @raw_connection&.close rescue nil @raw_connection = nil end
Разрывает подключение к базе данных, если оно установлено. В противном случае метод ничего не делает.
ActiveRecord::ConnectionAdapters::AbstractAdapter#disconnect! # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 350 def drop_virtual_table(table_name, module_name, values, **options) drop_table(table_name) end
Удаляет виртуальную таблицу
Хотя эта команда игнорирует module_name и values, их полезно указать в методе change миграции, чтобы её можно было отменить. В этом случае module_name, values и options будут использованы методом create_virtual_table.
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 265 def encoding any_raw_connection.encoding.to_s end
Возвращает текущую кодировку базы данных в виде строки, например ‘UTF-8’
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 445
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")
# Deferred or immediate foreign keys can only be seen in the CREATE TABLE sql
fk_defs = table_structure_sql(table_name)
.select do |column_string|
column_string.start_with?("CONSTRAINT") &&
column_string.include?("FOREIGN KEY")
end
.to_h do |fk_string|
_, from, table, to = fk_string.match(FK_REGEX).to_a
_, mode = fk_string.match(DEFERRABLE_REGEX).to_a
deferred = mode&.downcase&.to_sym || false
[[table, from, to], deferred]
end
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"]),
deferrable: fk_defs[[row["table"], row["from"], row["to"]]]
}
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 # File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 358
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, **options)
end Переименовывает таблицу.
Пример:
rename_table('octopuses', 'octopi')
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 191 def requires_reloading? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 199 def supports_check_constraints? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 215 def supports_common_table_expressions? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 230 def supports_concurrent_connections? !@memory_database end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 207 def supports_datetime_with_precision? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 171 def supports_ddl_transactions? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 277 def supports_deferrable_constraints? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 269 def supports_explain? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 187 def supports_expression_index? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 195 def supports_foreign_keys? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 260 def supports_index_sort_order? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 223 def supports_insert_on_conflict? database_version >= "3.24.0" end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 219 def supports_insert_returning? database_version >= "3.35.0" end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 211 def supports_json? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 273 def supports_lazy_transactions? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 183 def supports_partial_index? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 175 def supports_savepoints? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 179 def supports_transaction_isolation? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 203 def supports_views? true end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 234 def supports_virtual_columns? database_version >= "3.31.0" end
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 325
def virtual_tables
query = <<~SQL
SELECT name, sql FROM sqlite_master WHERE sql LIKE 'CREATE VIRTUAL %';
SQL
exec_query(query, "SCHEMA").cast_values.each_with_object({}) do |row, memo|
table_name, sql = row[0], row[1]
_, module_name, arguments = sql.match(VIRTUAL_TABLE_REGEX).to_a
memo[table_name] = [module_name, arguments]
end.to_a
end Возвращает список определённых виртуальных таблиц
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.