Module: Sequel::SQLite::DatabaseMethods

Includes:
UnmodifiedIdentifiers::DatabaseMethods
Included in:
Amalgalite::Database, JDBC::SQLite::DatabaseMethods, Database
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

AUTO_VACUUM =
[:none, :full, :incremental].freeze
SYNCHRONOUS =
[:off, :normal, :full].freeze
TEMP_STORE =
[:default, :file, :memory].freeze
TRANSACTION_MODE =
{
  :deferred => "BEGIN DEFERRED TRANSACTION".freeze,
  :immediate => "BEGIN IMMEDIATE TRANSACTION".freeze,
  :exclusive => "BEGIN EXCLUSIVE TRANSACTION".freeze,
  nil => "BEGIN".freeze
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#integer_booleansObject

Whether to use integers for booleans in the database. SQLite recommends booleans be stored as integers, but historically Sequel has used 't'/'f'.



34
35
36
# File 'lib/sequel/adapters/shared/sqlite.rb', line 34

def integer_booleans
  @integer_booleans
end

#transaction_modeObject

A symbol signifying the value of the default transaction mode



37
38
39
# File 'lib/sequel/adapters/shared/sqlite.rb', line 37

def transaction_mode
  @transaction_mode
end

#use_timestamp_timezones=(value) ⇒ Object (writeonly)

Override the default setting for whether to use timezones in timestamps. It is set to false by default, as SQLite's date/time methods do not support timezones in timestamps.



141
142
143
# File 'lib/sequel/adapters/shared/sqlite.rb', line 141

def use_timestamp_timezones=(value)
  @use_timestamp_timezones = value
end

Instance Method Details

#database_typeObject

SQLite uses the :sqlite database type.



49
50
51
# File 'lib/sequel/adapters/shared/sqlite.rb', line 49

def database_type
  :sqlite
end

#foreign_key_list(table, opts = 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.



60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/sequel/adapters/shared/sqlite.rb', line 60

def foreign_key_list(table, opts=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

#freezeObject



74
75
76
77
78
# File 'lib/sequel/adapters/shared/sqlite.rb', line 74

def freeze
  sqlite_version
  use_timestamp_timezones?
  super
end

#indexes(table, opts = OPTS) ⇒ Object

Use the index_list and index_info PRAGMAs to determine the indexes on the table.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/sequel/adapters/shared/sqlite.rb', line 81

def indexes(table, opts=OPTS)
  m = output_identifier_meth
  im = input_identifier_meth
  indexes = {}
  .with_sql("PRAGMA index_list(?)", im.call(table)).each do |r|
    if opts[:only_autocreated]
      # If specifically asked for only autocreated indexes, then return those an only those
      next unless r[:name] =~ /\Asqlite_autoindex_/
    elsif r.has_key?(:origin)
      # If origin is set, then only exclude primary key indexes and partial indexes
      next if r[:origin] == 'pk'
      next if r[:partial].to_i == 1
    else
      # When :origin key not present, assume any autoindex could be a primary key one and exclude it
      next if r[:name] =~ /\Asqlite_autoindex_/
    end

    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

#set_integer_booleansObject

Set the integer_booleans option using the passed in :integer_boolean option.



54
55
56
# File 'lib/sequel/adapters/shared/sqlite.rb', line 54

def set_integer_booleans
  @integer_booleans = @opts.has_key?(:integer_booleans) ? typecast_value_boolean(@opts[:integer_booleans]) : true
end

#sqlite_versionObject

The version of the server as an integer, where 3.6.19 = 30619. If the server version can't be determined, 0 is used.



108
109
110
111
112
113
114
115
116
# File 'lib/sequel/adapters/shared/sqlite.rb', line 108

def sqlite_version
  return @sqlite_version if defined?(@sqlite_version)
  @sqlite_version = begin
    v = fetch('SELECT sqlite_version()').single_value
    [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.



119
120
121
# File 'lib/sequel/adapters/shared/sqlite.rb', line 119

def supports_create_table_if_not_exists?
  sqlite_version >= 30300
end

#supports_deferrable_foreign_key_constraints?Boolean

SQLite 3.6.19+ supports deferrable foreign key constraints.



124
125
126
# File 'lib/sequel/adapters/shared/sqlite.rb', line 124

def supports_deferrable_foreign_key_constraints?
  sqlite_version >= 30619
end

#supports_partial_indexes?Boolean

SQLite 3.8.0+ supports partial indexes.



129
130
131
# File 'lib/sequel/adapters/shared/sqlite.rb', line 129

def supports_partial_indexes?
  sqlite_version >= 30800
end

#supports_savepoints?Boolean

SQLite 3.6.8+ supports savepoints.



134
135
136
# File 'lib/sequel/adapters/shared/sqlite.rb', line 134

def supports_savepoints?
  sqlite_version >= 30608
end

#tables(opts = OPTS) ⇒ Object

Array of symbols specifying the table names in the current database.

Options:

:server

Set the server to use.



153
154
155
# File 'lib/sequel/adapters/shared/sqlite.rb', line 153

def tables(opts=OPTS)
  tables_and_views(Sequel.~(:name=>'sqlite_sequence') & {:type => 'table'}, opts)
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.



145
146
147
# File 'lib/sequel/adapters/shared/sqlite.rb', line 145

def use_timestamp_timezones?
  defined?(@use_timestamp_timezones) ? @use_timestamp_timezones : (@use_timestamp_timezones = false)
end

#values(v) ⇒ Object

Creates a dataset that uses the VALUES clause:

DB.values([[1, 2], [3, 4]])
# VALUES ((1, 2), (3, 4))


161
162
163
# File 'lib/sequel/adapters/shared/sqlite.rb', line 161

def values(v)
  @default_dataset.clone(:values=>v)
end

#views(opts = OPTS) ⇒ Object

Array of symbols specifying the view names in the current database.

Options:

:server

Set the server to use.



169
170
171
# File 'lib/sequel/adapters/shared/sqlite.rb', line 169

def views(opts=OPTS)
  tables_and_views({:type => 'view'}, opts)
end