Module | Sequel

In:

lib/sequel/adapters/ado.rb
lib/sequel/adapters/ado/mssql.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/mssql.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/as400.rb
lib/sequel/adapters/mysql.rb
lib/sequel/adapters/odbc.rb
lib/sequel/adapters/odbc/mssql.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/mysql2.rb
lib/sequel/adapters/swift.rb
lib/sequel/adapters/swift/mysql.rb
lib/sequel/adapters/swift/postgres.rb
lib/sequel/core.rb
lib/sequel/database.rb
lib/sequel/database/schema_generator.rb
lib/sequel/database/schema_methods.rb
lib/sequel/database/connecting.rb
lib/sequel/database/dataset.rb
lib/sequel/database/dataset_defaults.rb
lib/sequel/database/logging.rb
lib/sequel/database/misc.rb
lib/sequel/database/query.rb
lib/sequel/dataset.rb
lib/sequel/dataset/actions.rb
lib/sequel/dataset/features.rb
lib/sequel/dataset/graph.rb
lib/sequel/dataset/misc.rb
lib/sequel/dataset/prepared_statements.rb
lib/sequel/dataset/query.rb
lib/sequel/dataset/sql.rb
lib/sequel/dataset/mutation.rb
lib/sequel/exceptions.rb
lib/sequel/extensions/looser_typecasting.rb
lib/sequel/extensions/migration.rb
lib/sequel/extensions/named_timezones.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/sql_expr.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/default_inflections.rb
lib/sequel/model/errors.rb
lib/sequel/model/exceptions.rb
lib/sequel/model/inflections.rb
lib/sequel/model/plugins.rb
lib/sequel/plugins/active_model.rb
lib/sequel/plugins/association_dependencies.rb
lib/sequel/plugins/association_proxies.rb
lib/sequel/plugins/boolean_readers.rb
lib/sequel/plugins/caching.rb
lib/sequel/plugins/class_table_inheritance.rb
lib/sequel/plugins/force_encoding.rb
lib/sequel/plugins/hook_class_methods.rb
lib/sequel/plugins/identity_map.rb
lib/sequel/plugins/instance_hooks.rb
lib/sequel/plugins/lazy_attributes.rb
lib/sequel/plugins/many_through_many.rb
lib/sequel/plugins/nested_attributes.rb
lib/sequel/plugins/optimistic_locking.rb
lib/sequel/plugins/schema.rb
lib/sequel/plugins/serialization.rb
lib/sequel/plugins/subclasses.rb
lib/sequel/plugins/single_table_inheritance.rb
lib/sequel/plugins/tactical_eager_loading.rb
lib/sequel/plugins/timestamps.rb
lib/sequel/plugins/touch.rb
lib/sequel/plugins/typecast_on_load.rb
lib/sequel/plugins/validation_class_methods.rb
lib/sequel/plugins/validation_helpers.rb
lib/sequel/plugins/composition.rb
lib/sequel/plugins/rcte_tree.rb
lib/sequel/plugins/instance_filters.rb
lib/sequel/plugins/sharding.rb
lib/sequel/plugins/skip_create_refresh.rb
lib/sequel/plugins/string_stripper.rb
lib/sequel/plugins/update_primary_key.rb
lib/sequel/plugins/association_pks.rb
lib/sequel/plugins/json_serializer.rb
lib/sequel/plugins/list.rb
lib/sequel/plugins/tree.rb
lib/sequel/plugins/xml_serializer.rb
lib/sequel/sql.rb
lib/sequel/timezones.rb
lib/sequel/version.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 migration quote_identifiers= require single_threaded= string_to_date string_to_datetime string_to_time ts_require tsk_require 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::MySQL
Module Sequel::Mysql2
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::Swift
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::IntegerMigrator
Class Sequel::InvalidOperation
Class Sequel::InvalidValue
Class Sequel::LiteralString
Class Sequel::Migration
Class Sequel::MigrationDSL
Class Sequel::Migrator
Class Sequel::Model
Class Sequel::NoExistingObject
Class Sequel::NotImplemented
Class Sequel::PoolTimeout
Class Sequel::Rollback
Class Sequel::ShardedSingleConnectionPool
Class Sequel::ShardedThreadedConnectionPool
Class Sequel::SimpleMigration
Class Sequel::SingleConnectionPool
Class Sequel::ThreadedConnectionPool
Class Sequel::TimestampMigrator
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 | = | proc do plural(/$/, 's') |  | Proc that is instance evaled to create the default inflections for both the model inflector and the inflector extension.
MAJOR | = | 3 |  | The major version of Sequel. Only bumped for major changes.
MINOR | = | 17 |  | The minor version of Sequel. Bumped for every non-patch level release, generally around once a month.
TINY | = | 0 |  | The tiny version of Sequel. Usually 0, only bumped for bugfix releases that fix regressions from previous versions.
VERSION | = | [MAJOR, MINOR, TINY].join('.') |  | The version of Sequel you are using, as a string (e.g. "2.11.0")

