Module Sequel::Timezones
In: lib/sequel/timezones.rb

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.

Methods

Attributes

application_timezone  [R]  The timezone you want the application to use. This is the timezone that incoming times from the database and typecasting are converted to.
database_timezone  [R]  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).
typecast_timezone  [R]  The timezone that incoming data that Sequel needs to typecast is assumed to be already in (if they don‘t include an offset).

Public Instance methods

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

[Source]

    # File lib/sequel/timezones.rb, line 40
40:     def application_to_database_timestamp(v)
41:       convert_output_timestamp(v, Sequel.database_timezone)
42:     end

Converts the object to the given output_timezone.

[Source]

    # File lib/sequel/timezones.rb, line 45
45:     def convert_output_timestamp(v, output_timezone)
46:       if output_timezone
47:         if v.is_a?(DateTime)
48:           case output_timezone
49:           when :utc
50:             v.new_offset(0)
51:           when :local
52:             v.new_offset(local_offset_for_datetime(v))
53:           else
54:             convert_output_datetime_other(v, output_timezone)
55:           end
56:         else
57:           v.public_send(output_timezone == :utc ? :getutc : :getlocal)
58:         end
59:       else
60:         v
61:       end
62:     end

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

[Source]

    # File lib/sequel/timezones.rb, line 67
67:     def convert_timestamp(v, input_timezone)
68:       begin
69:         if v.is_a?(Date) && !v.is_a?(DateTime)
70:           # Dates handled specially as they are assumed to already be in the application_timezone
71:           if datetime_class == DateTime
72:             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)
73:           else
74:             Time.public_send(application_timezone == :utc ? :utc : :local, v.year, v.month, v.day)
75:           end
76:         else
77:           convert_output_timestamp(convert_input_timestamp(v, input_timezone), application_timezone)
78:         end
79:       rescue InvalidValue
80:         raise
81:       rescue => e
82:         raise convert_exception_class(e, InvalidValue)
83:       end
84:     end

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.

[Source]

    # File lib/sequel/timezones.rb, line 89
89:     def database_to_application_timestamp(v)
90:       convert_timestamp(v, Sequel.database_timezone)
91:     end

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

[Source]

    # File lib/sequel/timezones.rb, line 94
94:     def default_timezone=(tz)
95:       self.database_timezone = tz
96:       self.application_timezone = tz
97:       self.typecast_timezone = tz
98:     end

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.

[Source]

     # File lib/sequel/timezones.rb, line 103
103:     def typecast_to_application_timestamp(v)
104:       convert_timestamp(v, Sequel.typecast_timezone)
105:     end

[Validate]