class Sequel::SQLite::Database

Attributes

conversion_procs[R]

The conversion procs to use for this database

Public Instance Methods

connect(server) click to toggle source

Connect to the database. Since SQLite is a file based database, available options are limited:

:database

database name (filename or ':memory:' or file: URI)

:readonly

open database in read-only mode; useful for reading static data that you do not want to modify

:timeout

how long to wait for the database to be available if it is locked, given in milliseconds (default is 5000)

    # File lib/sequel/adapters/sqlite.rb
109 def connect(server)
110   opts = server_opts(server)
111   opts[:database] = ':memory:' if blank_object?(opts[:database])
112   sqlite3_opts = {}
113   sqlite3_opts[:readonly] = typecast_value_boolean(opts[:readonly]) if opts.has_key?(:readonly)
114   db = ::SQLite3::Database.new(opts[:database].to_s, sqlite3_opts)
115   db.busy_timeout(typecast_value_integer(opts.fetch(:timeout, 5000)))
116 
117   if USE_EXTENDED_RESULT_CODES
118     db.extended_result_codes = true
119   end
120   
121   connection_pragmas.each{|s| log_connection_yield(s, db){db.execute_batch(s)}}
122   
123   class << db
124     attr_reader :prepared_statements
125   end
126   db.instance_variable_set(:@prepared_statements, {})
127   
128   db
129 end
disconnect_connection(c) click to toggle source

Disconnect given connections from the database.

    # File lib/sequel/adapters/sqlite.rb
132 def disconnect_connection(c)
133   c.prepared_statements.each_value{|v| v.first.close}
134   c.close
135 end
execute(sql, opts=OPTS, &block) click to toggle source

Run the given SQL with the given arguments and yield each row.

    # File lib/sequel/adapters/sqlite.rb
138 def execute(sql, opts=OPTS, &block)
139   _execute(:select, sql, opts, &block)
140 end
execute_ddl(sql, opts=OPTS) click to toggle source

Drop any prepared statements on the connection when executing DDL. This is because prepared statements lock the table in such a way that you can't drop or alter the table while a prepared statement that references it still exists.

Calls superclass method Sequel::Database#execute_ddl
    # File lib/sequel/adapters/sqlite.rb
150 def execute_ddl(sql, opts=OPTS)
151   synchronize(opts[:server]) do |conn|
152     conn.prepared_statements.values.each{|cps, s| cps.close}
153     conn.prepared_statements.clear
154     super
155   end
156 end
execute_dui(sql, opts=OPTS) click to toggle source

Run the given SQL with the given arguments and return the number of changed rows.

    # File lib/sequel/adapters/sqlite.rb
143 def execute_dui(sql, opts=OPTS)
144   _execute(:update, sql, opts)
145 end
execute_insert(sql, opts=OPTS) click to toggle source
    # File lib/sequel/adapters/sqlite.rb
158 def execute_insert(sql, opts=OPTS)
159   _execute(:insert, sql, opts)
160 end
freeze() click to toggle source
Calls superclass method Sequel::SQLite::DatabaseMethods#freeze
    # File lib/sequel/adapters/sqlite.rb
162 def freeze
163   @conversion_procs.freeze
164   super
165 end
to_application_timestamp(s) click to toggle source

Handle Integer and Float arguments, since SQLite can store timestamps as integers and floats.

    # File lib/sequel/adapters/sqlite.rb
168 def to_application_timestamp(s)
169   case s
170   when String
171     super
172   when Integer
173     super(Time.at(s).to_s)
174   when Float
175     super(DateTime.jd(s).to_s)
176   else
177     raise Sequel::Error, "unhandled type when converting to : #{s.inspect} (#{s.class.inspect})"
178   end
179 end

Private Instance Methods

_execute(type, sql, opts, &block) click to toggle source

Yield an available connection. Rescue any SQLite3::Exceptions and turn them into DatabaseErrors.

    # File lib/sequel/adapters/sqlite.rb
