Module: Sequel

Extended by:
NamedTimezones, ThreadLocalTimezones, Timezones
Includes:
SQL::Constants
Defined in:
lib/sequel/lib/sequel/core.rb,
lib/sequel/lib/sequel/sql.rb,
lib/sequel/lib/sequel/model.rb,
lib/sequel/lib/sequel/dataset.rb,
lib/sequel/lib/sequel/version.rb,
lib/sequel/lib/sequel/database.rb,
lib/sequel/lib/sequel/timezones.rb,
lib/sequel/lib/sequel/exceptions.rb,
lib/sequel/lib/sequel/model/base.rb,
lib/sequel/lib/sequel/adapters/do.rb,
lib/sequel/lib/sequel/dataset/sql.rb,
lib/sequel/lib/sequel/adapters/dbi.rb,
lib/sequel/lib/sequel/adapters/ado.rb,
lib/sequel/lib/sequel/adapters/db2.rb,
lib/sequel/lib/sequel/model/errors.rb,
lib/sequel/lib/sequel/model/plugins.rb,
lib/sequel/lib/sequel/plugins/touch.rb,
lib/sequel/lib/sequel/dataset/graph.rb,
lib/sequel/lib/sequel/adapters/odbc.rb,
lib/sequel/lib/sequel/adapters/jdbc.rb,
lib/sequel/lib/sequel/adapters/mysql.rb,
lib/sequel/lib/sequel/plugins/schema.rb,
lib/sequel/lib/sequel/metaprogramming.rb,
lib/sequel/lib/sequel/adapters/oracle.rb,
lib/sequel/lib/sequel/adapters/sqlite.rb,
lib/sequel/lib/sequel/plugins/caching.rb,
lib/sequel/lib/sequel/adapters/jdbc/h2.rb,
lib/sequel/lib/sequel/extensions/query.rb,
lib/sequel/lib/sequel/model/exceptions.rb,
lib/sequel/lib/sequel/adapters/informix.rb,
lib/sequel/lib/sequel/adapters/postgres.rb,
lib/sequel/lib/sequel/adapters/firebird.rb,
lib/sequel/lib/sequel/model/inflections.rb,
lib/sequel/lib/sequel/adapters/openbase.rb,
lib/sequel/lib/sequel/adapters/do/mysql.rb,
lib/sequel/lib/sequel/adapters/do/sqlite.rb,
lib/sequel/lib/sequel/adapters/ado/mssql.rb,
lib/sequel/lib/sequel/plugins/timestamps.rb,
lib/sequel/lib/sequel/plugins/subclasses.rb,
lib/sequel/lib/sequel/model/associations.rb,
lib/sequel/lib/sequel/adapters/odbc/mssql.rb,
lib/sequel/lib/sequel/dataset/convenience.rb,
lib/sequel/lib/sequel/database/schema_sql.rb,
lib/sequel/lib/sequel/extensions/sql_expr.rb,
lib/sequel/lib/sequel/adapters/amalgalite.rb,
lib/sequel/lib/sequel/adapters/jdbc/mysql.rb,
lib/sequel/lib/sequel/adapters/jdbc/mssql.rb,
lib/sequel/lib/sequel/adapters/jdbc/oracle.rb,
lib/sequel/lib/sequel/adapters/jdbc/sqlite.rb,
lib/sequel/lib/sequel/adapters/do/postgres.rb,
lib/sequel/lib/sequel/plugins/identity_map.rb,
lib/sequel/lib/sequel/plugins/active_model.rb,
lib/sequel/lib/sequel/extensions/migration.rb,
lib/sequel/lib/sequel/adapters/shared/mysql.rb,
lib/sequel/lib/sequel/extensions/pagination.rb,
lib/sequel/lib/sequel/plugins/serialization.rb,
lib/sequel/lib/sequel/adapters/shared/sqlite.rb,
lib/sequel/lib/sequel/plugins/instance_hooks.rb,
lib/sequel/lib/sequel/adapters/shared/oracle.rb,
lib/sequel/lib/sequel/plugins/force_encoding.rb,
lib/sequel/lib/sequel/plugins/boolean_readers.rb,
lib/sequel/lib/sequel/plugins/lazy_attributes.rb,
lib/sequel/lib/sequel/database/schema_methods.rb,
lib/sequel/lib/sequel/extensions/pretty_table.rb,
lib/sequel/lib/sequel/plugins/typecast_on_load.rb,
lib/sequel/lib/sequel/extensions/schema_dumper.rb,
lib/sequel/lib/sequel/adapters/shared/progress.rb,
lib/sequel/lib/sequel/adapters/shared/postgres.rb,
lib/sequel/lib/sequel/adapters/jdbc/postgresql.rb,
lib/sequel/lib/sequel/plugins/many_through_many.rb,
lib/sequel/lib/sequel/plugins/nested_attributes.rb,
lib/sequel/lib/sequel/database/schema_generator.rb,
lib/sequel/lib/sequel/model/default_inflections.rb,
lib/sequel/lib/sequel/extensions/named_timezones.rb,
lib/sequel/lib/sequel/plugins/validation_helpers.rb,
lib/sequel/lib/sequel/plugins/hook_class_methods.rb,
lib/sequel/lib/sequel/plugins/association_proxies.rb,
lib/sequel/lib/sequel/dataset/prepared_statements.rb,
lib/sequel/lib/sequel/extensions/looser_typecasting.rb,
lib/sequel/lib/sequel/plugins/tactical_eager_loading.rb,
lib/sequel/lib/sequel/plugins/class_table_inheritance.rb,
lib/sequel/lib/sequel/plugins/validation_class_methods.rb,
lib/sequel/lib/sequel/adapters/utils/stored_procedures.rb,
lib/sequel/lib/sequel/plugins/association_dependencies.rb,
lib/sequel/lib/sequel/plugins/single_table_inheritance.rb,
lib/sequel/lib/sequel/extensions/thread_local_timezones.rb

