Module: Sequel

Classes and Modules

Module Sequel::ADO
Module Sequel::Access
Module Sequel::Amalgalite
Module Sequel::ArbitraryServers
Module Sequel::ColumnsIntrospection
Module Sequel::ConnectionExpiration
Module Sequel::ConnectionValidator
Module Sequel::ConstraintValidations
Module Sequel::CoreRefinements
Module Sequel::CurrentDateTimeTimestamp
Module Sequel::DB2
Module Sequel::DatabaseMethods
Module Sequel::DatabaseQuery
Module Sequel::DatasetMethods
Module Sequel::DatasetPagination
Module Sequel::DatasetPrinter
Module Sequel::DatasetQuery
Module Sequel::DateTimeParseToTime
Module Sequel::Deprecation
Module Sequel::DuplicateColumnsHandler
Module Sequel::EmptyArrayConsiderNulls
Module Sequel::EmulateOffsetWithReverseAndCount
Module Sequel::EmulateOffsetWithRowNumber
Module Sequel::ErrorSQL
Module Sequel::EvalInspect
Module Sequel::GraphEach
Module Sequel::IBMDB
Module Sequel::IdentifierMangling
Module Sequel::IndexCaching
Module Sequel::Inflections
Module Sequel::Integer64
Module Sequel::JDBC
Module Sequel::LooserTypecasting
Module Sequel::MSSQL
Module Sequel::Mock
Module Sequel::MockAdapterDatabaseMethods
Module Sequel::MySQL
Module Sequel::Mysql2
Module Sequel::NamedTimezones
Module Sequel::ODBC
Module Sequel::Oracle
Module Sequel::Plugins
Module Sequel::Postgres
Module Sequel::PrettyTable
Module Sequel::S
Module Sequel::SQL
Module Sequel::SQLComments
Module Sequel::SQLite
Module Sequel::Schema
Module Sequel::SchemaCaching
Module Sequel::SchemaDumper
Module Sequel::SelectRemove
Module Sequel::Sequel4DatasetMethods
Module Sequel::ServerBlock
Module Sequel::ServerLogging
Module Sequel::SqlAnywhere
Module Sequel::SymbolAref
Module Sequel::SymbolAs
Module Sequel::ThreadLocalTimezones
Module Sequel::ThreadedServerBlock
Module Sequel::Timezones
Module Sequel::TinyTDS
Module Sequel::UnmodifiedIdentifiers
Module Sequel::UnthreadedServerBlock
Class Sequel::ASTTransformer
Class Sequel::AlterTableGenerator
Class Sequel::BasicObject
Class Sequel::ConnectionPool
Class Sequel::CreateTableGenerator
Class Sequel::Database
Class Sequel::DatabaseError
Class Sequel::Dataset
Class Sequel::DuplicateColumnError
Class Sequel::Error
Class Sequel::ExclusionConstraintViolation
Class Sequel::HookFailed
Class Sequel::IntegerMigrator
Class Sequel::LiteralString
Class Sequel::Migration
Class Sequel::MigrationAlterTableReverser
Class Sequel::MigrationDSL
Class Sequel::MigrationReverser
Class Sequel::Migrator
Class Sequel::Model
Class Sequel::NoMatchingRow
Class Sequel::Qualifier
Class Sequel::SQLTime
Class Sequel::ShardedSingleConnectionPool
Class Sequel::ShardedThreadedConnectionPool
Class Sequel::SimpleMigration
Class Sequel::SingleConnectionPool
Class Sequel::ThreadedConnectionPool
Class Sequel::TimestampMigrator
Class Sequel::ToDot
Class Sequel::ValidationFailed

Constants

