Module Sequel
In: lib/sequel/version.rb
lib/sequel/timezones.rb
lib/sequel/sql.rb
lib/sequel/plugins/xml_serializer.rb
lib/sequel/plugins/validation_helpers.rb
lib/sequel/plugins/validation_class_methods.rb
lib/sequel/plugins/update_primary_key.rb
lib/sequel/plugins/update_or_create.rb
lib/sequel/plugins/unlimited_update.rb
lib/sequel/plugins/typecast_on_load.rb
lib/sequel/plugins/tree.rb
lib/sequel/plugins/touch.rb
lib/sequel/plugins/timestamps.rb
lib/sequel/plugins/tactical_eager_loading.rb
lib/sequel/plugins/table_select.rb
lib/sequel/plugins/subclasses.rb
lib/sequel/plugins/string_stripper.rb
lib/sequel/plugins/static_cache.rb
lib/sequel/plugins/split_values.rb
lib/sequel/plugins/skip_create_refresh.rb
lib/sequel/plugins/single_table_inheritance.rb
lib/sequel/plugins/sharding.rb
lib/sequel/plugins/serialization_modification_detection.rb
lib/sequel/plugins/serialization.rb
lib/sequel/plugins/scissors.rb
lib/sequel/plugins/schema.rb
lib/sequel/plugins/rcte_tree.rb
lib/sequel/plugins/prepared_statements_with_pk.rb
lib/sequel/plugins/prepared_statements_safe.rb
lib/sequel/plugins/prepared_statements_associations.rb
lib/sequel/plugins/prepared_statements.rb
lib/sequel/plugins/pg_typecast_on_load.rb
lib/sequel/plugins/pg_row.rb
lib/sequel/plugins/pg_array_associations.rb
lib/sequel/plugins/optimistic_locking.rb
lib/sequel/plugins/nested_attributes.rb
lib/sequel/plugins/mssql_optimistic_locking.rb
lib/sequel/plugins/modification_detection.rb
lib/sequel/plugins/many_to_one_pk_lookup.rb
lib/sequel/plugins/many_through_many.rb
lib/sequel/plugins/list.rb
lib/sequel/plugins/lazy_attributes.rb
lib/sequel/plugins/json_serializer.rb
lib/sequel/plugins/instance_hooks.rb
lib/sequel/plugins/instance_filters.rb
lib/sequel/plugins/insert_returning_select.rb
lib/sequel/plugins/input_transformer.rb
lib/sequel/plugins/hook_class_methods.rb
lib/sequel/plugins/force_encoding.rb
lib/sequel/plugins/error_splitter.rb
lib/sequel/plugins/eager_each.rb
lib/sequel/plugins/dirty.rb
lib/sequel/plugins/defaults_setter.rb
lib/sequel/plugins/dataset_associations.rb
lib/sequel/plugins/constraint_validations.rb
lib/sequel/plugins/composition.rb
lib/sequel/plugins/column_select.rb
lib/sequel/plugins/column_conflicts.rb
lib/sequel/plugins/class_table_inheritance.rb
lib/sequel/plugins/caching.rb
lib/sequel/plugins/boolean_readers.rb
lib/sequel/plugins/blacklist_security.rb
lib/sequel/plugins/auto_validations.rb
lib/sequel/plugins/association_proxies.rb
lib/sequel/plugins/association_pks.rb
lib/sequel/plugins/association_dependencies.rb
lib/sequel/plugins/association_autoreloading.rb
lib/sequel/plugins/after_initialize.rb
lib/sequel/plugins/active_model.rb
lib/sequel/plugins/accessed_columns.rb
lib/sequel/model/plugins.rb
lib/sequel/model/inflections.rb
lib/sequel/model/exceptions.rb
lib/sequel/model/errors.rb
lib/sequel/model/default_inflections.rb
lib/sequel/model/dataset_module.rb
lib/sequel/model/base.rb
lib/sequel/model/associations.rb
lib/sequel/model.rb
lib/sequel/extensions/to_dot.rb
lib/sequel/extensions/thread_local_timezones.rb
lib/sequel/extensions/split_array_nil.rb
lib/sequel/extensions/set_overrides.rb
lib/sequel/extensions/server_block.rb
lib/sequel/extensions/sequel_3_dataset_methods.rb
lib/sequel/extensions/select_remove.rb
lib/sequel/extensions/schema_dumper.rb
lib/sequel/extensions/schema_caching.rb
lib/sequel/extensions/round_timestamps.rb
lib/sequel/extensions/query_literals.rb
lib/sequel/extensions/query.rb
lib/sequel/extensions/pretty_table.rb
lib/sequel/extensions/pg_static_cache_updater.rb
lib/sequel/extensions/pg_row_ops.rb
lib/sequel/extensions/pg_row.rb
lib/sequel/extensions/pg_range_ops.rb
lib/sequel/extensions/pg_range.rb
lib/sequel/extensions/pg_loose_count.rb
lib/sequel/extensions/pg_json_ops.rb
lib/sequel/extensions/pg_json.rb
lib/sequel/extensions/pg_interval.rb
lib/sequel/extensions/pg_inet.rb
lib/sequel/extensions/pg_hstore_ops.rb
lib/sequel/extensions/pg_hstore.rb
lib/sequel/extensions/pg_enum.rb
lib/sequel/extensions/pg_array_ops.rb
lib/sequel/extensions/pg_array.rb
lib/sequel/extensions/pagination.rb
lib/sequel/extensions/null_dataset.rb
lib/sequel/extensions/named_timezones.rb
lib/sequel/extensions/mssql_emulate_lateral_with_apply.rb
lib/sequel/extensions/migration.rb
lib/sequel/extensions/meta_def.rb
lib/sequel/extensions/looser_typecasting.rb
lib/sequel/extensions/hash_aliases.rb
lib/sequel/extensions/graph_each.rb
lib/sequel/extensions/from_block.rb
lib/sequel/extensions/filter_having.rb
lib/sequel/extensions/eval_inspect.rb
lib/sequel/extensions/error_sql.rb
lib/sequel/extensions/empty_array_ignore_nulls.rb
lib/sequel/extensions/date_arithmetic.rb
lib/sequel/extensions/dataset_source_alias.rb
lib/sequel/extensions/current_datetime_timestamp.rb
lib/sequel/extensions/constraint_validations.rb
lib/sequel/extensions/connection_validator.rb
lib/sequel/extensions/columns_introspection.rb
lib/sequel/extensions/arbitrary_servers.rb
lib/sequel/extensions/_pretty_table.rb
lib/sequel/exceptions.rb
lib/sequel/deprecated.rb
lib/sequel/dataset/sql.rb
lib/sequel/dataset/query.rb
lib/sequel/dataset/prepared_statements.rb
lib/sequel/dataset/placeholder_literalizer.rb
lib/sequel/dataset/mutation.rb
lib/sequel/dataset/misc.rb
lib/sequel/dataset/graph.rb
lib/sequel/dataset/features.rb
lib/sequel/dataset/actions.rb
lib/sequel/dataset.rb
lib/sequel/database/transactions.rb
lib/sequel/database/schema_methods.rb
lib/sequel/database/schema_generator.rb
lib/sequel/database/query.rb
lib/sequel/database/misc.rb
lib/sequel/database/logging.rb
lib/sequel/database/features.rb
lib/sequel/database/dataset_defaults.rb
lib/sequel/database/dataset.rb
lib/sequel/database/connecting.rb
lib/sequel/database.rb
lib/sequel/core.rb
lib/sequel/ast_transformer.rb
lib/sequel/adapters/utils/stored_procedures.rb
lib/sequel/adapters/utils/replace.rb
lib/sequel/adapters/utils/pg_types.rb
lib/sequel/adapters/utils/emulate_offset_with_row_number.rb
lib/sequel/adapters/utils/emulate_offset_with_reverse_and_count.rb
lib/sequel/adapters/tinytds.rb
lib/sequel/adapters/swift/sqlite.rb
lib/sequel/adapters/swift/postgres.rb
lib/sequel/adapters/swift/mysql.rb
lib/sequel/adapters/swift.rb
lib/sequel/adapters/sqlite.rb
lib/sequel/adapters/sqlanywhere.rb
lib/sequel/adapters/shared/sqlite.rb
lib/sequel/adapters/shared/sqlanywhere.rb
lib/sequel/adapters/shared/progress.rb
lib/sequel/adapters/shared/postgres.rb
lib/sequel/adapters/shared/oracle.rb
lib/sequel/adapters/shared/mysql_prepared_statements.rb
lib/sequel/adapters/shared/mysql.rb
lib/sequel/adapters/shared/mssql.rb
lib/sequel/adapters/shared/informix.rb
lib/sequel/adapters/shared/firebird.rb
lib/sequel/adapters/shared/fdbsql.rb
lib/sequel/adapters/shared/db2.rb
lib/sequel/adapters/shared/cubrid.rb
lib/sequel/adapters/shared/access.rb
lib/sequel/adapters/postgres.rb
lib/sequel/adapters/oracle.rb
lib/sequel/adapters/openbase.rb
lib/sequel/adapters/odbc/mssql.rb
lib/sequel/adapters/odbc.rb
lib/sequel/adapters/mysql2.rb
lib/sequel/adapters/mysql.rb
lib/sequel/adapters/mock.rb
lib/sequel/adapters/jdbc/transactions.rb
lib/sequel/adapters/jdbc/sqlserver.rb
lib/sequel/adapters/jdbc/sqlite.rb
lib/sequel/adapters/jdbc/sqlanywhere.rb
lib/sequel/adapters/jdbc/postgresql.rb
lib/sequel/adapters/jdbc/oracle.rb
lib/sequel/adapters/jdbc/mysql.rb
lib/sequel/adapters/jdbc/mssql.rb
lib/sequel/adapters/jdbc/jtds.rb
lib/sequel/adapters/jdbc/jdbcprogress.rb
lib/sequel/adapters/jdbc/informix-sqli.rb
lib/sequel/adapters/jdbc/hsqldb.rb
lib/sequel/adapters/jdbc/h2.rb
lib/sequel/adapters/jdbc/firebirdsql.rb
lib/sequel/adapters/jdbc/fdbsql.rb
lib/sequel/adapters/jdbc/derby.rb
lib/sequel/adapters/jdbc/db2.rb
lib/sequel/adapters/jdbc/cubrid.rb
lib/sequel/adapters/jdbc/as400.rb
lib/sequel/adapters/jdbc.rb
lib/sequel/adapters/informix.rb
lib/sequel/adapters/ibmdb.rb
lib/sequel/adapters/firebird.rb
lib/sequel/adapters/fdbsql.rb
lib/sequel/adapters/do/sqlite3.rb
lib/sequel/adapters/do/postgres.rb
lib/sequel/adapters/do/mysql.rb
lib/sequel/adapters/do.rb
lib/sequel/adapters/dbi.rb
lib/sequel/adapters/db2.rb
lib/sequel/adapters/cubrid.rb
lib/sequel/adapters/amalgalite.rb
lib/sequel/adapters/ado/mssql.rb
lib/sequel/adapters/ado/access.rb
lib/sequel/adapters/ado.rb

