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

frozen-string-literal: true

Methods

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::Cubrid
Module Sequel::CurrentDateTimeTimestamp
Module Sequel::DB2
Module Sequel::DataObjects
Module Sequel::DatabaseQuery
Module Sequel::DatasetPagination
Module Sequel::DatasetPrinter
Module Sequel::DatasetQuery
Module Sequel::Deprecation
Module Sequel::DuplicateColumnsHandler
Module Sequel::EmptyArrayConsiderNulls
Module Sequel::EmulateOffsetWithReverseAndCount
Module Sequel::EmulateOffsetWithRowNumber
Module Sequel::ErrorSQL
Module Sequel::EvalInspect
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::Oracle
Module Sequel::Plugins
Module Sequel::Postgres
Module Sequel::PrettyTable
Module Sequel::Progress
Module Sequel::QueryLiterals
Module Sequel::SQL
Module Sequel::SQLComments
Module Sequel::SQLite
Module Sequel::Schema
Module Sequel::SchemaCaching
Module Sequel::SchemaDumper
Module Sequel::SelectRemove
Module Sequel::Sequel3DatasetMethods
Module Sequel::ServerBlock
Module Sequel::ServerLogging
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::BasicObject
Class Sequel::ConnectionPool
Class Sequel::Database
Class Sequel::DatabaseError
Class Sequel::Dataset
Class Sequel::DuplicateColumnError
Class Sequel::Error
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::Unbinder
Class Sequel::ValidationFailed

Constants

SQLITE_TYPES = {}   Hash with string keys and callable values for converting SQLite types.
MYSQL_TYPES = {}   Hash with integer keys and callable values for converting MySQL types.
SQLANYWHERE_TYPES = {}
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.
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.
BeforeHookFailed = HookFailed   Alias for HookFailed, kept for backwards compatibility
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.
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 = {}
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 they will not get garbage collected.
MAJOR = 4   The major version of Sequel. Only bumped for major changes.
MINOR = 39   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")
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.
InvalidOperation = Class.new(Error)   Error raised on an invalid operation, such as trying to update or delete a joined or grouped dataset.
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).
UnbindDuplicate = Class.new(Error)   Error raised when unbinding a dataset that has multiple different values for a given variable.
AdapterNotFound = AdapterNotFound
InvalidOperation = InvalidOperation
InvalidValue = InvalidValue
PoolTimeoutError = PoolTimeout
Rollback = Rollback

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_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
convert_types  [RW]  Whether to convert some Java types to ruby types when retrieving rows. Uses the database‘s setting by default, can be set to false to roughly double performance when fetching rows.
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).

Public Class methods

Delegate to Sequel::Model, only for backwards compatibility.

[Source]

   # File lib/sequel/model.rb, line 7
7:   def self.cache_anonymous_models
8:     Model.cache_anonymous_models
9:   end

Delegate to Sequel::Model, only for backwards compatibility.

[Source]

    # File lib/sequel/model.rb, line 12
12:   def self.cache_anonymous_models=(v)
13:     Model.cache_anonymous_models = v
14:   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 64
64:   def self.condition_specifier?(obj)
65:     case obj
66:     when Hash
67:       true
68:     when Array
69:       !obj.empty? && !obj.is_a?(SQL::ValueList) && obj.all?{|i| i.is_a?(Array) && (i.length == 2)}
70:     else
71:       false
72:     end
73:   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)

You can also pass a single options hash:

  DB = Sequel.connect(:adapter=>'sqlite', :database=>'./blog.db')

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}

If a block is not given, a reference to this database will be held in Sequel::DATABASES until it is removed manually. This is by design, and used by Sequel::Model to pick the default database. It is recommended to pass a block if you do not want the resulting Database object to remain in memory until the process terminates.

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 107
107:   def self.connect(*args, &block)
108:     Database.connect(*args, &block)
109:   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 120
120:   def self.convert_exception_class(exception, klass)
121:     return exception if exception.is_a?(klass)
122:     e = klass.new("#{exception.class}: #{exception.message}")
123:     e.wrapped_exception = exception
124:     e.set_backtrace(exception.backtrace)
125:     e
126:   end

This extension loads the core extensions.

[Source]

    # File lib/sequel/extensions/core_extensions.rb, line 11
11: def Sequel.core_extensions?
12:   true
13: 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 113
113:   def self.core_extensions?
114:     false
115:   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 138
138:   def self.extension(*extensions)
139:     extensions.each{|e| Kernel.require "sequel/extensions/#{e}"}
140:   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 153
153:   def self.identifier_input_method=(value)
154:     Database.identifier_input_method = value
155:   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 169
169:   def self.identifier_output_method=(value)
170:     Database.identifier_output_method = value
171:   end

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

