Module: Sequel::SequelMethods

Included in:
Sequel
Defined in:
lib/sequel/timezones.rb,
lib/sequel/core.rb

Overview

Sequel doesn’t pay much attention to timezones by default, but you can set it to handle timezones if you want. There are three separate timezone settings:

  • application_timezone

  • database_timezone

  • typecast_timezone

All three timezones have getter and setter methods. You can set all three timezones to the same value at once via Sequel.default_timezone=.

The only timezone values that are supported by default are :utc (convert to UTC), :local (convert to local time), and nil (don’t convert). If you need to convert to a specific timezone, or need the timezones being used to change based on the environment (e.g. current user), you need to use the named_timezones extension (and use DateTime as the datetime_class). Sequel also ships with a thread_local_timezones extensions which allows each thread to have its own timezone values for each of the timezones.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#application_timezone ⇒ Object (readonly)

The timezone you want the application to use. This is the timezone that incoming times from the database and typecasting are converted to.



32
33
34
 
# File 'lib/sequel/timezones.rb', line 32

def application_timezone
  @application_timezone
end

#convert_two_digit_years ⇒ Object

Sequel converts two digit years in Dates and DateTimes by default, so 01/02/03 is interpreted at January 2nd, 2003, and 12/13/99 is interpreted as December 13, 1999. You can override this to treat those dates as January 2nd, 0003 and December 13, 0099, respectively, by:

Sequel.convert_two_digit_years = false



48
49
50
 
# File 'lib/sequel/core.rb', line 48

def convert_two_digit_years
  @convert_two_digit_years
end

#database_timezone ⇒ Object (readonly)

The timezone for storage in the database. This is the timezone to which Sequel will convert timestamps before literalizing them for storage in the database. It is also the timezone that Sequel will assume database timestamp values are already in (if they don’t include an offset).



38
39
40
 
# File 'lib/sequel/timezones.rb', line 38

def database_timezone
  @database_timezone
end

#datetime_class ⇒ Object

Sequel can use either Time or DateTime for times returned from the database. It defaults to Time. To change it to DateTime:

Sequel.datetime_class = DateTime

Note that Time and DateTime objects have a different API, and in cases where they implement the same methods, they often implement them differently (e.g. + using seconds on Time and days on DateTime).



58
59
60
 
# File 'lib/sequel/core.rb', line 58

def datetime_class
  @datetime_class
end

#single_threaded ⇒ Object

Set whether Sequel is being used in single threaded mode. By default, Sequel uses a thread-safe connection pool, which isn’t as fast as the single threaded connection pool, and also has some additional thread safety checks. If your program will only have one thread, and speed is a priority, you should set this to true:

Sequel.single_threaded = true



67
68
69
 
# File 'lib/sequel/core.rb', line 67

def single_threaded
  @single_threaded
end

#typecast_timezone ⇒ Object (readonly)

The timezone that incoming data that Sequel needs to typecast is assumed to be already in (if they don’t include an offset).



42
43
44
 
# File 'lib/sequel/timezones.rb', line 42

def typecast_timezone
  @typecast_timezone
end

Instance Method Details

#application_to_database_timestamp(v) ⇒ Object

Convert the given Time/DateTime object into the database timezone, used when literalizing objects in an SQL string.



50
51
52
 
# File 'lib/sequel/timezones.rb', line 50

def application_to_database_timestamp(v)
  convert_output_timestamp(v, Sequel.database_timezone)
end

#condition_specifier?(obj) ⇒ Boolean

Returns true if the passed object could be a specifier of conditions, false otherwise. Currently, Sequel considers hashes and arrays of two element arrays as condition specifiers.

Sequel.condition_specifier?({}) # => true
Sequel.condition_specifier?([[1, 2]]) # => true
Sequel.condition_specifier?([]) # => false
Sequel.condition_specifier?([1]) # => false
Sequel.condition_specifier?(1) # => false

Returns:

  • (Boolean) 


83
84
85
86
87
88
89
90
91
92
 
# File 'lib/sequel/core.rb', line 83

def condition_specifier?(obj)
  case obj
  when Hash
    true
  when Array
    !obj.empty? && !obj.is_a?(SQL::ValueList) && obj.all?{|i| i.is_a?(Array) && (i.length == 2)}
  else
    false
  end
end

#connect(*args, &block) ⇒ Object

Creates a new database object based on the supplied connection string and optional arguments. The specified scheme determines the database class used, and the rest of the string specifies the connection options. For example:

DB = Sequel.connect('sqlite:/') # Memory database
DB = Sequel.connect('sqlite://blog.db') # ./blog.db
DB = Sequel.connect('sqlite:///blog.db') # /blog.db
DB = Sequel.connect('postgres://user:password@host:port/database_name')
DB = Sequel.connect('sqlite:///blog.db', max_connections: 10)