Top level module for Sequel

There are some module 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}

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

Methods

Classes and Modules

Module Sequel::ADO
Module Sequel::Access
Module Sequel::Amalgalite
Module Sequel::ArbitraryServers
Module Sequel::ColumnsIntrospection
Module Sequel::ConnectionValidator
Module Sequel::ConstraintValidations
Module Sequel::CoreRefinements
Module Sequel::Cubrid
Module Sequel::CurrentDateTimeTimestamp
Module Sequel::DB2
Module Sequel::DBI
Module Sequel::DataObjects
Module Sequel::Database
Module Sequel::DatabaseQuery
Module Sequel::DatasetPagination
Module Sequel::DatasetPrinter
Module Sequel::DatasetQuery
Module Sequel::Deprecation
Module Sequel::EmptyArrayIgnoreNulls
Module Sequel::EmulateOffsetWithReverseAndCount
Module Sequel::EmulateOffsetWithRowNumber
Module Sequel::ErrorSQL
Module Sequel::EvalInspect
Module Sequel::Fdbsql
Module Sequel::FilterHaving
Module Sequel::Firebird
Module Sequel::GraphEach
Module Sequel::HashAliases
Module Sequel::IBMDB
Module Sequel::Inflections
Module Sequel::Informix
Module Sequel::JDBC
Module Sequel::LooserTypecasting
Module Sequel::MSSQL
Module Sequel::Metaprogramming
Module Sequel::Mock
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::QueryLiterals
Module Sequel::SQL
Module Sequel::SQLite
Module Sequel::Schema
Module Sequel::SchemaCaching
Module Sequel::SchemaDumper
Module Sequel::SelectRemove
Module Sequel::Sequel3DatasetMethods
Module Sequel::ServerBlock
Module Sequel::SetOverrides
Module Sequel::SqlAnywhere
Module Sequel::Swift
Module Sequel::ThreadLocalTimezones
Module Sequel::ThreadedServerBlock
Module Sequel::Timezones
Module Sequel::TinyTDS
Module Sequel::UnthreadedServerBlock
Class Sequel::ASTTransformer
Class Sequel::AdapterNotFound
Class Sequel::BasicObject
Class Sequel::CheckConstraintViolation
Class Sequel::ConnectionPool
Class Sequel::ConstraintViolation
Class Sequel::Database
Class Sequel::DatabaseConnectionError
Class Sequel::DatabaseDisconnectError
Class Sequel::DatabaseError
Class Sequel::Dataset
Class Sequel::Error
Class Sequel::ForeignKeyConstraintViolation
Class Sequel::HookFailed
Class Sequel::IntegerMigrator
Class Sequel::InvalidOperation
Class Sequel::InvalidValue
Class Sequel::LiteralString
Class Sequel::Migration
Class Sequel::MigrationAlterTableReverser
Class Sequel::MigrationDSL
Class Sequel::MigrationReverser
Class Sequel::Migrator
Class Sequel::Model
Class Sequel::NoExistingObject
Class Sequel::NoMatchingRow
Class Sequel::NotNullConstraintViolation
Class Sequel::PoolTimeout
Class Sequel::Qualifier
Class Sequel::Rollback
Class Sequel::SQLTime
Class Sequel::SerializationFailure
Class Sequel::ShardedSingleConnectionPool
Class Sequel::ShardedThreadedConnectionPool
Class Sequel::SimpleMigration
Class Sequel::SingleConnectionPool
Class Sequel::ThreadedConnectionPool
Class Sequel::TimestampMigrator
Class Sequel::ToDot
Class Sequel::UnbindDuplicate
Class Sequel::Unbinder
Class Sequel::UndefinedAssociation
Class Sequel::UniqueConstraintViolation
Class Sequel::ValidationFailed

