The schema_dumper extension supports dumping tables and indexes in a Sequel::Migration format, so they can be restored on another database (which can be the same type or a different type than the current database). The main interface is through Sequel::Database#dump_schema_migration.
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 | ||
LOCAL_DATETIME_OFFSET_SECS | = | Time.now.utc_offset | The offset of the current time zone from UTC, in seconds. | |
LOCAL_DATETIME_OFFSET | = | respond_to?(:Rational, true) ? Rational(LOCAL_DATETIME_OFFSET_SECS, 60*60*24) : LOCAL_DATETIME_OFFSET_SECS/60/60/24.0 | The offset of the current time zone from UTC, as a fraction of a day. | |
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 | = | lambda do plural(/$/, 's') | Proc that is instance evaled to create the default inflections for both the model inflector and the inflector extension. | |
MAJOR | = | 3 | ||
MINOR | = | 4 | ||
TINY | = | 0 | ||
VERSION | = | [MAJOR, MINOR, TINY].join('.') |
application_timezone | [RW] | |
convert_two_digit_years | [RW] | |
database_timezone | [RW] | |
datetime_class | [RW] | |
typecast_timezone | [RW] | |
virtual_row_instance_eval | [RW] |
Lets you create a Model subclass with its dataset already set. source can be an existing dataset or a symbol (in which case it will create a dataset using the default database with the given symbol as the table name).
The purpose of this method is to set the dataset 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, and allows it to work correctly in a system that uses code reloading.
Example:
class Comment < Sequel::Model(:something) table_name # => :something end
# File lib/sequel/model.rb, line 19 19: def self.Model(source) 20: Model::ANONYMOUS_MODEL_CLASSES[source] ||= if source.is_a?(Database) 21: c = Class.new(Model) 22: c.db = source 23: c 24: else 25: Class.new(Model).set_dataset(source) 26: end 27: end
Returns true if the passed object could be a specifier of conditions, false otherwise. Currently, Sequel considers hashes and arrays of all two pairs as condition specifiers.
# 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.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}
# File lib/sequel/core.rb, line 115 115: def self.connect(*args, &block) 116: Database.connect(*args, &block) 117: end
Convert the given object into an object of Sequel.datetime_class in the application_timezone. Used when coverting datetime/timestamp columns returned by the database.
# File lib/sequel/core.rb, line 122 122: def self.database_to_application_timestamp(v) 123: convert_timestamp(v, Sequel.database_timezone) 124: end
Sets the database, application, and typecasting timezones to the given timezone.
# File lib/sequel/core.rb, line 127 127: def self.default_timezone=(tz) 128: self.database_timezone = tz 129: self.application_timezone = tz 130: self.typecast_timezone = tz 131: end
Load all Sequel extensions given. Only loads extensions included in this release of Sequel, doesn‘t load external extensions.
Sequel.extension(:schema_dumper) Sequel.extension(:pagination, :query)
# File lib/sequel/core.rb, line 138 138: def self.extension(*extensions) 139: require(extensions, 'extensions') 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.
# 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.
# 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.
# 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 75 75: def self.load_gem(name) 76: begin 77: require "jdbc/#{name}" 78: rescue LoadError 79: # jdbc gem not used, hopefully the user has the .jar in their CLASSPATH 80: end 81: 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.
# File lib/sequel/core.rb, line 183 183: def self.require(files, subdir=nil) 184: Array(files).each{|f| super("#{File.dirname(__FILE__)}/#{"#{subdir}/" if subdir}#{f}")} 185: end
Set whether to set the single threaded mode for all databases by default. By default, Sequel uses a threadsafe 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 193 193: def self.single_threaded=(value) 194: Database.single_threaded = value 195: end
Converts the given string into a Date object.
# File lib/sequel/core.rb, line 198 198: def self.string_to_date(s) 199: begin 200: Date.parse(s, Sequel.convert_two_digit_years) 201: rescue => e 202: raise InvalidValue, "Invalid Date value #{s.inspect} (#{e.message})" 203: end 204: end
Converts the given string into a Time or DateTime object, depending on the value of Sequel.datetime_class.
# File lib/sequel/core.rb, line 208 208: def self.string_to_datetime(s) 209: begin 210: if datetime_class == DateTime 211: DateTime.parse(s, convert_two_digit_years) 212: else 213: datetime_class.parse(s) 214: end 215: rescue => e 216: raise InvalidValue, "Invalid #{datetime_class} value #{s.inspect} (#{e.message})" 217: end 218: end
Converts the given string into a Time object.
# File lib/sequel/core.rb, line 221 221: def self.string_to_time(s) 222: begin 223: Time.parse(s) 224: rescue => e 225: raise InvalidValue, "Invalid Time value #{s.inspect} (#{e.message})" 226: end 227: end
Convert the given object into an object of Sequel.datetime_class in the application_timezone. Used when typecasting values when assigning them to model datetime attributes.
# File lib/sequel/core.rb, line 232 232: def self.typecast_to_application_timestamp(v) 233: convert_timestamp(v, Sequel.typecast_timezone) 234: end