You can also pass a single options hash:

DB = Sequel.connect(adapter: 'sqlite', database: './blog.db')

If a block is given, it is passed the opened Database object, which is closed when the block exits. For example:

Sequel.connect('sqlite://blog.db'){|db| puts db[:users].count}

If a block is not given, a reference to this database will be held in Sequel::DATABASES until it is removed manually. This is by design, and used by Sequel::Model to pick the default database. It is recommended to pass a block if you do not want the resulting Database object to remain in memory until the process terminates, or use the keep_reference: false Database option.

For details, see the “Connecting to a Database” guide. To set up a primary/replica or sharded database connection, see the “Primary/Replica Database Configurations and Sharding” guide.



123
124
125
 
# File 'lib/sequel/core.rb', line 123

def connect(*args, &block)
  Database.connect(*args, &block)
end

#convert_exception_class(exception, klass) ⇒ Object

Convert the exception to the given class. The given class should be Sequel::Error or a subclass. Returns an instance of klass with the message and backtrace of exception.



136
137
138
139
140
141
142
 
# File 'lib/sequel/core.rb', line 136

def convert_exception_class(exception, klass)
  return exception if exception.is_a?(klass)
  e = klass.new("#{exception.class}: #{exception.message}")
  e.wrapped_exception = exception
  e.set_backtrace(exception.backtrace)
  e
end

#convert_output_timestamp(v, output_timezone) ⇒ Object

Converts the object to the given output_timezone.



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
 
# File 'lib/sequel/timezones.rb', line 55

def convert_output_timestamp(v, output_timezone)
  if output_timezone
    if v.is_a?(DateTime)
      case output_timezone
      when :utc
        v.new_offset(0)
      when :local
        v.new_offset(local_offset_for_datetime(v))
      else
        convert_output_datetime_other(v, output_timezone)
      end
    else
      case output_timezone
      when :utc
        v.getutc
      when :local
        v.getlocal
      else
        convert_output_time_other(v, output_timezone)
      end
    end
  else
    v
  end
end

#convert_timestamp(v, input_timezone) ⇒ Object

Converts the given object from the given input timezone to the application_timezone using convert_input_timestamp and convert_output_timestamp.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/sequel/timezones.rb', line 84

def convert_timestamp(v, input_timezone)
  if v.is_a?(Date) && !v.is_a?(DateTime)
    # Dates handled specially as they are assumed to already be in the application_timezone
    if datetime_class == DateTime
      DateTime.civil(v.year, v.month, v.day, 0, 0, 0, application_timezone == :local ? Rational(Time.local(v.year, v.month, v.day).utc_offset, 86400) : 0)
    else
      Time.public_send(application_timezone == :utc ? :utc : :local, v.year, v.month, v.day)
    end
  else
    convert_output_timestamp(convert_input_timestamp(v, input_timezone), application_timezone)
  end
rescue InvalidValue
  raise
rescue => e
  raise convert_exception_class(e, InvalidValue)
end

#core_extensions? ⇒ Boolean

Assume the core extensions are not loaded by default, if the core_extensions extension is loaded, this will be overridden.

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/sequel/core.rb', line 129

def core_extensions?
  false
end

#current ⇒ Object

The current concurrency primitive, Thread.current by default.



145
146
147
 
# File 'lib/sequel/core.rb', line 145

def current
  Thread.current
end

#database_to_application_timestamp(v) ⇒ Object

Convert the given object into an object of Sequel.datetime_class in the application_timezone. Used when converting datetime/timestamp columns returned by the database.



104
105
106
 
# File 'lib/sequel/timezones.rb', line 104

def database_to_application_timestamp(v)
  convert_timestamp(v, Sequel.database_timezone)
end

#default_timezone=(tz) ⇒ Object

Sets the database, application, and typecasting timezones to the given timezone.



109
110
111
112
113
 
# File 'lib/sequel/timezones.rb', line 109

def default_timezone=(tz)
  self.database_timezone = tz
  self.application_timezone = tz
  self.typecast_timezone = tz
end

#elapsed_seconds_since(timer) ⇒ Object

The elapsed seconds since the given timer object was created. The timer object should have been created via Sequel.start_timer.



335
336
337
 
# File 'lib/sequel/core.rb', line 335

def elapsed_seconds_since(timer)
  start_timer - timer
end

#extension(*extensions) ⇒ Object

Load all Sequel extensions given. Extensions are just files that exist under sequel/extensions in the load path, and are just required.

In some cases, requiring an extension modifies classes directly, and in others, it just loads a module that you can extend other classes with. Consult the documentation for each extension you plan on using for usage.