Constants

MAJOR = 4   The major version of Sequel. Only bumped for major changes.
MINOR = 20   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")
BeforeHookFailed = HookFailed   Alias for HookFailed, kept for backwards compatibility
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.
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.
OPTS = {}.freeze   Frozen hash used as the default options hash for most options.
COLUMN_REF_RE1 = /\A((?:(?!__).)+)__((?:(?!___).)+)___(.+)\z/.freeze
COLUMN_REF_RE2 = /\A((?:(?!___).)+)___(.+)\z/.freeze
COLUMN_REF_RE3 = /\A((?:(?!__).)+)__(.+)\z/.freeze
SPLIT_SYMBOL_CACHE = {}
STRING_TYPES = [18, 19, 25, 1042, 1043]   Type OIDs for string types used by PostgreSQL. These types don‘t have conversion procs associated with them (since the data is already in the form of a string).
PG_NAMED_TYPES = {} unless defined?(PG_NAMED_TYPES)   Hash with type name strings/symbols and callable values for converting PostgreSQL types. Non-builtin types that don‘t have fixed numbers should use this to register conversion procs.
PG_TYPES = {} unless defined?(PG_TYPES)   Hash with integer keys and callable values for converting PostgreSQL types.
SQLITE_TYPES = {}   Hash with string keys and callable values for converting SQLite types.
SQLANYWHERE_TYPES = {}
MYSQL_TYPES = {}   Hash with integer keys and callable values for converting MySQL types.

