Active Record `SQLite3` 适配器

ADAPTER_NAME	=	"SQLite"

COLLATE_REGEX	=	/."(\w+)".collate\s+"(\w+)".*/i

DEFAULT_PRAGMAS	=	{ "foreign_keys" => true, "journal_mode" => :wal, "synchronous" => :normal, "mmap_size" => 134217728, # 128 兆字节 "journal_size_limit" => 67108864, # 64 兆字节 "cache_size" => 2000 }

DEFERRABLE_REGEX	=	/DEFERRABLE INITIALLY (\w+)/

EXTENDED_TYPE_MAPS	=	Concurrent::Map.new

FINAL_CLOSE_PARENS_REGEX	=	/\);*\z/

FK_REGEX	=	/.*FOREIGN KEY\s+$"(\w+)"$\s+REFERENCES\s+"(\w+)"\s+$"(\w+)"$/

GENERATED_ALWAYS_AS_REGEX	=	/.*"(\w+)".+GENERATED ALWAYS AS $(.+)$ (?:STORED\|VIRTUAL)/i

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) }

UNQUOTED_OPEN_PARENS_REGEX	=	/\((?![^'"]['"][^'"]$)/

VIRTUAL_TABLE_REGEX	=	/USING\s+(\w+)\s*$(.+)$/i

类公共方法

dbconsole(config, options = {}) 链接

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 44
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(ActiveRecord.database_cli[:sqlite], *args)
end

new(...) 链接

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 102
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

  @last_affected_rows = nil
  @previous_read_uncommitted = nil
  @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,
    default_transaction_mode: :immediate,
  )
end

new_client(config) 链接

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 34
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 链接

配置 SQLite3Adapter 在严格字符串模式下使用。这将禁用双引号字符串文字，因为否则打字错误会默默地被忽略。例如，可以为不存在的列创建索引。如果您想启用此模式，可以将以下行添加到您的 application.rb 文件中

config.active_record.sqlite3_adapter_strict_strings_by_default = true

源代码：显示 | 在 GitHub 上

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

实例公共方法

active?() 链接

别名：connected?

add_timestamps(table_name, **options) 链接

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 392
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

connected?() 链接

也称为：active?

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 206
def connected?
  !(@raw_connection.nil? || @raw_connection.closed?)
end

create_virtual_table(table_name, module_name, values) 链接

创建一个虚拟表

示例

create_virtual_table :emails, :fts5, ['sender', 'title',' body']

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 308
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

database_exists?() 链接

源代码：显示 | 在 GitHub 上

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

disconnect!() 链接

如果已连接，则断开与数据库的连接。否则，此方法不执行任何操作。

源代码：显示 | 在 GitHub 上

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

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

drop_virtual_table(table_name, module_name, values, **options) 链接

删除虚拟表

虽然此命令忽略 module_name 和 values，但在迁移的 change 方法中提供它们可能会有所帮助，以便它可以被还原。在这种情况下，module_name、values 和 options 将被 create_virtual_table 使用。

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 317
def drop_virtual_table(table_name, module_name, values, **options)
  drop_table(table_name)
end

encoding() 链接

将当前数据库编码格式作为字符串返回，例如 ‘UTF-8’

源代码：显示 | 在 GitHub 上

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

foreign_keys(table_name) 链接

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 412
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

rename_table(table_name, new_name, **options) 链接

重命名表。

示例

rename_table('octopuses', 'octopi')

源代码：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 325
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

requires_reloading?() 链接

源代码：显示 | 在 GitHub 上

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

supports_check_constraints?() 链接

源代码：显示 | 在 GitHub 上

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

supports_common_table_expressions?() 链接

源代码：显示 | 在 GitHub 上

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

supports_concurrent_connections?() 链接

源代码：显示 | 在 GitHub 上

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

supports_datetime_with_precision?() 链接

源代码：显示 | 在 GitHub 上

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

supports_ddl_transactions?() 链接

来源：显示 | 在 GitHub 上

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

supports_deferrable_constraints?() 链接

来源：显示 | 在 GitHub 上

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

supports_explain?() 链接

来源：显示 | 在 GitHub 上

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

supports_expression_index?() 链接

来源：显示 | 在 GitHub 上

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

supports_foreign_keys?() 链接

来源：显示 | 在 GitHub 上

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

supports_index_sort_order?() 链接

来源：显示 | 在 GitHub 上

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

supports_insert_conflict_target?() 链接

别名：supports_insert_on_conflict?

supports_insert_on_conflict?() 链接

也称为：supports_insert_on_duplicate_skip?, supports_insert_on_duplicate_update?, supports_insert_conflict_target?

来源：显示 | 在 GitHub 上

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

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

supports_json?() 链接

来源：显示 | 在 GitHub 上

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

supports_lazy_transactions?() 链接

来源：显示 | 在 GitHub 上

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

supports_partial_index?() 链接

来源：显示 | 在 GitHub 上

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

supports_savepoints?() 链接

来源：显示 | 在 GitHub 上

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

supports_transaction_isolation?() 链接

来源：显示 | 在 GitHub 上

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

supports_views?() 链接

来源：显示 | 在 GitHub 上

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

supports_virtual_columns?() 链接

来源：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 202
def supports_virtual_columns?
  database_version >= "3.31.0"
end

virtual_tables() 链接

返回定义的虚拟表列表

来源：显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 292
      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

类 ActiveRecord::ConnectionAdapters::SQLite3Adapter < ActiveRecord::ConnectionAdapters::AbstractAdapter

Active Record SQLite3 适配器

常量

类公共方法

dbconsole(config, options = {}) 链接

new(...) 链接

new_client(config) 链接

strict_strings_by_default 链接

实例公共方法

active?() 链接

add_timestamps(table_name, **options) 链接

connected?() 链接

create_virtual_table(table_name, module_name, values) 链接

database_exists?() 链接

disconnect!() 链接

drop_virtual_table(table_name, module_name, values, **options) 链接

encoding() 链接

foreign_keys(table_name) 链接

rename_table(table_name, new_name, **options) 链接

requires_reloading?() 链接

supports_check_constraints?() 链接

supports_common_table_expressions?() 链接

supports_concurrent_connections?() 链接

supports_datetime_with_precision?() 链接

supports_ddl_transactions?() 链接

supports_deferrable_constraints?() 链接

supports_explain?() 链接

supports_expression_index?() 链接

supports_foreign_keys?() 链接

supports_index_sort_order?() 链接

supports_insert_conflict_target?() 链接

supports_insert_on_conflict?() 链接

supports_insert_on_duplicate_skip?() 链接

supports_insert_on_duplicate_update?() 链接

supports_insert_returning?() 链接

supports_json?() 链接

supports_lazy_transactions?() 链接

supports_partial_index?() 链接

supports_savepoints?() 链接

supports_transaction_isolation?() 链接

supports_views?() 链接

supports_virtual_columns?() 链接

virtual_tables() 链接

Active Record `SQLite3` 适配器