Module: Sequel::Timezones

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

Overview

Sequel doesn't pay much attention to timezones by default, but you can set it handle timezones if you want. There are three separate timezone settings, application_timezone, database_timezone, and 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

- (Object) application_timezone (readonly)

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



20
21
22
# File 'lib/sequel/timezones.rb', line 20

def application_timezone
  @application_timezone
end

- (Object) database_timezone (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).



26
27
28
# File 'lib/sequel/timezones.rb', line 26

def database_timezone
  @database_timezone
end

- (Object) typecast_timezone (readonly)

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



30
31
32
# File 'lib/sequel/timezones.rb', line 30

def typecast_timezone
  @typecast_timezone
end

Instance Method Details

- (Object) application_to_database_timestamp(v)

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



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

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

- (Object) convert_output_timestamp(v, output_timezone)

Converts the object to the given output_timezone.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/sequel/timezones.rb', line 43

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
      v.send(output_timezone == :utc ? :getutc : :getlocal)
    end
  else
    v
  end
end

- (Object) convert_timestamp(v, input_timezone)

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/sequel/timezones.rb', line 65

def convert_timestamp(v, input_timezone)
  begin
    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 ? (defined?(Rational) ? Rational(Time.local(v.year, v.month, v.day).utc_offset, 86400) : Time.local(v.year, v.month, v.day).utc_offset/86400.0) : 0)
      else
        Time.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
end

- (Object) database_to_application_timestamp(v)

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.



87
88
89
# File 'lib/sequel/timezones.rb', line 87

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

- (Object) default_timezone=(tz)

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



92
93
94
95
96
# File 'lib/sequel/timezones.rb', line 92

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

- (Object) typecast_to_application_timestamp(v)

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.



101
102
103
# File 'lib/sequel/timezones.rb', line 101

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