Attributes

autoid  [W]  Set the autogenerated primary key integer to be returned when running an insert query. Argument types supported:
nil :Return nil for all inserts
Integer :Starting integer for next insert, with futher inserts getting an incremented value
Array :First insert gets the first value in the array, second gets the second value, etc.
Proc :Called with the insert SQL query, uses the value returned
Class :Should be an Exception subclass, will create a new instance an raise it wrapped in a DatabaseError.
cache_anonymous_models  [RW]  Whether to cache the anonymous models created by Sequel::Model(). This is required for reloading them correctly (avoiding the superclass mismatch). True by default for backwards compatibility.
columns  [W]  Set the columns to set in the dataset when the dataset fetches rows. Argument types supported:
nil :Set no columns

Array of Symbols: Used for all datasets Array (otherwise): First retrieval gets the first value in the

                   array, second gets the second value, etc.
Proc :Called with the select SQL query, uses the value returned, which should be an array of symbols
convert_invalid_date_time  [RW]  Whether to convert invalid date time values by default.

Only applies to Sequel::Database instances created after this has been set.

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:
  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).

fetch  [W]  Set the hashes to yield by execute when retrieving rows. Argument types supported:
nil :Yield no rows
Hash :Always yield a single row with this hash
Array of Hashes :Yield separately for each hash in this array
Array (otherwise) :First retrieval gets the first value in the array, second gets the second value, etc.
Proc :Called with the select SQL query, uses the value returned, which should be a hash or array of hashes.
Class :Should be an Exception subclass, will create a new instance an raise it wrapped in a DatabaseError.
numrows  [W]  Set the number of rows to return from update or delete. Argument types supported:
nil :Return 0 for all updates and deletes
Integer :Used for all updates and deletes
Array :First update/delete gets the first value in the array, second gets the second value, etc.
Proc :Called with the update/delete SQL query, uses the value returned.
Class :Should be an Exception subclass, will create a new instance an raise it wrapped in a DatabaseError.
server_version  [RW]  Mock the server version, useful when using the shared adapters

