Module Sequel
In: lib/sequel/adapters/ado.rb
lib/sequel/adapters/ado/mssql.rb
lib/sequel/adapters/amalgalite.rb
lib/sequel/adapters/db2.rb
lib/sequel/adapters/dbi.rb
lib/sequel/adapters/do.rb
lib/sequel/adapters/do/mysql.rb
lib/sequel/adapters/do/postgres.rb
lib/sequel/adapters/do/sqlite.rb
lib/sequel/adapters/firebird.rb
lib/sequel/adapters/informix.rb
lib/sequel/adapters/jdbc.rb
lib/sequel/adapters/jdbc/h2.rb
lib/sequel/adapters/jdbc/mssql.rb
lib/sequel/adapters/jdbc/mysql.rb
lib/sequel/adapters/jdbc/oracle.rb
lib/sequel/adapters/jdbc/postgresql.rb
lib/sequel/adapters/jdbc/sqlite.rb
lib/sequel/adapters/jdbc/as400.rb
lib/sequel/adapters/jdbc/informix.rb
lib/sequel/adapters/jdbc/jtds.rb
lib/sequel/adapters/jdbc/sqlserver.rb
lib/sequel/adapters/jdbc/db2.rb
lib/sequel/adapters/jdbc/transactions.rb
lib/sequel/adapters/jdbc/firebird.rb
lib/sequel/adapters/jdbc/hsqldb.rb
lib/sequel/adapters/jdbc/derby.rb
lib/sequel/adapters/jdbc/progress.rb
lib/sequel/adapters/mysql.rb
lib/sequel/adapters/odbc.rb
lib/sequel/adapters/odbc/mssql.rb
lib/sequel/adapters/openbase.rb
lib/sequel/adapters/oracle.rb
lib/sequel/adapters/postgres.rb
lib/sequel/adapters/shared/mssql.rb
lib/sequel/adapters/shared/mysql.rb
lib/sequel/adapters/shared/oracle.rb
lib/sequel/adapters/shared/postgres.rb
lib/sequel/adapters/shared/progress.rb
lib/sequel/adapters/shared/sqlite.rb
lib/sequel/adapters/shared/access.rb
lib/sequel/adapters/shared/informix.rb
lib/sequel/adapters/shared/mysql_prepared_statements.rb
lib/sequel/adapters/shared/db2.rb
lib/sequel/adapters/shared/firebird.rb
lib/sequel/adapters/sqlite.rb
lib/sequel/adapters/utils/stored_procedures.rb
lib/sequel/adapters/utils/emulate_offset_with_row_number.rb
lib/sequel/adapters/mysql2.rb
lib/sequel/adapters/swift.rb
lib/sequel/adapters/swift/mysql.rb
lib/sequel/adapters/swift/postgres.rb
lib/sequel/adapters/swift/sqlite.rb
lib/sequel/adapters/tinytds.rb
lib/sequel/adapters/ibmdb.rb
lib/sequel/adapters/mock.rb
lib/sequel/core.rb
lib/sequel/sql.rb
lib/sequel/database.rb
lib/sequel/database/schema_generator.rb
lib/sequel/database/schema_methods.rb
lib/sequel/database/connecting.rb
lib/sequel/database/dataset.rb
lib/sequel/database/dataset_defaults.rb
lib/sequel/database/logging.rb
lib/sequel/database/misc.rb
lib/sequel/database/query.rb
lib/sequel/dataset.rb
lib/sequel/dataset/actions.rb
lib/sequel/dataset/features.rb
lib/sequel/dataset/graph.rb
lib/sequel/dataset/misc.rb
lib/sequel/dataset/prepared_statements.rb
lib/sequel/dataset/query.rb
lib/sequel/dataset/sql.rb
lib/sequel/dataset/mutation.rb
lib/sequel/exceptions.rb
lib/sequel/extensions/looser_typecasting.rb
lib/sequel/extensions/migration.rb
lib/sequel/extensions/named_timezones.rb
lib/sequel/extensions/pagination.rb
lib/sequel/extensions/pretty_table.rb
lib/sequel/extensions/query.rb
lib/sequel/extensions/schema_dumper.rb
lib/sequel/extensions/thread_local_timezones.rb
lib/sequel/extensions/to_dot.rb
lib/sequel/extensions/arbitrary_servers.rb
lib/sequel/extensions/server_block.rb
lib/sequel/extensions/pg_auto_parameterize.rb
lib/sequel/extensions/pg_statement_cache.rb
lib/sequel/extensions/pg_array.rb
lib/sequel/extensions/pg_json.rb
lib/sequel/extensions/pg_array_ops.rb
lib/sequel/extensions/pg_hstore.rb
lib/sequel/extensions/pg_hstore_ops.rb
lib/sequel/extensions/schema_caching.rb
lib/sequel/extensions/null_dataset.rb
lib/sequel/extensions/_pretty_table.rb
lib/sequel/extensions/columns_introspection.rb
lib/sequel/extensions/select_remove.rb
lib/sequel/extensions/query_literals.rb
lib/sequel/extensions/pg_inet.rb
lib/sequel/metaprogramming.rb
lib/sequel/model.rb
lib/sequel/model/associations.rb
lib/sequel/model/base.rb
lib/sequel/model/default_inflections.rb
lib/sequel/model/errors.rb
lib/sequel/model/exceptions.rb
lib/sequel/model/inflections.rb
lib/sequel/model/plugins.rb
lib/sequel/plugins/active_model.rb
lib/sequel/plugins/association_dependencies.rb
lib/sequel/plugins/association_proxies.rb
lib/sequel/plugins/boolean_readers.rb
lib/sequel/plugins/caching.rb
lib/sequel/plugins/class_table_inheritance.rb
lib/sequel/plugins/force_encoding.rb
lib/sequel/plugins/hook_class_methods.rb
lib/sequel/plugins/identity_map.rb
lib/sequel/plugins/instance_hooks.rb
lib/sequel/plugins/lazy_attributes.rb
lib/sequel/plugins/many_through_many.rb
lib/sequel/plugins/nested_attributes.rb
lib/sequel/plugins/optimistic_locking.rb
lib/sequel/plugins/schema.rb
lib/sequel/plugins/serialization.rb
lib/sequel/plugins/subclasses.rb
lib/sequel/plugins/single_table_inheritance.rb
lib/sequel/plugins/tactical_eager_loading.rb
lib/sequel/plugins/timestamps.rb
lib/sequel/plugins/touch.rb
lib/sequel/plugins/typecast_on_load.rb
lib/sequel/plugins/validation_class_methods.rb
lib/sequel/plugins/validation_helpers.rb
lib/sequel/plugins/composition.rb
lib/sequel/plugins/rcte_tree.rb
lib/sequel/plugins/instance_filters.rb
lib/sequel/plugins/sharding.rb
lib/sequel/plugins/skip_create_refresh.rb
lib/sequel/plugins/string_stripper.rb
lib/sequel/plugins/update_primary_key.rb
lib/sequel/plugins/association_pks.rb
lib/sequel/plugins/json_serializer.rb
lib/sequel/plugins/list.rb
lib/sequel/plugins/tree.rb
lib/sequel/plugins/static_cache.rb
lib/sequel/plugins/xml_serializer.rb
lib/sequel/plugins/association_autoreloading.rb
lib/sequel/plugins/serialization_modification_detection.rb
lib/sequel/plugins/defaults_setter.rb
lib/sequel/plugins/prepared_statements.rb
lib/sequel/plugins/prepared_statements_safe.rb
lib/sequel/plugins/prepared_statements_with_pk.rb
lib/sequel/plugins/prepared_statements_associations.rb
lib/sequel/plugins/dataset_associations.rb
lib/sequel/plugins/many_to_one_pk_lookup.rb
lib/sequel/plugins/dirty.rb
lib/sequel/plugins/eager_each.rb
lib/sequel/timezones.rb
lib/sequel/version.rb
lib/sequel/ast_transformer.rb

