Active Record SQLite3
轉接器
SQLite3
轉接器與 sqlite3-ruby 驅動程式(可從 rubygems.org/gems/sqlite3 以 gem 的形式取得)搭配使用。
選項
-
:database
- 資料庫檔案的路徑。
- A
- C
- D
- E
- F
- N
- R
- S
-
- strict_strings_by_default(預設使用嚴格字串模式),
- supports_check_constraints?(支援檢查約束?),
- supports_common_table_expressions?(支援通用表表達式?),
- supports_concurrent_connections?(支援並行連線?),
- supports_datetime_with_precision?(支援帶精度的日期時間?),
- supports_ddl_transactions?(支援 DDL 事務?),
- supports_deferrable_constraints?(支援可延遲約束?),
- supports_explain?(支援 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?(支援 JSON?),
- supports_lazy_transactions?(支援延遲事務?),
- supports_partial_index?(支援部分索引?),
- supports_savepoints?(支援儲存點?),
- supports_transaction_isolation?(支援事務隔離?),
- supports_views?(支援視圖?),
- supports_virtual_columns?(支援虛擬欄位?)
- V
常數
ADAPTER_NAME | = | "SQLite" |
COLLATE_REGEX | = | /.*"(\w+)".*collate\s+"(\w+)".*/i |
DEFAULT_PRAGMAS | = | { "foreign_keys" => true, "journal_mode" => :wal, "synchronous" => :normal, "mmap_size" => 134217728, # 128 MB "journal_size_limit" => 67108864, # 64 MB "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
實例公開方法
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?() 連結
來源:顯示 | 在 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_on_conflict?() 連結
來源:顯示 | 在 GitHub 上
# File activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb, line 191 def supports_insert_on_conflict? database_version >= "3.24.0" end
supports_insert_returning?() 連結
來源:顯示 | 在 GitHub 上
# 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