191 def _execute(type, sql, opts, &block)
192   begin
193     synchronize(opts[:server]) do |conn|
194       return execute_prepared_statement(conn, type, sql, opts, &block) if sql.is_a?(Symbol)
195       log_args = opts[:arguments]
196       args = {}
197       opts.fetch(:arguments, OPTS).each{|k, v| args[k] = prepared_statement_argument(v)}
198       case type
199       when :select
200         log_connection_yield(sql, conn, log_args){conn.query(sql, args, &block)}
201       when :insert
202         log_connection_yield(sql, conn, log_args){conn.execute(sql, args)}
203         conn.last_insert_row_id
204       when :update
205         log_connection_yield(sql, conn, log_args){conn.execute_batch(sql, args)}
206         conn.changes
207       end
208     end
209   rescue SQLite3::Exception => e
210     raise_error(e)
211   end
212 end
adapter_initialize() click to toggle source
    # File lib/sequel/adapters/sqlite.rb
183 def adapter_initialize
184   @conversion_procs = SQLITE_TYPES.dup
185   @conversion_procs['datetime'] = @conversion_procs['timestamp'] = method(:to_application_timestamp)
186   set_integer_booleans
187 end
connection_pool_default_options() click to toggle source

The SQLite adapter does not need the pool to convert exceptions. Also, force the max connections to 1 if a memory database is being used, as otherwise each connection gets a separate database.

    # File lib/sequel/adapters/sqlite.rb
217 def connection_pool_default_options
218   o = super.dup
219   # Default to only a single connection if a memory database is used,
220   # because otherwise each connection will get a separate database
221   o[:max_connections] = 1 if @opts[:database] == ':memory:' || blank_object?(@opts[:database])
222   o
223 end
database_error_classes() click to toggle source

SQLite3 raises ArgumentError in addition to SQLite3::Exception in some cases, such as operations on a closed database.

    # File lib/sequel/adapters/sqlite.rb
282 def database_error_classes
283   [SQLite3::Exception, ArgumentError]
284 end
dataset_class_default() click to toggle source
    # File lib/sequel/adapters/sqlite.rb
286 def dataset_class_default
287   Dataset
288 end
execute_prepared_statement(conn, type, name, opts, &block) click to toggle source

Execute a prepared statement on the database using the given name.

    # File lib/sequel/adapters/sqlite.rb
243 def execute_prepared_statement(conn, type, name, opts, &block)
244   ps = prepared_statement(name)
245   sql = ps.prepared_sql
246   args = opts[:arguments]
247   ps_args = {}
248   args.each{|k, v| ps_args[k] = prepared_statement_argument(v)}
249   if cpsa = conn.prepared_statements[name]
250     cps, cps_sql = cpsa
251     if cps_sql != sql
252       cps.close
253       cps = nil
254     end
255   end
256   unless cps
257     cps = log_connection_yield("PREPARE #{name}: #{sql}", conn){conn.prepare(sql)}
258     conn.prepared_statements[name] = [cps, sql]
259   end
260   log_sql = String.new
261   log_sql << "EXECUTE #{name}"
262   if ps.log_sql
263     log_sql << " ("
264     log_sql << sql
265     log_sql << ")"
266   end
267   if block
268     log_connection_yield(log_sql, conn, args){cps.execute(ps_args, &block)}
269   else
270     log_connection_yield(log_sql, conn, args){cps.execute!(ps_args){|r|}}
271     case type
272     when :insert
273       conn.last_insert_row_id
274     when :update
275       conn.changes
276     end
277   end
278 end
prepared_statement_argument(arg) click to toggle source
    # File lib/sequel/adapters/sqlite.rb
225 def prepared_statement_argument(arg)
226   case arg
227   when Date, DateTime, Time
228     literal(arg)[1...-1]
229   when SQL::Blob
230     arg.to_blob
231   when true, false
232     if integer_booleans
233       arg ? 1 : 0
234     else
235       literal(arg)[1...-1]
236     end
237   else
238     arg
239   end
240 end
sqlite_error_code(exception) click to toggle source

Support SQLite exception codes if ruby-sqlite3 supports them.

    # File lib/sequel/adapters/sqlite.rb
292 def sqlite_error_code(exception)
293   exception.code if exception.respond_to?(:code)
294 end