The query_literals extension changes Sequel‘s default behavior of the select, order and group methods so that if the first argument is a regular string, it is treated as a literal string, with the rest of the arguments (if any) treated as placeholder values. This allows you to write code such as:

  DB[:table].select('a, b, ?', 2).group('a, b').order('c')

The default Sequel behavior would literalize that as:

  SELECT 'a, b, ?', 2 FROM table GROUP BY 'a, b' ORDER BY 'c'

Using this extension changes the literalization to:

  SELECT a, b, 2, FROM table GROUP BY a, b ORDER BY c

This extension makes select, group, and order methods operate like filter methods, which support the same interface.

There are very few places where Sequel‘s default behavior is desirable in this area, but for backwards compatibility, the defaults won‘t be changed until the next major release.

Loading this extension does nothing by default except make the Sequel::QueryLiterals module available. You can extend specific datasets with this module:

  ds = DB[:table]
  ds.extend(Sequel::QueryLiterals)

Order you can extend all of a database‘s datasets with it, which is probably the desired behavior if you are using this extension:

  DB.extend_datasets(Sequel::QueryLiterals)

Methods

Included Modules

SQL::Constants

Classes and Modules

Module Sequel::ADO
Module Sequel::Access
Module Sequel::Amalgalite
Module Sequel::ArbitraryServers
Module Sequel::ColumnsIntrospection
Module Sequel::DB2
Module Sequel::DBI
Module Sequel::DataObjects
Module Sequel::EmulateOffsetWithRowNumber
Module Sequel::Firebird
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::ServerBlock
Module Sequel::Swift
Module Sequel::ThreadLocalTimezones
Module Sequel::ThreadedServerBlock
Module Sequel::Timezones
Module Sequel::TinyTDS
Module Sequel::UnthreadedServerBlock
Class Sequel::ASTTransformer
Class Sequel::Adapter
Class Sequel::AdapterNotFound
Class Sequel::BasicObject
Class Sequel::ConnectionPool
Class Sequel::Database
Class Sequel::DatabaseConnectionError
Class Sequel::DatabaseDisconnectError
Class Sequel::DatabaseError
Class Sequel::Dataset
Class Sequel::Error
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::NotImplemented
Class Sequel::PoolTimeout
Class Sequel::Qualifier
Class Sequel::Rollback
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::UnbindDuplicate
Class Sequel::Unbinder
Class Sequel::UndefinedAssociation
Class Sequel::ValidationFailed

