Module: Sequel

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

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

### Methods

Model condition_specifier? connect convert_exception_class extension identifier_input_method= identifier_output_method= inflections load_gem quote_identifiers= require single_threaded= string_to_date string_to_datetime string_to_time version virtual_row

### Included Modules

SQL::Constants

### Classes and Modules

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

### Constants

SELECT_SERIAL_SEQUENCE | = | proc do |schema, table| <<-end_sql SELECT '"' || name.nspname || '".' || seq.relname || '' FROM pg_class seq, pg_attribute attr, pg_depend dep, pg_namespace name, pg_constraint cons WHERE seq.oid = dep.objid AND seq.relnamespace = name.oid AND seq.relkind = 'S' AND attr.attrelid = dep.refobjid AND attr.attnum = dep.refobjsubid AND attr.attrelid = cons.conrelid AND attr.attnum = cons.conkey[1] AND cons.contype = 'p' #{"AND name.nspname = '#{schema}'" if schema} AND seq.relname = '#{table}' end_sql
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.
DEFAULT_INFLECTIONS_PROC | = | lambda do plural(/$/, 's') |  | Proc that is instance evaled to create the default inflections for both the model inflector and the inflector extension.
MAJOR | = | 3
MINOR | = | 6
TINY | = | 0
VERSION | = | [MAJOR, MINOR, TINY].join('.')
LOCAL_DATETIME_OFFSET_SECS | = | Time.now.utc_offset |  | The offset of the current time zone from UTC, in seconds.
LOCAL_DATETIME_OFFSET | = | respond_to?(:Rational, true) ? Rational(LOCAL_DATETIME_OFFSET_SECS, 60*60*24) : LOCAL_DATETIME_OFFSET_SECS/60/60/24.0 |  | The offset of the current time zone from UTC, as a fraction of a day.

### Attributes

convert_two_digit_years | [RW] |
datetime_class | [RW] |
virtual_row_instance_eval | [RW] |

### Public Class methods

Model(source)

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

[Source]

        # File lib/sequel/model.rb, line 19
    19:   def self.Model(source)
    20:     Model::ANONYMOUS_MODEL_CLASSES[source] ||= if source.is_a?(Database)
    21:       c = Class.new(Model)
    22:       c.db = source
    23:       c
    24:     else
    25:       Class.new(Model).set_dataset(source)
    26:     end
    27:   end

condition_specifier?(obj)

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.

[Source]

        # File lib/sequel/core.rb, line 73
    73:   def self.condition_specifier?(obj)
    74:     case obj
    75:     when Hash
    76:       true
    77:     when Array
    78:       !obj.empty? && obj.all?{|i| (Array === i) && (i.length == 2)}
    79:     else
    80:       false
    81:     end
    82:   end

connect(*args, &block)

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}

[Source]

         # File lib/sequel/core.rb, line 99
     99:   def self.connect(*args, &block)
    100:     Database.connect(*args, &block)
    101:   end

convert_exception_class(exception, klass)

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.

[Source]

         # File lib/sequel/core.rb, line 106
    106:   def self.convert_exception_class(exception, klass)
    107:     return exception if exception.is_a?(klass)
    108:     e = klass.new("#{exception.class}: #{exception.message}")
    109:     e.wrapped_exception = exception
    110:     e.set_backtrace(exception.backtrace)
    111:     e
    112:   end

extension(*extensions)

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)

[Source]

         # File lib/sequel/core.rb, line 119
    119:   def self.extension(*extensions)
    120:     require(extensions, 'extensions')
    121:   end

identifier_input_method=(value)

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.

[Source]

         # File lib/sequel/core.rb, line 134
    134:   def self.identifier_input_method=(value)
    135:     Database.identifier_input_method = value
    136:   end

identifier_output_method=(value)

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.

[Source]

         # File lib/sequel/core.rb, line 150
    150:   def self.identifier_output_method=(value)
    151:     Database.identifier_output_method = value
    152:   end

inflections() {|Inflections if block_given?| ...}

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

[Source]

       # File lib/sequel/model/inflections.rb, line 4
    4:   def self.inflections
    5:     yield Inflections if block_given?
    6:     Inflections
    7:   end

load_gem(name)

Allowing loading the necessary JDBC support via a gem, which works for PostgreSQL, MySQL, and SQLite.

[Source]

        # File lib/sequel/adapters/jdbc.rb, line 75
    75:     def self.load_gem(name)
    76:       begin
    77:         require "jdbc/#{name}"
    78:       rescue LoadError
    79:         # jdbc gem not used, hopefully the user has the .jar in their CLASSPATH
    80:       end
    81:     end

quote_identifiers=(value)

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

[Source]

         # File lib/sequel/core.rb, line 158
    158:   def self.quote_identifiers=(value)
    159:     Database.quote_identifiers = value
    160:   end

require(files, subdir=nil)

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.

[Source]

         # File lib/sequel/core.rb, line 164
    164:   def self.require(files, subdir=nil)
    165:     Array(files).each{|f| super("#{File.dirname(__FILE__)}/#{"#{subdir}/" if subdir}#{f}")}
    166:   end

single_threaded=(value)

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

[Source]

         # File lib/sequel/core.rb, line 174
    174:   def self.single_threaded=(value)
    175:     Database.single_threaded = value
    176:   end

string_to_date(s)

Converts the given string into a Date object.

[Source]

         # File lib/sequel/core.rb, line 179
    179:   def self.string_to_date(s)
    180:     begin
    181:       Date.parse(s, Sequel.convert_two_digit_years)
    182:     rescue => e
    183:       raise convert_exception_class(e, InvalidValue)
    184:     end
    185:   end

string_to_datetime(s)

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

[Source]

         # File lib/sequel/core.rb, line 189
    189:   def self.string_to_datetime(s)
    190:     begin
    191:       if datetime_class == DateTime
    192:         DateTime.parse(s, convert_two_digit_years)
    193:       else
    194:         datetime_class.parse(s)
    195:       end
    196:     rescue => e
    197:       raise convert_exception_class(e, InvalidValue)
    198:     end
    199:   end

string_to_time(s)

Converts the given string into a Time object.

[Source]

         # File lib/sequel/core.rb, line 202
    202:   def self.string_to_time(s)
    203:     begin
    204:       Time.parse(s)
    205:     rescue => e
    206:       raise convert_exception_class(e, InvalidValue)
    207:     end
    208:   end

version()

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

[Source]

        # File lib/sequel/version.rb, line 9
     9:   def self.version
    10:     VERSION
    11:   end

virtual_row(&block)

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.

[Source]

         # File lib/sequel/core.rb, line 214
    214:   def self.virtual_row(&block)
    215:     vr = SQL::VirtualRow.new
    216:     case block.arity
    217:     when -1, 0
    218:       vr.instance_eval(&block)
    219:     else
    220:       block.call(vr)
    221:     end
    222:   end

[Validate]