class Sequel::SQLite::Database
Attributes
The conversion procs to use for this database
Public Instance Methods
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 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
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
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.
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
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
# File lib/sequel/adapters/sqlite.rb 158 def execute_insert(sql, opts=OPTS) 159 _execute(:insert, sql, opts) 160 end
Sequel::SQLite::DatabaseMethods#freeze
# File lib/sequel/adapters/sqlite.rb 162 def freeze 163 @conversion_procs.freeze 164 super 165 end
Handle Integer and Float arguments, since SQLite
can store timestamps as integers and floats.
Sequel::Database#to_application_timestamp
# 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
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 synchronize(opts[:server]) do |conn| 193 return execute_prepared_statement(conn, type, sql, opts, &block) if sql.is_a?(Symbol) 194 log_args = opts[:arguments] 195 args = {} 196 opts.fetch(:arguments, OPTS).each{|k, v| args[k] = prepared_statement_argument(v)} 197 case type 198 when :select 199 log_connection_yield(sql, conn, log_args){conn.query(sql, args, &block)} 200 when :insert 201 log_connection_yield(sql, conn, log_args){conn.execute(sql, args)} 202 conn.last_insert_row_id 203 when :update 204 log_connection_yield(sql, conn, log_args){conn.execute_batch(sql, args)} 205 conn.changes 206 end 207 end 208 rescue SQLite3::Exception => e 209 raise_error(e) 210 end
# 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
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.
Sequel::Database#connection_pool_default_options
# File lib/sequel/adapters/sqlite.rb 215 def connection_pool_default_options 216 o = super.dup 217 # Default to only a single connection if a memory database is used, 218 # because otherwise each connection will get a separate database 219 o[:max_connections] = 1 if @opts[:database] == ':memory:' || blank_object?(@opts[:database]) 220 o 221 end
SQLite3 raises ArgumentError in addition to SQLite3::Exception in some cases, such as operations on a closed database.
# File lib/sequel/adapters/sqlite.rb 280 def database_error_classes 281 [SQLite3::Exception, ArgumentError] 282 end
# File lib/sequel/adapters/sqlite.rb 284 def dataset_class_default 285 Dataset 286 end
Execute a prepared statement on the database using the given name.
# File lib/sequel/adapters/sqlite.rb 241 def execute_prepared_statement(conn, type, name, opts, &block) 242 ps = prepared_statement(name) 243 sql = ps.prepared_sql 244 args = opts[:arguments] 245 ps_args = {} 246 args.each{|k, v| ps_args[k] = prepared_statement_argument(v)} 247 if cpsa = conn.prepared_statements[name] 248 cps, cps_sql = cpsa 249 if cps_sql != sql 250 cps.close 251 cps = nil 252 end 253 end 254 unless cps 255 cps = log_connection_yield("PREPARE #{name}: #{sql}", conn){conn.prepare(sql)} 256 conn.prepared_statements[name] = [cps, sql] 257 end 258 log_sql = String.new 259 log_sql << "EXECUTE #{name}" 260 if ps.log_sql 261 log_sql << " (" 262 log_sql << sql 263 log_sql << ")" 264 end 265 if block 266 log_connection_yield(log_sql, conn, args){cps.execute(ps_args, &block)} 267 else 268 log_connection_yield(log_sql, conn, args){cps.execute!(ps_args){|r|}} 269 case type 270 when :insert 271 conn.last_insert_row_id 272 when :update 273 conn.changes 274 end 275 end 276 end
# File lib/sequel/adapters/sqlite.rb 223 def prepared_statement_argument(arg) 224 case arg 225 when Date, DateTime, Time 226 literal(arg)[1...-1] 227 when SQL::Blob 228 arg.to_blob 229 when true, false 230 if integer_booleans 231 arg ? 1 : 0 232 else 233 literal(arg)[1...-1] 234 end 235 else 236 arg 237 end 238 end
Support SQLite
exception codes if ruby-sqlite3 supports them.
# File lib/sequel/adapters/sqlite.rb 290 def sqlite_error_code(exception) 291 exception.code if exception.respond_to?(:code) 292 end