[Source]

   # File lib/sequel/model/inflections.rb, line 6
6:   def self.inflections
7:     yield Inflections if block_given?
8:     Inflections
9:   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 175
175:   def self.json_parser_error_class
176:     JSON::ParserError
177:   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 289
289:   def self.migration(&block)
290:     MigrationDSL.create(&block)
291:   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 181
181:   def self.object_to_json(obj, *args)
182:     obj.to_json(*args)
183:   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 187
187:   def self.parse_json(json)
188:     JSON.parse(json, :create_additions=>false)
189:   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 195
195:   def self.quote_identifiers=(value)
196:     Database.quote_identifiers = value
197:   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 202
202:   def self.recursive_map(array, converter)
203:     array.map do |i|
204:       if i.is_a?(Array)
205:         recursive_map(i, converter)
206:       elsif i
207:         converter.call(i)
208:       end
209:     end
210:   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 216
216:   def self.require(files, subdir=nil)
217:     Array(files).each{|f| super("#{File.dirname(__FILE__).untaint}/#{"#{subdir}/" if subdir}#{f}")}
218:   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 227
227:   def self.single_threaded=(value)
228:     @single_threaded = value
229:     Database.single_threaded = value
230:   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 242
242:   def self.split_symbol(sym)
243:     unless v = Sequel.synchronize{SPLIT_SYMBOL_CACHE[sym]}
244:       v = case s = sym.to_s
245:       when COLUMN_REF_RE1
246:         [$1.freeze, $2.freeze, $3.freeze].freeze
247:       when COLUMN_REF_RE2
248:         [nil, $1.freeze, $2.freeze].freeze
249:       when COLUMN_REF_RE3
250:         [$1.freeze, $2.freeze, nil].freeze
251:       else
252:         [nil, s.freeze, nil].freeze
253:       end
254:       Sequel.synchronize{SPLIT_SYMBOL_CACHE[sym] = v}
255:     end
256:     v
257:   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 262
262:   def self.string_to_date(string)
263:     begin
264:       Date.parse(string, Sequel.convert_two_digit_years)
265:     rescue => e
266:       raise convert_exception_class(e, InvalidValue)
267:     end
268:   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 274
274:   def self.string_to_datetime(string)
275:     begin
276:       if datetime_class == DateTime
277:         DateTime.parse(string, convert_two_digit_years)
278:       else
279:         datetime_class.parse(string)
280:       end
281:     rescue => e
282:       raise convert_exception_class(e, InvalidValue)
283:     end
284:   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 290
290:   def self.string_to_time(string)
291:     begin
292:       SQLTime.parse(string)
293:     rescue => e
294:       raise convert_exception_class(e, InvalidValue)
295:     end
296:   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 304
304:   def self.synchronize(&block)
305:     @single_threaded ? yield : @data_mutex.synchronize(&block)
306:   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 331
331:   def self.transaction(dbs, opts=OPTS, &block)
332:     unless opts[:rollback]
333:       rescue_rollback = true
334:       opts = Hash[opts].merge!(:rollback=>:reraise)
335:     end
336:     pr = dbs.reverse.inject(block){|bl, db| proc{db.transaction(opts, &bl)}}
337:     if rescue_rollback
338:       begin
339:         pr.call
340:       rescue Sequel::Rollback
341:         nil
342:       end
343:     else
344:       pr.call
345:     end
346:   end

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

[Source]

    # File lib/sequel/version.rb, line 17
17:   def self.version
18:     VERSION
19:   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 355
355:   def self.virtual_row(&block)
356:     vr = VIRTUAL_ROW
357:     case block.arity
358:     when -1, 0
359:       vr.instance_exec(&block)
360:     else
361:       block.call(vr)
362:     end  
363:   end

Public Instance methods

Correctly return rows from the database and return them as hashes.

[Source]

     # File lib/sequel/adapters/jdbc.rb, line 737
737:       def fetch_rows(sql, &block)
738:         execute(sql){|result| process_result_set(result, &block)}
739:         self
740:       end

Create a named prepared statement that is stored in the database (and connection) for reuse.

[Source]

     # File lib/sequel/adapters/jdbc.rb, line 744
744:       def prepare(type, name=nil, *values)
745:         ps = to_prepared_statement(type, values)
746:         ps.extend(PreparedStatementMethods)
747:         if name
748:           ps.prepared_statement_name = name
749:           db.set_prepared_statement(name, ps)
750:         end
751:         ps
752:       end

Set the fetch size on JDBC ResultSets created from this dataset.

[Source]

     # File lib/sequel/adapters/jdbc.rb, line 755
755:       def with_fetch_size(size)
756:         clone(:fetch_size=>size)
757:       end

[Validate]