Module: Sequel::SQLite::DatabaseMethods
- Included in:
- Amalgalite::Database, DataObjects::SQLite::DatabaseMethods, JDBC::SQLite::DatabaseMethods, Database, Sequel::Swift::SQLite::DatabaseMethods
- Defined in:
- lib/sequel/adapters/shared/sqlite.rb
Overview
No matter how you connect to SQLite, the following Database options can be used to set PRAGMAs on connections in a thread-safe manner: :auto_vacuum, :foreign_keys, :synchronous, and :temp_store.
Constant Summary collapse
- AUTO_VACUUM =
[:none, :full, :incremental].freeze
- PRIMARY_KEY_INDEX_RE =
/\Asqlite_autoindex_/.freeze
- SYNCHRONOUS =
[:off, :normal, :full].freeze
- TABLES_FILTER =
"type = 'table' AND NOT name = 'sqlite_sequence'".freeze
- TEMP_STORE =
[:default, :file, :memory].freeze
- VIEWS_FILTER =
"type = 'view'".freeze
Instance Attribute Summary collapse
-
#integer_booleans ⇒ Object
Whether to use integers for booleans in the database.
-
#use_timestamp_timezones ⇒ Object
writeonly
Override the default setting for whether to use timezones in timestamps.
Instance Method Summary collapse
-
#auto_vacuum ⇒ Object
A symbol signifying the value of the auto_vacuum PRAGMA.
-
#auto_vacuum=(value) ⇒ Object
Set the auto_vacuum PRAGMA using the given symbol (:none, :full, or :incremental).
-
#case_sensitive_like=(value) ⇒ Object
Set the case_sensitive_like PRAGMA using the given boolean value, if using SQLite 3.2.3+.
-
#database_type ⇒ Object
SQLite uses the :sqlite database type.
-
#foreign_key_list(table, opts = {}) ⇒ Object
Return the array of foreign key info hashes using the foreign_key_list PRAGMA, including information for the :on_update and :on_delete entries.
-
#foreign_keys ⇒ Object
Boolean signifying the value of the foreign_keys PRAGMA, or nil if not using SQLite 3.6.19+.
-
#foreign_keys=(value) ⇒ Object
Set the foreign_keys PRAGMA using the given boolean value, if using SQLite 3.6.19+.
-
#indexes(table, opts = {}) ⇒ Object
Use the index_list and index_info PRAGMAs to determine the indexes on the table.
-
#pragma_get(name) ⇒ Object
Get the value of the given PRAGMA.
-
#pragma_set(name, value) ⇒ Object
Set the value of the given PRAGMA to value.
-
#set_integer_booleans ⇒ Object
Set the integer_booleans option using the passed in :integer_boolean option.
-
#sqlite_version ⇒ Object
The version of the server as an integer, where 3.6.19 = 30619.
-
#supports_create_table_if_not_exists? ⇒ Boolean
SQLite supports CREATE TABLE IF NOT EXISTS syntax since 3.3.0.
-
#supports_savepoints? ⇒ Boolean
SQLite 3.6.8+ supports savepoints.
-
#synchronous ⇒ Object
A symbol signifying the value of the synchronous PRAGMA.
-
#synchronous=(value) ⇒ Object
Set the synchronous PRAGMA using the given symbol (:off, :normal, or :full).
-
#tables(opts = {}) ⇒ Object
Array of symbols specifying the table names in the current database.
-
#temp_store ⇒ Object
A symbol signifying the value of the temp_store PRAGMA.
-
#temp_store=(value) ⇒ Object
Set the temp_store PRAGMA using the given symbol (:default, :file, or :memory).
-
#use_timestamp_timezones? ⇒ Boolean
SQLite supports timezones in timestamps, since it just stores them as strings, but it breaks the usage of SQLite’s datetime functions.
-
#views(opts = {}) ⇒ Object
Array of symbols specifying the view names in the current database.
Instance Attribute Details
#integer_booleans ⇒ Object
Whether to use integers for booleans in the database. SQLite recommends booleans be stored as integers, but historically Sequel has used ‘t’/‘f’.
16 17 18 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 16 def integer_booleans @integer_booleans end |
#use_timestamp_timezones=(value) ⇒ Object (writeonly)
Override the default setting for whether to use timezones in timestamps. For backwards compatibility, it is set to true
by default. Anyone wanting to use SQLite’s datetime functions should set it to false
using this method. It’s possible that the default will change in a future version, so anyone relying on timezones in timestamps should set this to true
.
134 135 136 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 134 def (value) @use_timestamp_timezones = value end |
Instance Method Details
#auto_vacuum ⇒ Object
A symbol signifying the value of the auto_vacuum PRAGMA.
19 20 21 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 19 def auto_vacuum AUTO_VACUUM[pragma_get(:auto_vacuum).to_i] end |
#auto_vacuum=(value) ⇒ Object
Set the auto_vacuum PRAGMA using the given symbol (:none, :full, or :incremental). See pragma_set. Consider using the :auto_vacuum Database option instead.
26 27 28 29 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 26 def auto_vacuum=(value) value = AUTO_VACUUM.index(value) || (raise Error, "Invalid value for auto_vacuum option. Please specify one of :none, :full, :incremental.") pragma_set(:auto_vacuum, value) end |
#case_sensitive_like=(value) ⇒ Object
Set the case_sensitive_like PRAGMA using the given boolean value, if using SQLite 3.2.3+. If not using 3.2.3+, no error is raised. See pragma_set. Consider using the :case_sensitive_like Database option instead.
34 35 36 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 34 def case_sensitive_like=(value) pragma_set(:case_sensitive_like, !!value ? 'on' : 'off') if sqlite_version >= 30203 end |
#database_type ⇒ Object
SQLite uses the :sqlite database type.
39 40 41 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 39 def database_type :sqlite end |
#foreign_key_list(table, opts = {}) ⇒ Object
Return the array of foreign key info hashes using the foreign_key_list PRAGMA, including information for the :on_update and :on_delete entries.
58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 58 def foreign_key_list(table, opts={}) m = output_identifier_meth h = {} .with_sql("PRAGMA foreign_key_list(?)", input_identifier_meth.call(table)).each do |row| if r = h[row[:id]] r[:columns] << m.call(row[:from]) r[:key] << m.call(row[:to]) if r[:key] else h[row[:id]] = {:columns=>[m.call(row[:from])], :table=>m.call(row[:table]), :key=>([m.call(row[:to])] if row[:to]), :on_update=>on_delete_sql_to_sym(row[:on_update]), :on_delete=>on_delete_sql_to_sym(row[:on_delete])} end end h.values end |
#foreign_keys ⇒ Object
Boolean signifying the value of the foreign_keys PRAGMA, or nil if not using SQLite 3.6.19+.
45 46 47 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 45 def foreign_keys pragma_get(:foreign_keys).to_i == 1 if sqlite_version >= 30619 end |
#foreign_keys=(value) ⇒ Object
Set the foreign_keys PRAGMA using the given boolean value, if using SQLite 3.6.19+. If not using 3.6.19+, no error is raised. See pragma_set. Consider using the :foreign_keys Database option instead.
52 53 54 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 52 def foreign_keys=(value) pragma_set(:foreign_keys, !!value ? 'on' : 'off') if sqlite_version >= 30619 end |
#indexes(table, opts = {}) ⇒ Object
Use the index_list and index_info PRAGMAs to determine the indexes on the table.
73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 73 def indexes(table, opts={}) m = output_identifier_meth im = input_identifier_meth indexes = {} .with_sql("PRAGMA index_list(?)", im.call(table)).each do |r| next if r[:name] =~ PRIMARY_KEY_INDEX_RE indexes[m.call(r[:name])] = {:unique=>r[:unique].to_i==1} end indexes.each do |k, v| v[:columns] = .with_sql("PRAGMA index_info(?)", im.call(k)).map(:name).map{|x| m.call(x)} end indexes end |
#pragma_get(name) ⇒ Object
Get the value of the given PRAGMA.
88 89 90 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 88 def pragma_get(name) self["PRAGMA #{name}"].single_value end |
#pragma_set(name, value) ⇒ Object
Set the value of the given PRAGMA to value.
This method is not thread safe, and will not work correctly if there are multiple connections in the Database’s connection pool. PRAGMA modifications should be done when the connection is created, using an option provided when creating the Database object.
98 99 100 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 98 def pragma_set(name, value) execute_ddl("PRAGMA #{name} = #{value}") end |
#set_integer_booleans ⇒ Object
Set the integer_booleans option using the passed in :integer_boolean option.
103 104 105 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 103 def set_integer_booleans @integer_booleans = typecast_value_boolean(@opts[:integer_booleans]) end |
#sqlite_version ⇒ Object
The version of the server as an integer, where 3.6.19 = 30619. If the server version can’t be determined, 0 is used.
109 110 111 112 113 114 115 116 117 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 109 def sqlite_version return @sqlite_version if defined?(@sqlite_version) @sqlite_version = begin v = get{sqlite_version{}} [10000, 100, 1].zip(v.split('.')).inject(0){|a, m| a + m[0] * Integer(m[1])} rescue 0 end end |
#supports_create_table_if_not_exists? ⇒ Boolean
SQLite supports CREATE TABLE IF NOT EXISTS syntax since 3.3.0.
120 121 122 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 120 def supports_create_table_if_not_exists? sqlite_version >= 30300 end |
#supports_savepoints? ⇒ Boolean
SQLite 3.6.8+ supports savepoints.
125 126 127 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 125 def supports_savepoints? sqlite_version >= 30608 end |
#synchronous ⇒ Object
A symbol signifying the value of the synchronous PRAGMA.
143 144 145 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 143 def synchronous SYNCHRONOUS[pragma_get(:synchronous).to_i] end |
#synchronous=(value) ⇒ Object
Set the synchronous PRAGMA using the given symbol (:off, :normal, or :full). See pragma_set. Consider using the :synchronous Database option instead.
149 150 151 152 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 149 def synchronous=(value) value = SYNCHRONOUS.index(value) || (raise Error, "Invalid value for synchronous option. Please specify one of :off, :normal, :full.") pragma_set(:synchronous, value) end |
#tables(opts = {}) ⇒ Object
Array of symbols specifying the table names in the current database.
Options:
-
:server - Set the server to use.
158 159 160 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 158 def tables(opts={}) tables_and_views(TABLES_FILTER, opts) end |
#temp_store ⇒ Object
A symbol signifying the value of the temp_store PRAGMA.
163 164 165 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 163 def temp_store TEMP_STORE[pragma_get(:temp_store).to_i] end |
#temp_store=(value) ⇒ Object
Set the temp_store PRAGMA using the given symbol (:default, :file, or :memory). See pragma_set. Consider using the :temp_store Database option instead.
169 170 171 172 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 169 def temp_store=(value) value = TEMP_STORE.index(value) || (raise Error, "Invalid value for temp_store option. Please specify one of :default, :file, :memory.") pragma_set(:temp_store, value) end |
#use_timestamp_timezones? ⇒ Boolean
SQLite supports timezones in timestamps, since it just stores them as strings, but it breaks the usage of SQLite’s datetime functions.
138 139 140 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 138 def defined?(@use_timestamp_timezones) ? @use_timestamp_timezones : (@use_timestamp_timezones = true) end |
#views(opts = {}) ⇒ Object
Array of symbols specifying the view names in the current database.
Options:
-
:server - Set the server to use.
178 179 180 |
# File 'lib/sequel/adapters/shared/sqlite.rb', line 178 def views(opts={}) tables_and_views(VIEWS_FILTER, opts) end |