### External Aliases

require | -> | k_require
| Alias to the standard version of require

### Attributes

convert_two_digit_years

[RW]

Sequel converts two digit years in `Date`s and `DateTime`s 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

datetime_class

[RW]

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

For ruby versions less than 1.9.2, `Time` has a limited range (1901 to 2038), so if you use datetimes out of that range, you need to switch to `DateTime`. Also, before 1.9.2, `Time` can only handle local and UTC times, not other timezones. 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`).

virtual_row_instance_eval | [RW] | For backwards compatibility, has no effect.

### Public Class methods

Model(source)

Lets you create a Model subclass with its dataset already set. `source` should be an instance of one of the following classes:

Database : | Sets the database for this model to `source`. Generally only useful when subclassing directly from the returned class, where the name of the subclass sets the table name (which is combined with the `Database` in `source` to create the dataset to use)
Dataset : | Sets the dataset for this model to `source`.
Symbol : | Sets the table name for this model to `source`. The class will use the default database for model classes in order to create the dataset.

The purpose of this method is to set the dataset/database 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.

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

      # Using a dataset
      class Comment < Sequel::Model(DB1[:something])
        dataset # => DB1[:something]
      end

      # Using a database
      class Comment < Sequel::Model(DB1)
        dataset # => DB1[:comments]
      end

[Source]

        # File lib/sequel/model.rb, line 37
    37:   def self.Model(source)
    38:     Model::ANONYMOUS_MODEL_CLASSES[source] ||= if source.is_a?(Database)
    39:       c = Class.new(Model)
    40:       c.db = source
    41:       c
    42:     else
    43:       Class.new(Model).set_dataset(source)
    44:     end
    45:   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 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

[Source]

        # File lib/sequel/core.rb, line 89
    89:   def self.condition_specifier?(obj)
    90:     case obj
    91:     when Hash
    92:       true
    93:     when Array
    94:       !obj.empty? && !obj.is_a?(SQL::ValueList) && obj.all?{|i| (Array === i) && (i.length == 2)}
    95:     else
    96:       false
    97:     end
    98:   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}

For details, see the "Connecting to a Database" guide. To set up a master/slave or sharded database connection, see the "Master/Slave Databases and Sharding" guide.

[Source]

         # File lib/sequel/core.rb, line 118
    118:   def self.connect(*args, &block)
    119:     Database.connect(*args, &block)
    120:   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 125
    125:   def self.convert_exception_class(exception, klass)
    126:     return exception if exception.is_a?(klass)
    127:     e = klass.new("#{exception.class}: #{exception.message}")
    128:     e.wrapped_exception = exception
    129:     e.set_backtrace(exception.backtrace)
    130:     e
    131:   end

extension(*extensions)

Load all Sequel extensions given. Extensions are just files that exist under `sequel/extensions` in the load path, and are just required. Generally, extensions modify the behavior of `Database` and/or `Dataset`, but Sequel ships with some extensions that modify other classes that exist for backwards compatibility. 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(:schema_dumper)
      Sequel.extension(:pagination, :query)

[Source]

         # File lib/sequel/core.rb, line 143
    143:   def self.extension(*extensions)
    144:     extensions.each{|e| tsk_require "sequel/extensions/#{e}"}
    145:   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 158
    158:   def self.identifier_input_method=(value)
    159:     Database.identifier_input_method = value
    160:   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 174
    174:   def self.identifier_output_method=(value)
    175:     Database.identifier_output_method = value
    176:   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 81
    81:     def self.load_gem(name)
    82:       begin
    83:         Sequel.tsk_require "jdbc/#{name}"
    84:       rescue LoadError
    85:         # jdbc gem not used, hopefully the user has the .jar in their CLASSPATH
    86:       end
    87:     end

migration(&block)

The preferred method for writing Sequel migrations, using a DSL:

      Sequel.migration do
        up do
          create_table(:artists) do
            primary_key :id
            String :name
          end
        end

        down do
          drop_table(:artists)
        end
      end

Designed to be used with the `Migrator` class, part of the `migration` extension.

[Source]

         # File lib/sequel/extensions/migration.rb, line 124
    124:   def self.migration(&block)
    125:     MigrationDSL.create(&block)
    126:   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 182
    182:   def self.quote_identifiers=(value)
    183:     Database.quote_identifiers = value
    184:   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. This is used to ensure that the files loaded are from the same version of Sequel as this file.

[Source]

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

single_threaded=(value)

Set whether to set the single threaded mode for all databases by default. By default, Sequel uses a thread-safe 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 200
    200:   def self.single_threaded=(value)
    201:     Database.single_threaded = value
    202:   end

string_to_date(string)

Converts the given `string` into a `Date` object.

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

[Source]

         # File lib/sequel/core.rb, line 207
    207:   def self.string_to_date(string)
    208:     begin
    209:       Date.parse(string, Sequel.convert_two_digit_years)
    210:     rescue => e
    211:       raise convert_exception_class(e, InvalidValue)
    212:     end
    213:   end

string_to_datetime(string)

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)

[Source]

         # File lib/sequel/core.rb, line 219
    219:   def self.string_to_datetime(string)
    220:     begin
    221:       if datetime_class == DateTime
    222:         DateTime.parse(string, convert_two_digit_years)
    223:       else
    224:         datetime_class.parse(string)
    225:       end
    226:     rescue => e
    227:       raise convert_exception_class(e, InvalidValue)
    228:     end
    229:   end

string_to_time(string)

Converts the given `string` into a `Time` object.

      Sequel.string_to_datetime('10:20:30') # Time.parse('10:20:30')

[Source]

         # File lib/sequel/core.rb, line 234
    234:   def self.string_to_time(string)
    235:     begin
    236:       Time.parse(string)
    237:     rescue => e
    238:       raise convert_exception_class(e, InvalidValue)
    239:     end
    240:   end

ts_require(*args)

Same as Sequel.require, but wrapped in a mutex in order to be thread safe.

[Source]

         # File lib/sequel/core.rb, line 243
    243:   def self.ts_require(*args)
    244:     check_requiring_thread{require(*args)}
    245:   end

tsk_require(*args)

Same as Kernel.require, but wrapped in a mutex in order to be thread safe.

[Source]

         # File lib/sequel/core.rb, line 248
    248:   def self.tsk_require(*args)
    249:     check_requiring_thread{k_require(*args)}
    250:   end

version()

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

[Source]

        # File lib/sequel/version.rb, line 15
    15:   def self.version
    16:     VERSION
    17:   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.

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

[Source]

         # File lib/sequel/core.rb, line 259
    259:   def self.virtual_row(&block)
    260:     vr = SQL::VirtualRow.new
    261:     case block.arity
    262:     when -1, 0
    263:       vr.instance_eval(&block)
    264:     else
    265:       block.call(vr)
    266:     end
    267:   end

[Validate]