| Module | Sequel::SQLite::DatabaseMethods |
| In: |
lib/sequel/adapters/shared/sqlite.rb
|
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.
| 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 |
| TRANSACTION_MODE | = | { :deferred => "BEGIN DEFERRED TRANSACTION".freeze, :immediate => "BEGIN IMMEDIATE TRANSACTION".freeze, :exclusive => "BEGIN EXCLUSIVE TRANSACTION".freeze, nil => Sequel::Database::SQL_BEGIN, }.freeze |
| DATABASE_ERROR_REGEXPS | = | { /is not unique\z/ => UniqueConstraintViolation, /foreign key constraint failed\z/ => ForeignKeyConstraintViolation, /\A(SQLITE ERROR 19 \(CONSTRAINT\) : )?constraint failed\z/ => ConstraintViolation, /may not be NULL\z/ => NotNullConstraintViolation, }.freeze |
| integer_booleans | [RW] | Whether to use integers for booleans in the database. SQLite recommends booleans be stored as integers, but historically Sequel has used ‘t’/’f’. |
| transaction_mode | [R] | A symbol signifying the value of the default transaction mode |
| use_timestamp_timezones | [W] | 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. |
A symbol signifying the value of the auto_vacuum PRAGMA.
# File lib/sequel/adapters/shared/sqlite.rb, line 27
27: def auto_vacuum
28: AUTO_VACUUM[pragma_get(:auto_vacuum).to_i]
29: end
Set the auto_vacuum PRAGMA using the given symbol (:none, :full, or :incremental). See pragma_set. Consider using the :auto_vacuum Database option instead.
# File lib/sequel/adapters/shared/sqlite.rb, line 34
34: def auto_vacuum=(value)
35: value = AUTO_VACUUM.index(value) || (raise Error, "Invalid value for auto_vacuum option. Please specify one of :none, :full, :incremental.")
36: pragma_set(:auto_vacuum, value)
37: end
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.
# File lib/sequel/adapters/shared/sqlite.rb, line 42
42: def case_sensitive_like=(value)
43: pragma_set(:case_sensitive_like, !!value ? 'on' : 'off') if sqlite_version >= 30203
44: end
Return the array of foreign key info hashes using the foreign_key_list PRAGMA, including information for the :on_update and :on_delete entries.
# File lib/sequel/adapters/shared/sqlite.rb, line 78
78: def foreign_key_list(table, opts={})
79: m = output_identifier_meth
80: h = {}
81: metadata_dataset.with_sql("PRAGMA foreign_key_list(?)", input_identifier_meth.call(table)).each do |row|
82: if r = h[row[:id]]
83: r[:columns] << m.call(row[:from])
84: r[:key] << m.call(row[:to]) if r[:key]
85: else
86: 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])}
87: end
88: end
89: h.values
90: end
Boolean signifying the value of the foreign_keys PRAGMA, or nil if not using SQLite 3.6.19+.
# File lib/sequel/adapters/shared/sqlite.rb, line 65
65: def foreign_keys
66: pragma_get(:foreign_keys).to_i == 1 if sqlite_version >= 30619
67: end
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.
# File lib/sequel/adapters/shared/sqlite.rb, line 72
72: def foreign_keys=(value)
73: pragma_set(:foreign_keys, !!value ? 'on' : 'off') if sqlite_version >= 30619
74: end
Use the index_list and index_info PRAGMAs to determine the indexes on the table.
# File lib/sequel/adapters/shared/sqlite.rb, line 93
93: def indexes(table, opts={})
94: m = output_identifier_meth
95: im = input_identifier_meth
96: indexes = {}
97: metadata_dataset.with_sql("PRAGMA index_list(?)", im.call(table)).each do |r|
98: next if r[:name] =~ PRIMARY_KEY_INDEX_RE
99: indexes[m.call(r[:name])] = {:unique=>r[:unique].to_i==1}
100: end
101: indexes.each do |k, v|
102: v[:columns] = metadata_dataset.with_sql("PRAGMA index_info(?)", im.call(k)).map(:name).map{|x| m.call(x)}
103: end
104: indexes
105: end
Get the value of the given PRAGMA.
# File lib/sequel/adapters/shared/sqlite.rb, line 108
108: def pragma_get(name)
109: self["PRAGMA #{name}"].single_value
110: end
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.
# File lib/sequel/adapters/shared/sqlite.rb, line 118
118: def pragma_set(name, value)
119: execute_ddl("PRAGMA #{name} = #{value}")
120: end
Set the integer_booleans option using the passed in :integer_boolean option.
# File lib/sequel/adapters/shared/sqlite.rb, line 123
123: def set_integer_booleans
124: @integer_booleans = typecast_value_boolean(@opts[:integer_booleans])
125: end
The version of the server as an integer, where 3.6.19 = 30619. If the server version can‘t be determined, 0 is used.
# File lib/sequel/adapters/shared/sqlite.rb, line 129
129: def sqlite_version
130: return @sqlite_version if defined?(@sqlite_version)
131: @sqlite_version = begin
132: v = get{sqlite_version{}}
133: [10000, 100, 1].zip(v.split('.')).inject(0){|a, m| a + m[0] * Integer(m[1])}
134: rescue
135: 0
136: end
137: end
A symbol signifying the value of the synchronous PRAGMA.
# File lib/sequel/adapters/shared/sqlite.rb, line 168
168: def synchronous
169: SYNCHRONOUS[pragma_get(:synchronous).to_i]
170: end
Set the synchronous PRAGMA using the given symbol (:off, :normal, or :full). See pragma_set. Consider using the :synchronous Database option instead.
# File lib/sequel/adapters/shared/sqlite.rb, line 174
174: def synchronous=(value)
175: value = SYNCHRONOUS.index(value) || (raise Error, "Invalid value for synchronous option. Please specify one of :off, :normal, :full.")
176: pragma_set(:synchronous, value)
177: end
A symbol signifying the value of the temp_store PRAGMA.
# File lib/sequel/adapters/shared/sqlite.rb, line 188
188: def temp_store
189: TEMP_STORE[pragma_get(:temp_store).to_i]
190: end
Set the temp_store PRAGMA using the given symbol (:default, :file, or :memory). See pragma_set. Consider using the :temp_store Database option instead.
# File lib/sequel/adapters/shared/sqlite.rb, line 194
194: def temp_store=(value)
195: value = TEMP_STORE.index(value) || (raise Error, "Invalid value for temp_store option. Please specify one of :default, :file, :memory.")
196: pragma_set(:temp_store, value)
197: end
Set the default transaction mode.
# File lib/sequel/adapters/shared/sqlite.rb, line 50
50: def transaction_mode=(value)
51: if TRANSACTION_MODE.include?(value)
52: @transaction_mode = value
53: else
54: raise Error, "Invalid value for transaction_mode. Please specify one of :deferred, :immediate, :exclusive, nil"
55: end
56: end
SQLite supports timezones in timestamps, since it just stores them as strings, but it breaks the usage of SQLite‘s datetime functions.
# File lib/sequel/adapters/shared/sqlite.rb, line 163
163: def use_timestamp_timezones?
164: defined?(@use_timestamp_timezones) ? @use_timestamp_timezones : (@use_timestamp_timezones = true)
165: end