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

Top level module for Sequel

There are some class methods that are added via metaprogramming, one for each supported adapter. For example:

  DB = Sequel.sqlite # Memory database
  DB = Sequel.sqlite('blog.db')
  DB = Sequel.postgres('database_name', :user=>'user',
         :password=>'password', :host=>'host', :port=>5432,
         :max_connections=>10)

If a block is given to these methods, it is passed the opened Database object, which is closed (disconnected) when the block exits, just like a block passed to connect. For example:

  Sequel.sqlite('blog.db'){|db| puts db[:users].count}

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 - 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 - 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 - The timezone that incoming data that Sequel needs to typecast is assumed to be already in (if they don‘t include an offset).

You can set also set all three timezones to the same value at once via Sequel.default_timezone=.

  Sequel.application_timezone = :utc # or :local or nil
  Sequel.database_timezone = :utc # or :local or nil
  Sequel.typecast_timezone = :utc # or :local or nil
  Sequel.default_timezone = :utc # or :local or nil

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 an extension (and use DateTime as the datetime_class).

You can set the SEQUEL_NO_CORE_EXTENSIONS constant or environment variable to have Sequel not extend the core classes.

For a more expanded introduction, see the README. For a quicker introduction, see the cheat sheet.

Methods

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::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::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.
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.
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
MINOR = 12
TINY = 1
VERSION = [MAJOR, MINOR, TINY].join('.')

External Aliases

require -> k_require
  Alias to the standard version of require

Attributes

convert_two_digit_years  [RW]  Sequel converts two digit years in Dates and DateTimes 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 setting this to 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, set this to DateTime.
virtual_row_instance_eval  [RW] 

Public Class methods

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

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 97
 97:   def self.condition_specifier?(obj)
 98:     case obj
 99:     when Hash
100:       true
101:     when Array
102:       !obj.empty? && obj.all?{|i| (Array === i) && (i.length == 2)}
103:     else
104:       false
105:     end
106:   end

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 126
126:   def self.connect(*args, &block)
127:     Database.connect(*args, &block)
128:   end

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 133
133:   def self.convert_exception_class(exception, klass)
134:     return exception if exception.is_a?(klass)
135:     e = klass.new("#{exception.class}: #{exception.message}")
136:     e.wrapped_exception = exception
137:     e.set_backtrace(exception.backtrace)
138:     e
139:   end

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 146
146:   def self.extension(*extensions)
147:     extensions.each{|e| tsk_require "sequel/extensions/#{e}"}
148:   end

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 161
161:   def self.identifier_input_method=(value)
162:     Database.identifier_input_method = value
163:   end

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 177
177:   def self.identifier_output_method=(value)
178:     Database.identifier_output_method = value
179:   end

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

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

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

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 185
185:   def self.quote_identifiers=(value)
186:     Database.quote_identifiers = value
187:   end

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 191
191:   def self.require(files, subdir=nil)
192:     Array(files).each{|f| super("#{File.dirname(__FILE__)}/#{"#{subdir}/" if subdir}#{f}")}
193:   end

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 201
201:   def self.single_threaded=(value)
202:     Database.single_threaded = value
203:   end

Converts the given string into a Date object.

[Source]

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

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 216
216:   def self.string_to_datetime(s)
217:     begin
218:       if datetime_class == DateTime
219:         DateTime.parse(s, convert_two_digit_years)
220:       else
221:         datetime_class.parse(s)
222:       end
223:     rescue => e
224:       raise convert_exception_class(e, InvalidValue)
225:     end
226:   end

Converts the given string into a Time object.

[Source]

     # File lib/sequel/core.rb, line 229
229:   def self.string_to_time(s)
230:     begin
231:       Time.parse(s)
232:     rescue => e
233:       raise convert_exception_class(e, InvalidValue)
234:     end
235:   end

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

[Source]

     # File lib/sequel/core.rb, line 238
238:   def self.ts_require(*args)
239:     check_requiring_thread{require(*args)}
240:   end

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

[Source]

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

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

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 251
251:   def self.virtual_row(&block)
252:     vr = SQL::VirtualRow.new
253:     case block.arity
254:     when -1, 0
255:       vr.instance_eval(&block)
256:     else
257:       block.call(vr)
258:     end  
259:   end

[Validate]