Constants

MYSQL_TYPES = {}   Hash with integer keys and callable values for converting MySQL types.
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.
ADAPTER_MAP = {}   Hash of adapters that have been used. The key is the adapter scheme symbol, and the value is the Database subclass.
DATABASES = []   Array of all databases to which Sequel has connected. If you are developing an application that can connect to an arbitrary number of databases, delete the database objects from this or they will not get garbage collected.
DEFAULT_INFLECTIONS_PROC = proc do plural(/$/, 's')   Proc that is instance evaled to create the default inflections for both the model inflector and the inflector extension.
BeforeHookFailed = HookFailed   Deprecated alias for HookFailed, kept for backwards compatibility
MAJOR = 3   The major version of Sequel. Only bumped for major changes.
MINOR = 36   The minor version of Sequel. Bumped for every non-patch level release, generally around once a month.
TINY = 1   The tiny version of Sequel. Usually 0, only bumped for bugfix releases that fix regressions from previous versions.
VERSION = [MAJOR, MINOR, TINY].join('.')   The version of Sequel you are using, as a string (e.g. "2.11.0")

External Aliases

require -> k_require
  Alias to the standard version of require

Attributes

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

empty_array_handle_nulls  [RW]  Sets whether or not to attempt to handle NULL values correctly when given an empty array. By default:
  DB[:a].filter(:b=>[])
  # SELECT * FROM a WHERE (b != b)
  DB[:a].exclude(:b=>[])
  # SELECT * FROM a WHERE (b = b)