Overview

The thread_local_timezones extension allows you to set a per-thread timezone that will override the default global timezone while the thread is executing. The main use case is for web applications that execute each request in its own thread, and want to set the timezones based on the request. The most common example is having the database always store time in UTC, but have the application deal with the timezone of the current user. That can be done with:

Sequel.database_timezone = :utc
# In each thread:
Sequel.thread_application_timezone = current_user.timezone

This extension is designed to work with the named_timezones extension.

This extension adds the thread_application_timezone=, thread_database_timezone=, and thread_typecast_timezone= methods to the Sequel module. It overrides the application_timezone, database_timezone, and typecast_timezone methods to check the related thread local timezone first, and use it if present. If the related thread local timezone is not present, it falls back to the default global timezone.

There is one special case of note. If you have a default global timezone and you want to have a nil thread local timezone, you have to set the thread local value to :nil instead of nil:

Sequel.application_timezone = :utc
Sequel.thread_application_timezone = nil
Sequel.application_timezone # => :utc
Sequel.thread_application_timezone = :nil
Sequel.application_timezone # => nil

Defined Under Namespace

Modules: ADO, Amalgalite, DB2, DBI, DataObjects, Firebird, Inflections, Informix, JDBC, LooserTypecasting, Metaprogramming, Migrator, MySQL, NamedTimezones, ODBC, OpenBase, Oracle, Plugins, Postgres, PrettyTable, Progress, SQL, SQLite, Schema, ThreadLocalTimezones, Timezones Classes: AdapterNotFound, BasicObject, BeforeHookFailed, ConnectionPool, Database, DatabaseConnectionError, DatabaseDisconnectError, DatabaseError, Dataset, Error, InvalidOperation, InvalidValue, LiteralString, Migration, Model, PoolTimeout, Rollback, SingleThreadedPool, ValidationFailed

Constant Summary collapse

MAJOR =
3
MINOR =
5
TINY =
0
VERSION =
[MAJOR, MINOR, TINY].join('.')
ADAPTER_MAP =

Hash of adapters that have been used. The key is the adapter scheme symbol, and the value is the Database subclass.

{}
DATABASES =

Array of all databases to which Sequel has connected. If you are developing an application that can connect to an arbitrary number of databases, delete the database objects from this or they will not get garbage collected.

[]
LOCAL_DATETIME_OFFSET_SECS =

The offset of the current time zone from UTC, in seconds.

Time.now.utc_offset
LOCAL_DATETIME_OFFSET =

The offset of the current time zone from UTC, as a fraction of a day.