Public Class methods

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.
other :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:     if cache_anonymous_models && (klass = Model::ANONYMOUS_MODEL_CLASSES_MUTEX.synchronize{Model::ANONYMOUS_MODEL_CLASSES[source]})
39:       return klass
40:     end
41:     klass = if source.is_a?(Database)
42:       c = Class.new(Model)
43:       c.db = source
44:       c
45:     else
46:       Class.new(Model).set_dataset(source)
47:     end
48:     Model::ANONYMOUS_MODEL_CLASSES_MUTEX.synchronize{Model::ANONYMOUS_MODEL_CLASSES[source] = klass} if cache_anonymous_models
49:     klass
50:   end

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 62
62:   def self.condition_specifier?(obj)
63:     case obj
64:     when Hash
65:       true
66:     when Array
67:       !obj.empty? && !obj.is_a?(SQL::ValueList) && obj.all?{|i| i.is_a?(Array) && (i.length == 2)}
68:     else
69:       false
70:     end
71:   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 94
94:   def self.connect(*args, &block)
95:     Database.connect(*args, &block)
96:   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 107
107:   def self.convert_exception_class(exception, klass)
108:     return exception if exception.is_a?(klass)
109:     e = klass.new("#{exception.class}: #{exception.message}")
110:     e.wrapped_exception = exception
111:     e.set_backtrace(exception.backtrace)
112:     e
113:   end

This extension loads the core extensions.

[Source]

    # File lib/sequel/extensions/core_extensions.rb, line 13
13: def Sequel.core_extensions?
14:   true
15: end

Assume the core extensions are not loaded by default, if the core_extensions extension is loaded, this will be overridden.

[Source]

     # File lib/sequel/core.rb, line 100