Sequel.extension(:blank)
Sequel.extension(:core_extensions, :named_timezones)



157
158
159
 
# File 'lib/sequel/core.rb', line 157

def extension(*extensions)
  extensions.each{|e| orig_require("sequel/extensions/#{e}")}
end

#json_parser_error_class ⇒ Object

The exception classed raised if there is an error parsing JSON. This can be overridden to use an alternative json implementation.



163
164
165
 
# File 'lib/sequel/core.rb', line 163

def json_parser_error_class
  JSON::ParserError
end

#object_to_json(obj, *args, &block) ⇒ Object

Convert given object to json and return the result. This can be overridden to use an alternative json implementation.



169
170
171
 
# File 'lib/sequel/core.rb', line 169

def object_to_json(obj, *args, &block)
  obj.to_json(*args, &block)
end

#parse_json(json) ⇒ Object

Parse the string as JSON and return the result. This can be overridden to use an alternative json implementation.



175
176
177
 
# File 'lib/sequel/core.rb', line 175

def parse_json(json)
  JSON.parse(json, :create_additions=>false)
end

#recursive_map(array, converter) ⇒ Object

Convert each item in the array to the correct type, handling multi-dimensional arrays. For each element in the array or subarrays, call the converter, unless the value is nil.



193
194
195
196
197
198
199
200
201
 
# File 'lib/sequel/core.rb', line 193

def recursive_map(array, converter)
  array.map do |i|
    if i.is_a?(Array)
      recursive_map(i, converter)
    elsif !i.nil?
      converter.call(i)
    end
  end
end

#require(files, subdir = nil) ⇒ Object

For backwards compatibility only. require_relative should be used instead.



204
205
206
207
 
# File 'lib/sequel/core.rb', line 204

