The query extension adds Sequel::Dataset#query which allows a different way to construct queries instead of the usual method chaining.
| MYSQL_TYPES | = | {} | Hash with integer keys and callable values for converting MySQL types. | |
| SQLITE_TYPES | = | {} | Hash with string keys and callable values for converting SQLite types. | |
| SELECT_SERIAL_SEQUENCE | = | proc do |schema, table| <<-end_sql SELECT '"' || name.nspname || '".' || seq.relname || '' FROM pg_class seq, pg_attribute attr, pg_depend dep, pg_namespace name, pg_constraint cons WHERE seq.oid = dep.objid AND seq.relnamespace = name.oid AND seq.relkind = 'S' AND attr.attrelid = dep.refobjid AND attr.attnum = dep.refobjsubid AND attr.attrelid = cons.conrelid AND attr.attnum = cons.conkey[1] AND cons.contype = 'p' #{"AND name.nspname = '#{schema}'" if schema} AND seq.relname = '#{table}' end_sql | ||
| PG_NAMED_TYPES | = | {} | Hash with type name 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 | = | {} | Hash with integer keys and callable values for converting PostgreSQL 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. | |
| BeforeHookFailed | = | HookFailed | ||
| DEFAULT_INFLECTIONS_PROC | = | proc do plural(/$/, 's') | Proc that is instance evaled to create the default inflections for both the model inflector and the inflector extension. | |
| MAJOR | = | 3 | The major version of Sequel. Only bumped for major changes. | |
| MINOR | = | 24 | 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") |
| convert_invalid_date_time | [R] | By default, Sequel raises an exception if in invalid date or time is used. However, if this is set to nil or :nil, the adapter treats dates like 0000-00-00 and times like 838:00:00 as nil values. If set to :string, it returns the strings as is. |
| 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). |
| 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. |
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. |
| Symbol : | 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
# File lib/sequel/model.rb, line 37
37: def self.Model(source)
38: Model::ANONYMOUS_MODEL_CLASSES[source] ||= if source.is_a?(Database)
39: c = Class.new(Model)
40: c.db = source
41: c
42: else
43: Class.new(Model).set_dataset(source)
44: end
45: 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
# File lib/sequel/core.rb, line 89
89: def self.condition_specifier?(obj)
90: case obj
91: when Hash
92: true
93: when Array
94: !obj.empty? && !obj.is_a?(SQL::ValueList) && obj.all?{|i| (Array === i) && (i.length == 2)}
95: else
96: false
97: end
98: 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.
# File lib/sequel/core.rb, line 118
118: def self.connect(*args, &block)
119: Database.connect(*args, &block)
120: end
If convert_invalid_date_time is nil, :nil, or :string and the conversion raises an InvalidValue exception, return v if :string and nil otherwise.
# File lib/sequel/adapters/mysql.rb, line 69
69: def self.convert_date_time(meth, v)
70: begin
71: Sequel.send(meth, v)
72: rescue InvalidValue
73: case @convert_invalid_date_time
74: when nil, :nil
75: nil
76: when :string
77: v
78: else
79: raise
80: end
81: end
82: 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.
# File lib/sequel/core.rb, line 125
125: def self.convert_exception_class(exception, klass)
126: return exception if exception.is_a?(klass)
127: e = klass.new("#{exception.class}: #{exception.message}")
128: e.wrapped_exception = exception
129: e.set_backtrace(exception.backtrace)
130: e
131: end
Modify the type translators for the date, time, and timestamp types depending on the value given.
# File lib/sequel/adapters/mysql.rb, line 56
56: def self.convert_invalid_date_time=(v)
57: MYSQL_TYPES[11] = TYPE_TRANSLATOR.method(v == false ? :time : :time_conv)
58: m = TYPE_TRANSLATOR.method(v == false ? :date : :date_conv)
59: [10, 14].each{|i| MYSQL_TYPES[i] = m}
60: m = TYPE_TRANSLATOR.method(v == false ? :timestamp : :timestamp_conv)
61: [7, 12].each{|i| MYSQL_TYPES[i] = m}
62: @convert_invalid_date_time = v
63: end
Modify the type translator used for the tinyint type based on the value given.
# File lib/sequel/adapters/mysql.rb, line 40
40: def self.convert_tinyint_to_bool=(v)
41: MYSQL_TYPES[1] = TYPE_TRANSLATOR.method(v ? :boolean : :integer)
42: @convert_tinyint_to_bool = v
43: 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)
# File lib/sequel/core.rb, line 143
143: def self.extension(*extensions)
144: extensions.each{|e| tsk_require "sequel/extensions/#{e}"}
145: 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.
# File lib/sequel/core.rb, line 158
158: def self.identifier_input_method=(value)
159: Database.identifier_input_method = value
160: 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.
# File lib/sequel/core.rb, line 174
174: def self.identifier_output_method=(value)
175: Database.identifier_output_method = value
176: end
Yield the Inflections module if a block is given, and return the Inflections module.
# 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.
# File lib/sequel/adapters/jdbc.rb, line 88
88: def self.load_gem(name)
89: begin
90: Sequel.tsk_require "jdbc/#{name}"
91: rescue LoadError
92: # jdbc gem not used, hopefully the user has the .jar in their CLASSPATH
93: end
94: 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.
# File lib/sequel/extensions/migration.rb, line 240
240: def self.migration(&block)
241: MigrationDSL.create(&block)
242: 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.
# File lib/sequel/core.rb, line 190
190: def self.require(files, subdir=nil)
191: Array(files).each{|f| super("#{File.dirname(__FILE__)}/#{"#{subdir}/" if subdir}#{f}")}
192: end
Set whether to set the single threaded mode for all databases by default. By default, Sequel uses a thread-safe connection pool, which isn‘t as fast as the single threaded connection pool. If your program will only have one thread, and speed is a priority, you may want to set this to true:
Sequel.single_threaded = true
# File lib/sequel/core.rb, line 200
200: def self.single_threaded=(value)
201: Database.single_threaded = value
202: end
Converts the given string into a Date object.
Sequel.string_to_date('2010-09-10') # Date.civil(2010, 09, 10)
# File lib/sequel/core.rb, line 207
207: def self.string_to_date(string)
208: begin
209: Date.parse(string, Sequel.convert_two_digit_years)
210: rescue => e
211: raise convert_exception_class(e, InvalidValue)
212: end
213: 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)
# File lib/sequel/core.rb, line 219
219: def self.string_to_datetime(string)
220: begin
221: if datetime_class == DateTime
222: DateTime.parse(string, convert_two_digit_years)
223: else
224: datetime_class.parse(string)
225: end
226: rescue => e
227: raise convert_exception_class(e, InvalidValue)
228: end
229: end
Converts the given string into a Time object.
Sequel.string_to_datetime('10:20:30') # Time.parse('10:20:30')
# File lib/sequel/core.rb, line 234
234: def self.string_to_time(string)
235: begin
236: Time.parse(string)
237: rescue => e
238: raise convert_exception_class(e, InvalidValue)
239: end
240: end
Same as Sequel.require, but wrapped in a mutex in order to be thread safe.
# File lib/sequel/core.rb, line 243
243: def self.ts_require(*args)
244: check_requiring_thread{require(*args)}
245: end
Same as Kernel.require, but wrapped in a mutex in order to be thread safe.
# File lib/sequel/core.rb, line 248
248: def self.tsk_require(*args)
249: check_requiring_thread{k_require(*args)}
250: end
Modify the type translator for the date type depending on the value given.
# File lib/sequel/adapters/postgres.rb, line 130
130: def self.use_iso_date_format=(v)
131: PG_TYPES[1082] = TYPE_TRANSLATOR.method(v ? :date_iso : :date)
132: @use_iso_date_format = v
133: 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)
# File lib/sequel/core.rb, line 259
259: def self.virtual_row(&block)
260: vr = SQL::VirtualRow.new
261: case block.arity
262: when -1, 0
263: vr.instance_eval(&block)
264: else
265: block.call(vr)
266: end
267: end