respond_to?(:Rational, true) ? Rational(LOCAL_DATETIME_OFFSET_SECS, 60*60*24) : LOCAL_DATETIME_OFFSET_SECS/60/60/24.0
DEFAULT_INFLECTIONS_PROC =

Proc that is instance evaled to create the default inflections for both the model inflector and the inflector extension.

lambda do
  plural(/$/, 's')
  plural(/s$/i, 's')
  plural(/(alias|(?:stat|octop|vir|b)us)$/i, '\1es')
  plural(/(buffal|tomat)o$/i, '\1oes')
  plural(/([ti])um$/i, '\1a')
  plural(/sis$/i, 'ses')
  plural(/(?:([^f])fe|([lr])f)$/i, '\1\2ves')
  plural(/(hive)$/i, '\1s')
  plural(/([^aeiouy]|qu)y$/i, '\1ies')
  plural(/(x|ch|ss|sh)$/i, '\1es')
  plural(/(matr|vert|ind)ix|ex$/i, '\1ices')
  plural(/([m|l])ouse$/i, '\1ice')

  singular(/s$/i, '')
  singular(/([ti])a$/i, '\1um')
  singular(/(analy|ba|cri|diagno|parenthe|progno|synop|the)ses$/i, '\1sis')
  singular(/([^f])ves$/i, '\1fe')
  singular(/([h|t]ive)s$/i, '\1')
  singular(/([lr])ves$/i, '\1f')
  singular(/([^aeiouy]|qu)ies$/i, '\1y')
  singular(/(m)ovies$/i, '\1ovie')
  singular(/(x|ch|ss|sh)es$/i, '\1')
  singular(/([m|l])ice$/i, '\1ouse')
  singular(/buses$/i, 'bus')
  singular(/oes$/i, 'o')
  singular(/shoes$/i, 'shoe')
  singular(/(alias|(?:stat|octop|vir|b)us)es$/i, '\1')
  singular(/(vert|ind)ices$/i, '\1ex')
  singular(/matrices$/i, 'matrix')

  irregular('person', 'people')
  irregular('man', 'men')
  irregular('child', 'children')
  irregular('sex', 'sexes')
  irregular('move', 'moves')
  irregular('ox', 'oxen')
  irregular('quiz', 'quizzes')
  irregular('testis', 'testes')

  uncountable(%w(equipment information rice money species series fish sheep news))
end

Constants included from SQL::Constants

SQL::Constants::CURRENT_DATE, SQL::Constants::CURRENT_TIME, SQL::Constants::CURRENT_TIMESTAMP

Class Attribute Summary collapse

Attributes included from Timezones

#application_timezone, #database_timezone, #typecast_timezone

Class Method Summary collapse

Methods included from Timezones

application_to_database_timestamp, database_to_application_timestamp, default_timezone=, typecast_to_application_timestamp

Class Attribute Details

.convert_two_digit_yearsObject

Returns the value of attribute convert_two_digit_years



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

def convert_two_digit_years
  @convert_two_digit_years
end

.datetime_classObject

Returns the value of attribute datetime_class



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

def datetime_class
  @datetime_class
end

.virtual_row_instance_evalObject

Returns the value of attribute virtual_row_instance_eval



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

def virtual_row_instance_eval
  @virtual_row_instance_eval
end

Class Method Details

.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 all two pairs as condition specifiers.

Returns:

  • (Boolean)


73
74
75
76
77
78
79
80
81
82
# File 'lib/sequel/lib/sequel/core.rb', line 73

def self.condition_specifier?(obj)
  case obj
  when Hash
    true
  when Array
    !obj.empty? && obj.all?{|i| (Array === i) && (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)

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}


99
100
101
# File 'lib/sequel/lib/sequel/core.rb', line 99

def self.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.



106
107
108
109
110
111
112
# File 'lib/sequel/lib/sequel/core.rb', line 106

def self.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

.extension(*extensions) ⇒ Object

Load all Sequel extensions given. Only loads extensions included in this release of Sequel, doesn't load external extensions.

Sequel.extension(:schema_dumper)
Sequel.extension(:pagination, :query)


119
120
121
# File 'lib/sequel/lib/sequel/core.rb', line 119

def self.extension(*extensions)
  require(extensions, 'extensions')
end

.identifier_input_method=(value) ⇒ Object