100:   def self.core_extensions?
101:     false
102:   end

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 125
125:   def self.extension(*extensions)
126:     extensions.each{|e| Kernel.require "sequel/extensions/#{e}"}
127:   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 140
140:   def self.identifier_input_method=(value)
141:     Database.identifier_input_method = value
142:   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 156
156:   def self.identifier_output_method=(value)
157:     Database.identifier_output_method = value
158:   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

The exception classed raised if there is an error parsing JSON. This can be overridden to use an alternative json implementation.

[Source]

     # File lib/sequel/core.rb, line 162
162:   def self.json_parser_error_class
163:     JSON::ParserError
164:   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 281
281:   def self.migration(&block)
282:     MigrationDSL.create(&block)
283:   end

Convert given object to json and return the result. This can be overridden to use an alternative json implementation.

[Source]

     # File lib/sequel/core.rb, line 168
168:   def self.object_to_json(obj, *args)
169:     obj.to_json(*args)
170:   end

Parse the string as JSON and return the result. This can be overridden to use an alternative json implementation.

[Source]

     # File lib/sequel/core.rb, line 174
174:   def self.parse_json(json)
175:     JSON.parse(json, :create_additions=>false)
176:   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 182
182:   def self.quote_identifiers=(value)
183:     Database.quote_identifiers = value
184:   end

Convert each item in the array to the correct type, handling multi-dimensional arrays. For each element in the array or subarrays, call the converter, unless the value is nil.

[Source]

     # File lib/sequel/core.rb, line 189
