1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
|
# frozen-string-literal: true
require 'sqlite3'
require_relative 'shared/sqlite'
module Sequel
module SQLite
FALSE_VALUES = (%w'0 false f no n'.each(&:freeze) + [0]).freeze
blob = Object.new
def blob.call(s)
Sequel::SQL::Blob.new(s.to_s)
end
boolean = Object.new
def boolean.call(s)
s = s.downcase if s.is_a?(String)
!FALSE_VALUES.include?(s)
end
date = Object.new
def date.call(s)
case s
when String
Sequel.string_to_date(s)
when Integer
Date.jd(s)
when Float
Date.jd(s.to_i)
else
raise Sequel::Error, "unhandled type when converting to date: #{s.inspect} (#{s.class.inspect})"
end
end
integer = Object.new
def integer.call(s)
s.to_i
end
float = Object.new
def float.call(s)
s.to_f
end
numeric = Object.new
def numeric.call(s)
s = s.to_s unless s.is_a?(String)
BigDecimal(s) rescue s
end
time = Object.new
def time.call(s)
case s
when String
Sequel.string_to_time(s)
when Integer
Sequel::SQLTime.create(s/3600, (s % 3600)/60, s % 60)
when Float
s, f = s.divmod(1)
Sequel::SQLTime.create(s/3600, (s % 3600)/60, s % 60, (f*1000000).round)
else
raise Sequel::Error, "unhandled type when converting to date: #{s.inspect} (#{s.class.inspect})"
end
end
# Hash with string keys and callable values for converting SQLite types.
SQLITE_TYPES = {}
{
%w'date' => date,
%w'time' => time,
%w'bit bool boolean' => boolean,
%w'integer smallint mediumint int bigint' => integer,
%w'numeric decimal money' => numeric,
%w'float double real dec fixed' + ['double precision'] => float,
%w'blob' => blob
}.each do |k,v|
k.each{|n| SQLITE_TYPES[n] = v}
end
SQLITE_TYPES.freeze
sqlite_version = SQLite3::VERSION.split('.').map(&:to_i)[0..1]
sqlite_version = sqlite_version[0] * 100 + sqlite_version[1]
USE_EXTENDED_RESULT_CODES = sqlite_version >= 104
class Database < Sequel::Database
include ::Sequel::SQLite::DatabaseMethods
set_adapter_scheme :sqlite
# Mimic the file:// uri, by having 2 preceding slashes specify a relative
# path, and 3 preceding slashes specify an absolute path.
def self.uri_to_options(uri) # :nodoc:
{ :database => (uri.host.nil? && uri.path == '/') ? nil : "#{uri.host}#{uri.path}" }
end
private_class_method :uri_to_options
# The conversion procs to use for this database
attr_reader :conversion_procs
def initialize(opts = OPTS)
super
@allow_regexp = typecast_value_boolean(opts[:setup_regexp_function])
end
# 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)
def connect(server)
opts = server_opts(server)
opts[:database] = ':memory:' if blank_object?(opts[:database])
sqlite3_opts = {}
sqlite3_opts[:readonly] = typecast_value_boolean(opts[:readonly]) if opts.has_key?(:readonly)
db = ::SQLite3::Database.new(opts[:database].to_s, sqlite3_opts)
db.busy_timeout(typecast_value_integer(opts.fetch(:timeout, 5000)))
if USE_EXTENDED_RESULT_CODES
db.extended_result_codes = true
end
connection_pragmas.each{|s| log_connection_yield(s, db){db.execute_batch(s)}}
if typecast_value_boolean(opts[:setup_regexp_function])
db.create_function("regexp", 2) do |func, regexp_str, string|
func.result = Regexp.new(regexp_str).match(string) ? 1 : 0
end
end
class << db
attr_reader :prepared_statements
end
db.instance_variable_set(:@prepared_statements, {})
db
end
# Whether this Database instance is setup to allow regexp matching.
# True if the :setup_regexp_function option was passed when creating the Database.
def allow_regexp?
@allow_regexp
end
# Disconnect given connections from the database.
def disconnect_connection(c)
c.prepared_statements.each_value{|v| v.first.close}
c.close
end
# Run the given SQL with the given arguments and yield each row.
def execute(sql, opts=OPTS, &block)
_execute(:select, sql, opts, &block)
end
# Run the given SQL with the given arguments and return the number of changed rows.
def execute_dui(sql, opts=OPTS)
_execute(:update, sql, opts)
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.
def execute_ddl(sql, opts=OPTS)
synchronize(opts[:server]) do |conn|
conn.prepared_statements.values.each{|cps, s| cps.close}
conn.prepared_statements.clear
super
end
end
def execute_insert(sql, opts=OPTS)
_execute(:insert, sql, opts)
end
def freeze
@conversion_procs.freeze
super
end
# Handle Integer and Float arguments, since SQLite can store timestamps as integers and floats.
def to_application_timestamp(s)
case s
when String
super
when Integer
super(Time.at(s).to_s)
when Float
super(DateTime.jd(s).to_s)
else
raise Sequel::Error, "unhandled type when converting to : #{s.inspect} (#{s.class.inspect})"
end
end
private
def adapter_initialize
@conversion_procs = SQLITE_TYPES.dup
@conversion_procs['datetime'] = @conversion_procs['timestamp'] = method(:to_application_timestamp)
set_integer_booleans
end
# Yield an available connection. Rescue
# any SQLite3::Exceptions and turn them into DatabaseErrors.
def _execute(type, sql, opts, &block)
synchronize(opts[:server]) do |conn|
return execute_prepared_statement(conn, type, sql, opts, &block) if sql.is_a?(Symbol)
log_args = opts[:arguments]
args = {}
opts.fetch(:arguments, OPTS).each{|k, v| args[k] = prepared_statement_argument(v)}
case type
when :select
log_connection_yield(sql, conn, log_args){conn.query(sql, args, &block)}
when :insert
log_connection_yield(sql, conn, log_args){conn.execute(sql, args)}
conn.last_insert_row_id
when :update
log_connection_yield(sql, conn, log_args){conn.execute_batch(sql, args)}
conn.changes
end
end
rescue SQLite3::Exception => e
raise_error(e)
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.
def connection_pool_default_options
o = super.dup
# Default to only a single connection if a memory database is used,
# because otherwise each connection will get a separate database
o[:max_connections] = 1 if @opts[:database] == ':memory:' || blank_object?(@opts[:database])
o
end
def prepared_statement_argument(arg)
case arg
when Date, DateTime, Time
literal(arg)[1...-1]
when SQL::Blob
arg.to_blob
when true, false
if integer_booleans
arg ? 1 : 0
else
literal(arg)[1...-1]
end
else
arg
end
end
# Execute a prepared statement on the database using the given name.
def execute_prepared_statement(conn, type, name, opts, &block)
ps = prepared_statement(name)
sql = ps.prepared_sql
args = opts[:arguments]
ps_args = {}
args.each{|k, v| ps_args[k] = prepared_statement_argument(v)}
if cpsa = conn.prepared_statements[name]
cps, cps_sql = cpsa
if cps_sql != sql
cps.close
cps = nil
end
end
unless cps
cps = log_connection_yield("PREPARE #{name}: #{sql}", conn){conn.prepare(sql)}
conn.prepared_statements[name] = [cps, sql]
end
log_sql = String.new
log_sql << "EXECUTE #{name}"
if ps.log_sql
log_sql << " ("
log_sql << sql
log_sql << ")"
end
if block
log_connection_yield(log_sql, conn, args){cps.execute(ps_args, &block)}
else
log_connection_yield(log_sql, conn, args){cps.execute!(ps_args){|r|}}
case type
when :insert
conn.last_insert_row_id
when :update
conn.changes
end
end
end
# SQLite3 raises ArgumentError in addition to SQLite3::Exception in
# some cases, such as operations on a closed database.
def database_error_classes
[SQLite3::Exception, ArgumentError]
end
def dataset_class_default
Dataset
end
if USE_EXTENDED_RESULT_CODES
# Support SQLite exception codes if ruby-sqlite3 supports them.
def sqlite_error_code(exception)
exception.code if exception.respond_to?(:code)
end
end
end
class Dataset < Sequel::Dataset
include ::Sequel::SQLite::DatasetMethods
module ArgumentMapper
include Sequel::Dataset::ArgumentMapper
protected
# Return a hash with the same values as the given hash,
# but with the keys converted to strings.
def map_to_prepared_args(hash)
args = {}
hash.each{|k,v| args[k.to_s.gsub('.', '__')] = v}
args
end
private
# SQLite uses a : before the name of the argument for named
# arguments.
def prepared_arg(k)
LiteralString.new("#{prepared_arg_placeholder}#{k.to_s.gsub('.', '__')}")
end
end
BindArgumentMethods = prepared_statements_module(:bind, ArgumentMapper)
PreparedStatementMethods = prepared_statements_module(:prepare, BindArgumentMethods)
# Support regexp functions if using :setup_regexp_function Database option.
def complex_expression_sql_append(sql, op, args)
case op
when :~, :'!~', :'~*', :'!~*'
return super unless supports_regexp?
case_insensitive = [:'~*', :'!~*'].include?(op)
sql << 'NOT ' if [:'!~', :'!~*'].include?(op)
sql << '('
sql << 'LOWER(' if case_insensitive
literal_append(sql, args[0])
sql << ')' if case_insensitive
sql << ' REGEXP '
sql << 'LOWER(' if case_insensitive
literal_append(sql, args[1])
sql << ')' if case_insensitive
sql << ')'
else
super
end
end
def fetch_rows(sql)
execute(sql) do |result|
cps = db.conversion_procs
type_procs = result.types.map{|t| cps[base_type_name(t)]}
j = -1
cols = result.columns.map{|c| [output_identifier(c), type_procs[(j+=1)]]}
self.columns = cols.map(&:first)
max = cols.length
result.each do |values|
row = {}
i = -1
while (i += 1) < max
name, type_proc = cols[i]
v = values[i]
if type_proc && v
v = type_proc.call(v)
end
row[name] = v
end
yield row
end
end
end
# Support regexp if using :setup_regexp_function Database option.
def supports_regexp?
db.allow_regexp?
end
private
# The base type name for a given type, without any parenthetical part.
def base_type_name(t)
(t =~ /^(.*?)\(/ ? $1 : t).downcase if t
end
# Quote the string using the adapter class method.
def literal_string_append(sql, v)
sql << "'" << ::SQLite3::Database.quote(v) << "'"
end
def bound_variable_modules
[BindArgumentMethods]
end
def prepared_statement_modules
[PreparedStatementMethods]
end
# SQLite uses a : before the name of the argument as a placeholder.
def prepared_arg_placeholder
':'
end
end
end
end
|