Set the method to call on identifiers going into the database. This affects the literalization of identifiers by calling this method on them before they are input. Sequel upcases identifiers in all SQL strings for most databases, so to turn that off:

Sequel.identifier_input_method = nil

to downcase instead:

Sequel.identifier_input_method = :downcase

Other String instance methods work as well.



134
135
136
# File 'lib/sequel/lib/sequel/core.rb', line 134

def self.identifier_input_method=(value)
  Database.identifier_input_method = value
end

.identifier_output_method=(value) ⇒ Object

Set the method to call on identifiers coming out of the database. This affects the literalization of identifiers by calling this method on them when they are retrieved from the database. Sequel downcases identifiers retrieved for most databases, so to turn that off:

Sequel.identifier_output_method = nil

to upcase instead:

Sequel.identifier_output_method = :upcase

Other String instance methods work as well.



150
151
152
# File 'lib/sequel/lib/sequel/core.rb', line 150

def self.identifier_output_method=(value)
  Database.identifier_output_method = value
end

.inflections {|Inflections| ... } ⇒ Object

Yield the Inflections module if a block is given, and return the Inflections module.

Yields:



4
5
6
7
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 4

def self.inflections
  yield Inflections if block_given?
  Inflections
end

.Model(source) ⇒ Object

Lets you create a Model subclass with its dataset already set. source can be an existing dataset or a symbol (in which case it will create a dataset using the default database with the given symbol as the table name).

The purpose of this method is to set the dataset automatically for a model class, if the table name doesn't match the implicit name. This is neater than using set_dataset inside the class, doesn't require a bogus query for the schema, and allows it to work correctly in a system that uses code reloading.

Example:

class Comment < Sequel::Model(:something)
  table_name # => :something
end


19
20
21
22
23
24
25
26
27
# File 'lib/sequel/lib/sequel/model.rb', line 19

def self.Model(source)
  Model::ANONYMOUS_MODEL_CLASSES[source] ||= if source.is_a?(Database)
    c = Class.new(Model)
    c.db = source
    c
  else
    Class.new(Model).set_dataset(source)
  end
end

.quote_identifiers=(value) ⇒ Object

Set whether to quote identifiers for all databases by default. By default, Sequel quotes identifiers in all SQL strings, so to turn that off:

Sequel.quote_identifiers = false


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

def self.quote_identifiers=(value)
  Database.quote_identifiers = value
end

.require(files, subdir = nil) ⇒ Object

Require all given files which should be in the same or a subdirectory of this file. If a subdir is given, assume all files are in that subdir.



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

def self.require(files, subdir=nil)
  Array(files).each{|f| super("#{File.dirname(__FILE__)}/#{"#{subdir}/" if subdir}#{f}")}
end

.single_threaded=(value) ⇒ Object

Set whether to set the single threaded mode for all databases by default. By default, Sequel uses a threadsafe connection pool, which isn't as fast as the single threaded connection pool. If your program will only have one thread, and speed is a priority, you may want to set this to true:

Sequel.single_threaded = true


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

def self.single_threaded=(value)
  Database.single_threaded = value
end

.string_to_date(s) ⇒ Object

Converts the given string into a Date object.



179
180
181
182
183
184
185
# File 'lib/sequel/lib/sequel/core.rb', line 179

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

.string_to_datetime(s) ⇒ Object

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



189
190
191
192
193
194
195
196
197
198
199
# File 'lib/sequel/lib/sequel/core.rb', line 189

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

.string_to_time(s) ⇒ Object

Converts the given string into a Time object.



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

def self.string_to_time(s)
  begin
    Time.parse(s)
  rescue => e
    raise convert_exception_class(e, InvalidValue)
  end
end

.versionObject

The version of Sequel you are using, as a string (e.g. “2.11.0”)



9
10
11
# File 'lib/sequel/lib/sequel/version.rb', line 9

def self.version
  VERSION
end

.virtual_row(&block) ⇒ Object

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



214
215
216
217
218
219
220
221
222
# File 'lib/sequel/lib/sequel/core.rb', line 214

def self.virtual_row(&block)
  vr = SQL::VirtualRow.new
  case block.arity
  when -1, 0
    vr.instance_eval(&block)
  else
    block.call(vr)
  end  
end