def require(files, subdir=nil)
  # Use Kernel.require_relative to work around JRuby 9.0 bug
  Array(files).each{|f| Kernel.require_relative "#{"#{subdir}/" if subdir}#{f}"}
end

#split_symbol(sym) ⇒ Object

Splits the symbol into three parts, if symbol splitting is enabled (not the default). Each part will either be a string or nil. If symbol splitting is disabled, returns an array with the first and third parts being nil, and the second part beind a string version of the symbol.

For columns, these parts are the table, column, and alias. For tables, these parts are the schema, table, and alias.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/sequel/core.rb', line 216

def split_symbol(sym)
  unless v = Sequel.synchronize{SPLIT_SYMBOL_CACHE[sym]}
    if split_symbols?
      v = case s = sym.to_s
      when /\A((?:(?!__).)+)__((?:(?!___).)+)___(.+)\z/
        [$1.freeze, $2.freeze, $3.freeze].freeze
      when /\A((?:(?!___).)+)___(.+)\z/
        [nil, $1.freeze, $2.freeze].freeze
      when /\A((?:(?!__).)+)__(.+)\z/
        [$1.freeze, $2.freeze, nil].freeze
      else
        [nil, s.freeze, nil].freeze
      end
    else
      v = [nil,sym.to_s.freeze,nil].freeze
    end
    Sequel.synchronize{SPLIT_SYMBOL_CACHE[sym] = v}
  end
  v
end

#split_symbols=(v) ⇒ Object

Setting this to true enables Sequel’s historical behavior of splitting symbols on double or triple underscores:

:table__column         # table.column
:column___alias        # column AS alias
:table__column___alias # table.column AS alias

It is only recommended to turn this on for backwards compatibility until such symbols have been converted to use newer Sequel APIs such as:

Sequel[:table][:column]            # table.column
Sequel[:column].as(:alias)         # column AS alias
Sequel[:table][:column].as(:alias) # table.column AS alias

Sequel::Database instances do their own caching of literalized symbols, and changing this setting does not affect those caches. It is recommended that if you want to change this setting, you do so directly after requiring Sequel, before creating any Sequel::Database instances.

Disabling symbol splitting will also disable the handling of double underscores in virtual row methods, causing such methods to yield regular identifers instead of qualified identifiers:

# Sequel.split_symbols = true
Sequel.expr{table__column}  # table.column
Sequel.expr{table[:column]} # table.column

# Sequel.split_symbols = false
Sequel.expr{table__column}  # table__column
Sequel.expr{table[:column]} # table.column



267
268
269
270
 
# File 'lib/sequel/core.rb', line 267

def split_symbols=(v)
  Sequel.synchronize{SPLIT_SYMBOL_CACHE.clear}
  @split_symbols = v
end

#split_symbols? ⇒ Boolean

Whether Sequel currently splits symbols into qualified/aliased identifiers.

Returns:

  • (Boolean) 


273
274
275
 
# File 'lib/sequel/core.rb', line 273

def split_symbols?
  @split_symbols
end

#start_timer ⇒ Object

:nocov:



322
323
324
 
# File 'lib/sequel/core.rb', line 322

def start_timer
  Process.clock_gettime(Process::CLOCK_MONOTONIC)
end

#string_to_date(string) ⇒ Object

Converts the given string into a Date object.

Sequel.string_to_date('2010-09-10') # Date.civil(2010, 09, 10)



280
281
282
283
284
 
# File 'lib/sequel/core.rb', line 280

def string_to_date(string)
  Date.parse(string, Sequel.convert_two_digit_years)
rescue => e
  raise convert_exception_class(e, InvalidValue)
end

#string_to_datetime(string) ⇒ Object

Converts the given string into a Time or DateTime object, depending on the value of Sequel.datetime_class.

Sequel.string_to_datetime('2010-09-10 10:20:30') # Time.local(2010, 09, 10, 10, 20, 30)



290
291
292
293
294
295
296
297
298
 
# File 'lib/sequel/core.rb', line 290

def string_to_datetime(string)
  if datetime_class == DateTime
    DateTime.parse(string, convert_two_digit_years)
  else
    datetime_class.parse(string)
  end
rescue => e
  raise convert_exception_class(e, InvalidValue)
end

#string_to_time(string) ⇒ Object

Converts the given string into a Sequel::SQLTime object.

v = Sequel.string_to_time('10:20:30') # Sequel::SQLTime.parse('10:20:30')
DB.literal(v) # => '10:20:30'



304
305
306
307
308
 
# File 'lib/sequel/core.rb', line 304

def string_to_time(string)
  SQLTime.parse(string)
rescue => e
  raise convert_exception_class(e, InvalidValue)
end

#synchronize(&block) ⇒ Object

Unless in single threaded mode, protects access to any mutable global data structure in Sequel. Uses a non-reentrant mutex, so calling code should be careful. In general, this should only be used around the minimal possible code such as Hash#[], Hash#[]=, Hash#delete, Array#<<, and Array#delete.



315
316
317
 
# File 'lib/sequel/core.rb', line 315

def synchronize(&block)
  @single_threaded ? yield : @data_mutex.synchronize(&block)
end

#synchronize_with(mutex) ⇒ Object

If a mutex is given, synchronize access using it. If nil is given, just yield to the block. This is designed for cases where a mutex may or may not be provided.



182
183
184
185
186
187
188
 
# File 'lib/sequel/core.rb', line 182

def synchronize_with(mutex)
  if mutex
    mutex.synchronize{yield}
  else
    yield
  end
end

#transaction(dbs, opts = OPTS, &block) ⇒ Object

Uses a transaction on all given databases with the given options. This:

Sequel.transaction([DB1, DB2, DB3]){}

is equivalent to:

DB1.transaction do
  DB2.transaction do
    DB3.transaction do
    end
  end
end

except that if Sequel::Rollback is raised by the block, the transaction is rolled back on all databases instead of just the last one.

Note that this method cannot guarantee that all databases will commit or rollback. For example, if DB3 commits but attempting to commit on DB2 fails (maybe because foreign key checks are deferred), there is no way to uncommit the changes on DB3. For that kind of support, you need to have two-phase commit/prepared transactions (which Sequel supports on some databases).



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/sequel/core.rb', line 361

def transaction(dbs, opts=OPTS, &block)
  unless opts[:rollback]
    rescue_rollback = true
    opts = Hash[opts].merge!(:rollback=>:reraise)
  end
  pr = dbs.reverse.inject(block){|bl, db| proc{db.transaction(opts, &bl)}}
  if rescue_rollback
    begin
      pr.call
    rescue Sequel::Rollback
      nil
    end
  else
    pr.call
  end
end

#typecast_to_application_timestamp(v) ⇒ Object

Convert the given object into an object of Sequel.datetime_class in the application_timezone. Used when typecasting values when assigning them to model datetime attributes.



118
119
120
 
# File 'lib/sequel/timezones.rb', line 118

def typecast_to_application_timestamp(v)
  convert_timestamp(v, Sequel.typecast_timezone)
end

#virtual_row(&block) ⇒ Object

If the supplied block takes a single argument, yield an SQL::VirtualRow instance to the block argument. Otherwise, evaluate the block in the context of a SQL::VirtualRow instance.

Sequel.virtual_row{a} # Sequel::SQL::Identifier.new(:a)
Sequel.virtual_row{|o| o.a} # Sequel::SQL::Function.new(:a)



385
386
387
388
389
390
391
392
393
 
# File 'lib/sequel/core.rb', line 385

def virtual_row(&block)
  vr = VIRTUAL_ROW
  case block.arity
  when -1, 0
    vr.instance_exec(&block)
  else
    block.call(vr)
  end  
end