However, some databases (e.g. MySQL) will perform very poorly with this type of query. You can set this to false to get the following behavior:

  DB[:a].filter(:b=>[])
  # SELECT * FROM a WHERE 1 = 0
  DB[:a].exclude(:b=>[])
  # SELECT * FROM a WHERE 1 = 1

This may not handle NULLs correctly, but can be much faster on some databases.

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
use_iso_date_format  [R]  As an optimization, Sequel sets the date style to ISO, so that PostgreSQL provides the date in a known format that Sequel can parse faster. This can be turned off if you require a date style other than ISO.
virtual_row_instance_eval  [RW]  For backwards compatibility, has no effect.

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 Sequel::Model.cache_anonymous_models && (klass = Sequel.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:     Sequel.synchronize{Model::ANONYMOUS_MODEL_CLASSES[source] = klass} if Sequel::Model.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 117
117:   def self.condition_specifier?(obj)
118:     case obj
119:     when Hash
120:       true
121:     when Array
122:       !obj.empty? && !obj.is_a?(SQL::ValueList) && obj.all?{|i| (Array === i) && (i.length == 2)}
123:     else
124:       false
125:     end
126:   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 146
146:   def self.connect(*args, &block)
147:     Database.connect(*args, &block)
148:   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 171
171:   def self.convert_exception_class(exception, klass)
172:     return exception if exception.is_a?(klass)
173:     e = klass.new("#{exception.class}: #{exception.message}")
174:     e.wrapped_exception = exception
175:     e.set_backtrace(exception.backtrace)
176:     e
177:   end

[Source]

     # File lib/sequel/core.rb, line 162
162:     def self.core_extensions?
163:       false
164:     end

Whether the core extensions are enabled. The core extensions are enabled by default for backwards compatibility, but can be disabled using the SEQUEL_NO_CORE_EXTENSIONS constant or environment variable.

[Source]

     # File lib/sequel/core.rb, line 154
154:     def self.core_extensions?
155:       # We override this method to return true inside the core_extensions.rb file,
156:       # but we also set it here because that file is not loaded until most of Sequel
157:       # is finished loading, and parts of Sequel check whether the core extensions
158:       # are loaded.
159:       true
160:     end

This extension loads the core extensions.

[Source]

   # File lib/sequel/extensions/core_extensions.rb, line 7
7: def Sequel.core_extensions?
8:   true
9: 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 189
189:   def self.extension(*extensions)
190:     extensions.each{|e| tsk_require "sequel/extensions/#{e}"}
191:   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 204
204:   def self.identifier_input_method=(value)
205:     Database.identifier_input_method = value
206:   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 220
220:   def self.identifier_output_method=(value)
221:     Database.identifier_output_method = value
222:   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 130
130:     def self.load_gem(name)
131:       begin
132:         Sequel.tsk_require "jdbc/#{name}"
133:       rescue LoadError
134:         # jdbc gem not used, hopefully the user has the .jar in their CLASSPATH
135:       end
136:     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 269
269:   def self.migration(&block)
270:     MigrationDSL.create(&block)
271:   end

Additional options supported:

:autoid :Call autoid= with the value
:columns :Call columns= with the value
:fetch :Call fetch= with the value
:numrows :Call numrows= with the value
:extend :A module the object is extended with.
:sqls :The array to store the SQL queries in.

[Source]

     # File lib/sequel/adapters/mock.rb, line 127
127:       def initialize(opts={})
128:         super
129:         opts = @opts
130:         if mod_name = SHARED_ADAPTERS[opts[:host]]
131:           @shared_adapter = true
132:           require "sequel/adapters/shared/#{opts[:host]}"
133:           extend Sequel.const_get(mod_name)::DatabaseMethods
134:           extend_datasets Sequel.const_get(mod_name)::DatasetMethods
135:           if pr = SHARED_ADAPTER_SETUP[opts[:host]]
136:             pr.call(self)
137:           end
138:         end
139:         self.autoid = opts[:autoid]
140:         self.columns = opts[:columns]
141:         self.fetch = opts[:fetch]
142:         self.numrows = opts[:numrows]
143:         extend(opts[:extend]) if opts[:extend]
144:         @sqls = opts[:sqls] || []
145:       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 228
228:   def self.quote_identifiers=(value)
229:     Database.quote_identifiers = value
230:   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 236
236:   def self.require(files, subdir=nil)
237:     Array(files).each{|f| super("#{File.dirname(__FILE__).untaint}/#{"#{subdir}/" if subdir}#{f}")}
238:   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 247
247:   def self.single_threaded=(value)
248:     @single_threaded = value
249:     Database.single_threaded = value
250:   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 255
255:   def self.string_to_date(string)
256:     begin
257:       Date.parse(string, Sequel.convert_two_digit_years)
258:     rescue => e
259:       raise convert_exception_class(e, InvalidValue)
260:     end
261:   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 267
267:   def self.string_to_datetime(string)
268:     begin
269:       if datetime_class == DateTime
270:         DateTime.parse(string, convert_two_digit_years)
271:       else
272:         datetime_class.parse(string)
273:       end
274:     rescue => e
275:       raise convert_exception_class(e, InvalidValue)
276:     end
277:   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 283
283:   def self.string_to_time(string)
284:     begin
285:       SQLTime.parse(string)
286:     rescue => e
287:       raise convert_exception_class(e, InvalidValue)
288:     end
289:   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 298
298:     def self.synchronize(&block)
299:       @single_threaded ? yield : @data_mutex.synchronize(&block)
300:     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 304
304:     def self.synchronize(&block)
305:       yield
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 332
332:   def self.transaction(dbs, opts={}, &block)
333:     unless opts[:rollback]
334:       rescue_rollback = true
335:       opts = opts.merge(:rollback=>:reraise)
336:     end
337:     pr = dbs.reverse.inject(block){|bl, db| proc{db.transaction(opts, &bl)}}
338:     if rescue_rollback
339:       begin
340:         pr.call
341:       rescue Sequel::Rollback => e
342:         nil
343:       end
344:     else
345:       pr.call
346:     end
347:   end

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

[Source]

     # File lib/sequel/core.rb, line 350
350:   def self.ts_require(*args)
351:     check_requiring_thread{require(*args)}
352:   end

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

[Source]

     # File lib/sequel/core.rb, line 355
355:   def self.tsk_require(*args)
356:     check_requiring_thread{k_require(*args)}
357:   end

Modify the type translator for the date type depending on the value given.

[Source]

     # File lib/sequel/adapters/postgres.rb, line 146
146:     def self.use_iso_date_format=(v)
147:       PG_TYPES[1082] = v ? TYPE_TRANSLATOR.method(:date) : Sequel.method(:string_to_date)
148:       @use_iso_date_format = v
149:     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 a new SQL::VirtualRow instance to the block argument. Otherwise, evaluate the block in the context of a new SQL::VirtualRow instance.

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

[Source]

     # File lib/sequel/core.rb, line 366
366:   def self.virtual_row(&block)
367:     vr = SQL::VirtualRow.new
368:     case block.arity
369:     when -1, 0
370:       vr.instance_eval(&block)
371:     else
372:       block.call(vr)
373:     end  
374:   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

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 155
155:       def execute(sql, opts={}, &block)
156:         synchronize(opts[:server]){|c| _execute(c, sql, opts, &block)} 
157:       end
execute_ddl(sql, 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 161
161:       def execute_dui(sql, opts={})
162:         execute(sql, opts.merge(:meth=>:numrows))
163:       end

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

[Source]

     # File lib/sequel/adapters/mock.rb, line 166
166:       def execute_insert(sql, opts={})
167:         execute(sql, opts.merge(:meth=>:autoid))
168:       end

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

[Source]

     # File lib/sequel/adapters/mock.rb, line 172
172:       def sqls
173:         s = @sqls.dup
174:         @sqls.clear
175:         s
176:       end

Enable use of savepoints.

[Source]

     # File lib/sequel/adapters/mock.rb, line 179
179:       def supports_savepoints?
180:         shared_adapter? ? super : true
181:       end

[Validate]