189:   def self.recursive_map(array, converter)
190:     array.map do |i|
191:       if i.is_a?(Array)
192:         recursive_map(i, converter)
193:       elsif i
194:         converter.call(i)
195:       end
196:     end
197:   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. 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 203
203:   def self.require(files, subdir=nil)
204:     Array(files).each{|f| super("#{File.dirname(__FILE__).untaint}/#{"#{subdir}/" if subdir}#{f}")}
205:   end

Set whether Sequel is being used in single threaded mode. By default, Sequel uses a thread-safe connection pool, which isn‘t as fast as the single threaded connection pool, and also has some additional thread safety checks. If your program will only have one thread, and speed is a priority, you should set this to true:

  Sequel.single_threaded = true

[Source]

     # File lib/sequel/core.rb, line 214
214:   def self.single_threaded=(value)
215:     @single_threaded = value
216:     Database.single_threaded = value
217:   end

Splits the symbol into three parts. Each part will either be a string or nil.

For columns, these parts are the table, column, and alias. For tables, these parts are the schema, table, and alias.

[Source]

     # File lib/sequel/core.rb, line 229
229:   def self.split_symbol(sym)
230:     unless v = Sequel.synchronize{SPLIT_SYMBOL_CACHE[sym]}
231:       v = case s = sym.to_s
232:       when COLUMN_REF_RE1
233:         [$1.freeze, $2.freeze, $3.freeze].freeze
234:       when COLUMN_REF_RE2
235:         [nil, $1.freeze, $2.freeze].freeze
236:       when COLUMN_REF_RE3
237:         [$1.freeze, $2.freeze, nil].freeze
238:       else
239:         [nil, s.freeze, nil].freeze
240:       end
241:       Sequel.synchronize{SPLIT_SYMBOL_CACHE[sym] = v}
242:     end
243:     v
244:   end

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 249
249:   def self.string_to_date(string)
250:     begin
251:       Date.parse(string, Sequel.convert_two_digit_years)
252:     rescue => e
253:       raise convert_exception_class(e, InvalidValue)
254:     end
255:   end

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 261
261:   def self.string_to_datetime(string)
262:     begin
263:       if datetime_class == DateTime
264:         DateTime.parse(string, convert_two_digit_years)
265:       else
266:         datetime_class.parse(string)
267:       end
268:     rescue => e
269:       raise convert_exception_class(e, InvalidValue)
270:     end
271:   end

Converts the given string into a Sequel::SQLTime object.

  v = Sequel.string_to_time('10:20:30') # Sequel::SQLTime.parse('10:20:30')
  DB.literal(v) # => '10:20:30'

[Source]

     # File lib/sequel/core.rb, line 277
277:   def self.string_to_time(string)
278:     begin
279:       SQLTime.parse(string)
280:     rescue => e
281:       raise convert_exception_class(e, InvalidValue)
282:     end
283:   end

Yield directly to the block. You don‘t need to synchronize access on MRI because the GVL makes certain methods atomic.

[Source]

     # File lib/sequel/core.rb, line 300
300:     def self.synchronize
301:       yield
302:     end

Unless in single threaded mode, protects access to any mutable global data structure in Sequel. Uses a non-reentrant mutex, so calling code should be careful.

[Source]

     # File lib/sequel/core.rb, line 293
293:     def self.synchronize(&block)
294:       @single_threaded ? yield : @data_mutex.synchronize(&block)
295:     end

Uses a transaction on all given databases with the given options. This:

  Sequel.transaction([DB1, DB2, DB3]){...}

is equivalent to:

  DB1.transaction do
    DB2.transaction do
      DB3.transaction do
        ...
      end
    end
  end

except that if Sequel::Rollback is raised by the block, the transaction is rolled back on all databases instead of just the last one.

Note that this method cannot guarantee that all databases will commit or rollback. For example, if DB3 commits but attempting to commit on DB2 fails (maybe because foreign key checks are deferred), there is no way to uncommit the changes on DB3. For that kind of support, you need to have two-phase commit/prepared transactions (which Sequel supports on some databases).

[Source]

     # File lib/sequel/core.rb, line 328
328:   def self.transaction(dbs, opts=OPTS, &block)
329:     unless opts[:rollback]
330:       rescue_rollback = true
331:       opts = opts.merge(:rollback=>:reraise)
332:     end
333:     pr = dbs.reverse.inject(block){|bl, db| proc{db.transaction(opts, &bl)}}
334:     if rescue_rollback
335:       begin
336:         pr.call
337:       rescue Sequel::Rollback
338:         nil
339:       end
340:     else
341:       pr.call
342:     end
343:   end

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

If the supplied block takes a single argument, yield an SQL::VirtualRow instance to the block argument. Otherwise, evaluate the block in the context of a 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 352
352:   def self.virtual_row(&block)
353:     vr = VIRTUAL_ROW
354:     case block.arity
355:     when -1, 0
356:       vr.instance_exec(&block)
357:     else
358:       block.call(vr)
359:     end  
360:   end

Public Instance methods

Return a related Connection option connecting to the given shard.

[Source]

     # File lib/sequel/adapters/mock.rb, line 148
148:       def connect(server)
149:         Connection.new(self, server, server_opts(server))
150:       end

[Source]

     # File lib/sequel/adapters/mock.rb, line 152
152:       def disconnect_connection(c)
153:       end

Store the sql used for later retrieval with sqls, and return the appropriate value using either the autoid, fetch, or numrows methods.

[Source]

     # File lib/sequel/adapters/mock.rb, line 158
158:       def execute(sql, opts=OPTS, &block)
159:         synchronize(opts[:server]){|c| _execute(c, sql, opts, &block)} 
160:       end
execute_ddl(sql, opts=OPTS, &block)

Alias for execute

Store the sql used, and return the value of the numrows method.

[Source]

     # File lib/sequel/adapters/mock.rb, line 164
164:       def execute_dui(sql, opts=OPTS)
165:         execute(sql, opts.merge(:meth=>:numrows))
166:       end

Store the sql used, and return the value of the autoid method.

[Source]

     # File lib/sequel/adapters/mock.rb, line 169
169:       def execute_insert(sql, opts=OPTS)
170:         execute(sql, opts.merge(:meth=>:autoid))
171:       end

Return all stored SQL queries, and clear the cache of SQL queries.

[Source]

     # File lib/sequel/adapters/mock.rb, line 175
175:       def sqls
176:         s = @sqls.dup
177:         @sqls.clear
178:         s
179:       end

Enable use of savepoints.

[Source]

     # File lib/sequel/adapters/mock.rb, line 182
182:       def supports_savepoints?
183:         shared_adapter? ? super : true
184:       end

[Validate]