ADAPTER_MAP	=	{}	Hash of adapters that have been used. The key is the adapter scheme symbol, and the value is the Database subclass.
SHARED_ADAPTER_MAP	=	{}	Hash of shared adapters that have been registered. The key is the adapter scheme symbol, and the value is the Sequel module containing the shared adapter.
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 use the :keep_reference Database option or a block when connecting) or they will not get garbage collected.
MYSQL_TYPES	=	{}	Hash with integer keys and callable values for converting MySQL types.
CONVERSION_PROCS	=	{}
VIRTUAL_ROW	=	new
OPTS	=	{}.freeze	Frozen hash used as the default options hash for most options.
SPLIT_SYMBOL_CACHE	=	{}
AdapterNotFound	=	Class.new(Error)	Error raised when the adapter requested doesn‘t exist or can‘t be loaded.
DatabaseError	=	Class.new(Error)	Generic error raised by the database adapters, indicating a problem originating from the database server. Usually raised because incorrect SQL syntax is used.
DatabaseConnectionError	=	Class.new(DatabaseError)	Error raised when the Sequel is unable to connect to the database with the connection parameters it was given.
DatabaseDisconnectError	=	Class.new(DatabaseError)	Error raised by adapters when they determine that the connection to the database has been lost. Instructs the connection pool code to remove that connection from the pool so that other connections can be acquired automatically.
ConstraintViolation	=	Class.new(DatabaseError)	Generic error raised when Sequel determines a database constraint has been violated.
CheckConstraintViolation	=	Class.new(ConstraintViolation)	Error raised when Sequel determines a database check constraint has been violated.
ForeignKeyConstraintViolation	=	Class.new(ConstraintViolation)	Error raised when Sequel determines a database foreign key constraint has been violated.
NotNullConstraintViolation	=	Class.new(ConstraintViolation)	Error raised when Sequel determines a database NOT NULL constraint has been violated.
UniqueConstraintViolation	=	Class.new(ConstraintViolation)	Error raised when Sequel determines a database unique constraint has been violated.
SerializationFailure	=	Class.new(DatabaseError)	Error raised when Sequel determines a serialization failure/deadlock in the database.
DatabaseLockTimeout	=	Class.new(DatabaseError)	Error raised when Sequel determines the database could not acquire a necessary lock before timing out. Use of Dataset#nowait can often cause this exception when retrieving rows.
InvalidOperation	=	Class.new(Error)	Error raised on an invalid operation, such as trying to update or delete a joined or grouped dataset when the database does not support that.
InvalidValue	=	Class.new(Error)	Error raised when attempting an invalid type conversion.
PoolTimeout	=	Class.new(Error)	Error raised when the connection pool cannot acquire a database connection before the timeout.
Rollback	=	Class.new(Error)	Error that you should raise to signal a rollback of the current transaction. The transaction block will catch this exception, rollback the current transaction, and won‘t reraise it (unless a reraise is requested).
MAJOR	=	5	The major version of Sequel. Only bumped for major changes.
MINOR	=	9	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('.').freeze	The version of Sequel you are using, as a string (e.g. "2.11.0")
VERSION_NUMBER	=	MAJOR10000 + MINOR10 + TINY	The version of Sequel you are using, as a number (2.11.0 -> 20110)
DEFAULT_INFLECTIONS_PROC	=	proc do plural(/$/, 's')	Proc that is instance_execed to create the default inflections for both the model inflector and the inflector extension.
NoExistingObject	=	Class.new(Error)	Exception class raised when `require_modification` is set and an UPDATE or DELETE statement to modify the dataset doesn‘t modify a single row.
UndefinedAssociation	=	Class.new(Error)	Raised when an undefined association is used when eager loading.
MassAssignmentRestriction	=	Class.new(Error)	Raised when a mass assignment method is called in strict mode with either a restricted column or a column without a setter method.

External Aliases

expr -> []

Allow nicer syntax for creating Sequel expressions:

  Sequel[1]     # => Sequel::SQL::NumericExpression: 1
  Sequel["a"]   # => Sequel::SQL::StringExpression: 'a'
  Sequel[:a]    # => Sequel::SQL::Identifier: "a"
  Sequel[a: 1]  # => Sequel::SQL::BooleanExpression: ("a" = 1)

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:

  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

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

single_threaded

[RW]

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

Public Class methods

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

Methods

Classes and Modules

Constants

External Aliases

Attributes

Public Class methods

Public Instance methods