# File lib/sequel/model/base.rb 561 def primary_key_hash(value) 562 case key = @primary_key 563 when Symbol 564 {key => value} 565 when Array 566 hash = {} 567 key.zip(Array(value)){|k,v| hash[k] = v} 568 hash 569 else 570 raise(Error, "#{self} does not have a primary key") 571 end 572 end
module Sequel::Model::ClassMethods
Class methods for Sequel::Model
that implement basic model functionality.
-
All of the following methods have class methods created that send the method to the model's dataset: all, as_hash, avg, count, cross_join, distinct, each, each_server, empty?, except, exclude, exclude_having, fetch_rows, filter, first, first!, for_update, from, from_self, full_join, full_outer_join, get, graph, grep, group, group_and_count, group_append, group_by, having, import, inner_join, insert, intersect, invert, join, join_table, last, left_join, left_outer_join, limit, lock_style, map, max, min, multi_insert, naked, natural_full_join, natural_join, natural_left_join, natural_right_join, offset, order, order_append, order_by, order_more, order_prepend, paged_each, qualify, reverse, reverse_order, right_join, right_outer_join, select, select_all, select_append, select_group, select_hash, select_hash_groups, select_map, select_more, select_order_map, server, single_record, single_record!, single_value, single_value!, sum, to_hash, to_hash_groups, truncate, unfiltered, ungraphed, ungrouped, union, unlimited, unordered, where, where_all, where_each, where_single_value, with, with_recursive, with_sql
Attributes
Whether to cache the anonymous models created by Sequel::Model(), true by default. This is required for reloading them correctly (avoiding the superclass mismatch).
Array
of modules that extend this model's dataset. Stored so that if the model's dataset is changed, it will be extended with all of these modules.
The Module subclass to use for dataset_module
blocks.
The default options to use for Model#set_fields. These are merged with the options given to set_fields.
SQL
string fragment used for faster DELETE statement creation when deleting/destroying model instances, or nil if the optimization should not be used. For internal use only.
SQL
string fragment used for faster lookups by primary key, or nil if the optimization should not be used. For internal use only.
The dataset that instance datasets (#this) are based on. Generally a naked version of the model's dataset limited to one row. For internal use only.
Array
of plugin modules loaded by this class
Sequel::Model.plugins # => [Sequel::Model, Sequel::Model::Associations]
The primary key for the class. Sequel
can determine this automatically for many databases, but not all, so you may need to set it manually. If not determined automatically, the default is :id.
Whether to raise an error instead of returning nil on a failure to save/create/save_changes/update/destroy due to a validation failure or a before_* hook returning false (default: true).
Whether to raise an error when unable to typecast data for a column (default: false). This should be set to true if you want to have model setter methods raise errors if the argument cannot be typecast properly.
Whether to raise an error if an UPDATE or DELETE query related to a model instance does not modify exactly 1 row. If set to false, Sequel
will not check the number of rows modified (default: true).
If true (the default), requires that all models have valid tables, raising exceptions if creating a model without a valid table backing it. Setting this to false will allow the creation of model classes where the underlying table doesn't exist.
Should be the literal primary key column name if this Model's table has a simple primary key, or nil if the model has a compound primary key or no primary key.
Should be the literal table name if this Model's dataset is a simple table (no select, order, join, etc.), or nil otherwise. This and simple_pk
are used for an optimization in Model.[].
Whether mass assigning via .create/.new/#set/#update should raise an error if an invalid key is used. A key is invalid if no setter method exists for that key or the access to the setter method is restricted (e.g. due to it being a primary key field). If set to false, silently skip any key where the setter method doesn't exist or access to it is restricted.
Whether to typecast the empty string ('') to nil for columns that are not string or blob. In most cases the empty string would be the way to specify a NULL SQL
value in string form (nil.to_s == ''), and an empty string would not usually be typecast correctly for other types, so the default is true.
Whether to typecast attribute values on assignment (default: true). If set to false, no typecasting is done, so it will be left up to the database to typecast the value correctly.
Whether to use a transaction by default when saving/deleting records (default: true). If you are sending database queries in before_* or after_* hooks, you shouldn't change the default setting without a good reason.
Public Instance 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 theDatabase
insource
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 default table name that Sequel
would use.
When creating subclasses of Sequel::Model
itself, this method is usually called on Sequel
itself, using Sequel::Model(:something)
.
# 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/base.rb 179 def Model(source) 180 if cache_anonymous_models 181 cache = Sequel.synchronize{@Model_cache ||= {}} 182 if klass = Sequel.synchronize{cache[source]} 183 return klass 184 end 185 end 186 187 klass = Class.new(self) 188 189 if source.is_a?(::Sequel::Database) 190 klass.db = source 191 else 192 klass.set_dataset(source) 193 end 194 195 if cache_anonymous_models 196 Sequel.synchronize{cache[source] = klass} 197 end 198 199 klass 200 end
Returns the first record from the database matching the conditions. If a hash is given, it is used as the conditions. If another object is given, it finds the first record whose primary key(s) match the given argument(s). If no object is returned by the dataset, returns nil.
Artist[1] # SELECT * FROM artists WHERE id = 1 # => #<Artist {:id=>1, ...}> Artist[name: 'Bob'] # SELECT * FROM artists WHERE (name = 'Bob') LIMIT 1 # => #<Artist {:name=>'Bob', ...}>
# File lib/sequel/model/base.rb 212 def [](*args) 213 args = args.first if args.size <= 1 214 args.is_a?(Hash) ? first(args) : (primary_key_lookup(args) unless args.nil?) 215 end
Initializes a model instance as an existing record. This constructor is used by Sequel
to initialize model instances when fetching records. Requires that values be a hash where all keys are symbols. It probably should not be used by external code.
# File lib/sequel/model/base.rb 221 def call(values) 222 o = allocate 223 o.instance_variable_set(:@values, values) 224 o 225 end
Clear the setter_methods
cache
# File lib/sequel/model/base.rb 228 def clear_setter_methods_cache 229 @setter_methods = nil unless frozen? 230 end
Returns the columns in the result set in their original order. Generally, this will use the columns determined via the database schema, but in certain cases (e.g. models that are based on a joined dataset) it will use Dataset#columns
to find the columns.
Artist.columns # => [:id, :name]
# File lib/sequel/model/base.rb 239 def columns 240 return @columns if @columns 241 return nil if frozen? 242 set_columns(dataset.naked.columns) 243 end
Creates instance using new with the given values and block, and saves it.
Artist.create(name: 'Bob') # INSERT INTO artists (name) VALUES ('Bob') Artist.create do |a| a.name = 'Jim' end # INSERT INTO artists (name) VALUES ('Jim')
# File lib/sequel/model/base.rb 253 def create(values = OPTS, &block) 254 new(values, &block).save 255 end
Returns the dataset associated with the Model
class. Raises an Error
if there is no associated dataset for this class. In most cases, you don't need to call this directly, as Model
proxies many dataset methods to the underlying dataset.
Artist.dataset.all # SELECT * FROM artists
# File lib/sequel/model/base.rb 263 def dataset 264 @dataset || raise(Error, "No dataset associated with #{self}") 265 end
Alias of set_dataset
# File lib/sequel/model/base.rb 268 def dataset=(ds) 269 set_dataset(ds) 270 end
Extend the dataset with a module, similar to adding a plugin with the methods defined in DatasetMethods
. This is the recommended way to add methods to model datasets.
If given an argument, it should be a module, and is used to extend the underlying dataset. Otherwise an anonymous module is created, and if a block is given, it is module_evaled, allowing you do define dataset methods directly using the standard ruby def syntax. Returns the module given or the anonymous module created.
# Usage with existing module Album.dataset_module Sequel::ColumnsIntrospection # Usage with anonymous module Album.dataset_module do def foo :bar end end Album.dataset.foo # => :bar Album.foo # => :bar
Any anonymous modules created are actually instances of Sequel::Model::DatasetModule
(a Module subclass), which allows you to call the subset method on them, which defines a dataset method that adds a filter. There are also a number of other methods with the same names as the dataset methods, which can use to define named dataset methods:
Album.dataset_module do where(:released, Sequel[:release_date] <= Sequel::CURRENT_DATE) order :by_release_date, :release_date select :for_select_options, :id, :name, :release_date end Album.released.sql # => "SELECT * FROM artists WHERE (release_date <= CURRENT_DATE)" Album.by_release_date.sql # => "SELECT * FROM artists ORDER BY release_date" Album.for_select_options.sql # => "SELECT id, name, release_date FROM artists" Album.released.by_release_date.for_select_options.sql # => "SELECT id, name, release_date FROM artists WHERE (release_date <= CURRENT_DATE) ORDER BY release_date"
The following methods are supported: distinct, eager, exclude, exclude_having, grep, group, group_and_count, group_append, having, limit, offset, order, order_append, order_prepend, select, select_all, select_append, select_group, where, and server.
The advantage of using these DatasetModule
methods to define your dataset methods is that they can take advantage of dataset caching to improve performance.
Any public methods in the dataset module will have class methods created that call the method on the dataset, assuming that the class method is not already defined.
# File lib/sequel/model/base.rb 327 def dataset_module(mod = nil, &block) 328 if mod 329 raise Error, "can't provide both argument and block to Model.dataset_module" if block 330 dataset_extend(mod) 331 mod 332 else 333 @dataset_module ||= dataset_module_class.new(self) 334 @dataset_module.module_eval(&block) if block 335 dataset_extend(@dataset_module) 336 @dataset_module 337 end 338 end
Returns the database associated with the Model
class. If this model doesn't have a database associated with it, assumes the superclass's database, or the first object in Sequel::DATABASES. If no Sequel::Database
object has been created, raises an error.
Artist.db.transaction do # BEGIN Artist.create(name: 'Bob') # INSERT INTO artists (name) VALUES ('Bob') end # COMMIT
# File lib/sequel/model/base.rb 350 def db 351 return @db if @db 352 @db = self == Model ? Sequel.synchronize{DATABASES.first} : superclass.db 353 raise(Error, "No database associated with #{self}: have you called Sequel.connect or #{self}.db= ?") unless @db 354 @db 355 end
Sets the database associated with the Model
class. Should only be used if the Model
class currently does not have a dataset defined.
This can be used directly on Sequel::Model
to set the default database to be used by subclasses, or to override the database used for specific models:
Sequel::Model.db = DB1 Artist = Class.new(Sequel::Model) Artist.db = DB2
Note that you should not use this to change the model's database at runtime. If you have that need, you should look into Sequel's sharding support, or consider using separate model classes per Database
.
# File lib/sequel/model/base.rb 371 def db=(db) 372 raise Error, "Cannot use Sequel::Model.db= on model with existing dataset. Use Sequel::Model.dataset= instead." if @dataset 373 @db = db 374 end
Returns the cached schema information if available or gets it from the database. This is a hash where keys are column symbols and values are hashes of information related to the column. See Database#schema
.
Artist.db_schema # {:id=>{:type=>:integer, :primary_key=>true, ...}, # :name=>{:type=>:string, :primary_key=>false, ...}}
# File lib/sequel/model/base.rb 384 def db_schema 385 return @db_schema if @db_schema 386 return nil if frozen? 387 @db_schema = get_db_schema 388 end
Define a Model
method on the given module that calls the Model
method on the receiver. This is how the Sequel::Model() method is defined, and allows you to define Model() methods on other modules, making it easier to have custom model settings for all models under a namespace. Example:
module Foo Model = Class.new(Sequel::Model) Model.def_Model(self) DB = Model.db = Sequel.connect(ENV['FOO_DATABASE_URL']) Model.plugin :prepared_statements class Bar < Model # Uses Foo::DB[:bars] end class Baz < Model(:my_baz) # Uses Foo::DB[:my_baz] end end
# File lib/sequel/model/base.rb 137 def def_Model(mod) 138 model = self 139 mod.define_singleton_method(:Model) do |source| 140 model.Model(source) 141 end 142 end
Create a column alias, where the column methods have one name, but the underlying storage uses a different name.
# File lib/sequel/model/base.rb 392 def def_column_alias(meth, column) 393 clear_setter_methods_cache 394 overridable_methods_module.module_eval do 395 define_method(meth){self[column]} 396 define_method("#{meth}="){|v| self[column] = v} 397 end 398 end
Finds a single record according to the supplied filter. You are encouraged to use Model.[] or Model.first instead of this method.
Artist.find(name: 'Bob') # SELECT * FROM artists WHERE (name = 'Bob') LIMIT 1 Artist.find{name > 'M'} # SELECT * FROM artists WHERE (name > 'M') LIMIT 1
# File lib/sequel/model/base.rb 408 def find(*args, &block) 409 first(*args, &block) 410 end
Like find
but invokes create with given conditions when record does not exist. Unlike find
in that the block used in this method is not passed to find
, but instead is passed to create
only if find
does not return an object.
Artist.find_or_create(name: 'Bob') # SELECT * FROM artists WHERE (name = 'Bob') LIMIT 1 # INSERT INTO artists (name) VALUES ('Bob') Artist.find_or_create(name: 'Jim'){|a| a.hometown = 'Sactown'} # SELECT * FROM artists WHERE (name = 'Jim') LIMIT 1 # INSERT INTO artists (name, hometown) VALUES ('Jim', 'Sactown')
# File lib/sequel/model/base.rb 424 def find_or_create(cond, &block) 425 find(cond) || create(cond, &block) 426 end
Freeze a model class, disallowing any further changes to it.
# File lib/sequel/model/base.rb 429 def freeze 430 return self if frozen? 431 dataset_module.freeze 432 overridable_methods_module.freeze 433 434 if @dataset 435 db_schema.freeze.each_value(&:freeze) 436 columns.freeze 437 setter_methods.freeze 438 else 439 @setter_methods = [].freeze 440 end 441 442 @dataset_method_modules.freeze 443 @default_set_fields_options.freeze 444 @plugins.freeze 445 446 super 447 end
Whether the model has a dataset. True for most model classes, but can be false if the model class is an abstract model class designed for subclassing, such as Sequel::Model
itself.
# File lib/sequel/model/base.rb 452 def has_dataset? 453 !@dataset.nil? 454 end
Returns the implicit table name for the model class, which is the demodulized, underscored, pluralized name of the class.
Artist.implicit_table_name # => :artists Foo::ArtistAlias.implicit_table_name # => :artist_aliases
# File lib/sequel/model/base.rb 509 def implicit_table_name 510 pluralize(underscore(demodulize(name))).to_sym 511 end
Clear the setter_methods
cache when a module is included, as it may contain setter methods.
# File lib/sequel/model/base.rb 458 def include(*mods) 459 clear_setter_methods_cache 460 super 461 end
If possible, set the dataset for the model subclass as soon as it is created. Also, make sure the inherited class instance variables are copied into the subclass.
Sequel
queries the database to get schema information as soon as a model class is created:
class Artist < Sequel::Model # Causes schema query end
# File lib/sequel/model/base.rb 472 def inherited(subclass) 473 super 474 ivs = subclass.instance_variables 475 inherited_instance_variables.each do |iv, dup| 476 next if ivs.include?(iv) 477 if (sup_class_value = instance_variable_get(iv)) && dup 478 sup_class_value = case dup 479 when :dup 480 sup_class_value.dup 481 when :hash_dup 482 h = {} 483 sup_class_value.each{|k,v| h[k] = v.dup} 484 h 485 when Proc 486 dup.call(sup_class_value) 487 else 488 raise Error, "bad inherited instance variable type: #{dup.inspect}" 489 end 490 end 491 subclass.instance_variable_set(iv, sup_class_value) 492 end 493 494 unless ivs.include?(:@dataset) 495 if @dataset && self != Model 496 subclass.set_dataset(@dataset.clone, :inherited=>true) 497 elsif (n = subclass.name) && !n.to_s.empty? 498 db 499 subclass.set_dataset(subclass.implicit_table_name) 500 end 501 end 502 end
Calls call
with the values hash.
# File lib/sequel/model/base.rb 514 def load(values) 515 call(values) 516 end
Clear the setter_methods
cache when a setter method is added.
# File lib/sequel/model/base.rb 519 def method_added(meth) 520 clear_setter_methods_cache if meth.to_s.end_with?('=') 521 super 522 end
Mark the model as not having a primary key. Not having a primary key can cause issues, among which is that you won't be able to update records.
Artist.primary_key # => :id Artist.no_primary_key Artist.primary_key # => nil
# File lib/sequel/model/base.rb 530 def no_primary_key 531 clear_setter_methods_cache 532 self.simple_pk = @primary_key = nil 533 end
Loads a plugin for use with the model class, passing optional arguments to the plugin. If the plugin is a module, load it directly. Otherwise, require the plugin from sequel/plugins/#{plugin} and then attempt to load the module using a the camelized plugin name under Sequel::Plugins
.
# File lib/sequel/model/base.rb 539 def plugin(plugin, *args, &block) 540 m = plugin.is_a?(Module) ? plugin : plugin_module(plugin) 541 unless @plugins.include?(m) 542 @plugins << m 543 m.apply(self, *args, &block) if m.respond_to?(:apply) 544 extend(m::ClassMethods) if m.const_defined?(:ClassMethods, false) 545 include(m::InstanceMethods) if m.const_defined?(:InstanceMethods, false) 546 if m.const_defined?(:DatasetMethods, false) 547 dataset_extend(m::DatasetMethods, :create_class_methods=>false) 548 end 549 end 550 m.configure(self, *args, &block) if m.respond_to?(:configure) 551 end
Returns primary key attribute hash. If using a composite primary key value such be an array with values for each primary key in the correct order. For a standard primary key, value should be an object with a compatible type for the key. If the model does not have a primary key, raises an Error
.
Artist.primary_key_hash(1) # => {:id=>1} Artist.primary_key_hash([1, 2]) # => {:id1=>1, :id2=>2}
Return a hash where the keys are qualified column references. Uses the given qualifier if provided, or the table_name
otherwise. This is useful if you plan to join other tables to this table and you want the column references to be qualified.
Artist.where(Artist.qualified_primary_key_hash(1)) # SELECT * FROM artists WHERE (artists.id = 1)
# File lib/sequel/model/base.rb 581 def qualified_primary_key_hash(value, qualifier=table_name) 582 case key = @primary_key 583 when Symbol 584 {SQL::QualifiedIdentifier.new(qualifier, key) => value} 585 when Array 586 hash = {} 587 key.zip(Array(value)){|k,v| hash[SQL::QualifiedIdentifier.new(qualifier, k)] = v} 588 hash 589 else 590 raise(Error, "#{self} does not have a primary key") 591 end 592 end
Restrict the setting of the primary key(s) when using mass assignment (e.g. set
). Because this is the default, this only make sense to use in a subclass where the parent class has used unrestrict_primary_key
.
# File lib/sequel/model/base.rb 597 def restrict_primary_key 598 clear_setter_methods_cache 599 @restrict_primary_key = true 600 end
Whether or not setting the primary key(s) when using mass assignment (e.g. set
) is restricted, true by default.
# File lib/sequel/model/base.rb 604 def restrict_primary_key? 605 @restrict_primary_key 606 end
Sets the dataset associated with the Model
class. ds
can be a Symbol
, LiteralString
, SQL::Identifier
, SQL::QualifiedIdentifier
, SQL::AliasedExpression
(all specifying a table name in the current database), or a Dataset
. If a dataset is used, the model's database is changed to the database of the given dataset. If a dataset is not used, a dataset is created from the current database with the table name given. Other arguments raise an Error
. Returns self.
It also attempts to determine the database schema for the model, based on the given dataset.
Note that you should not use this to change the model's dataset at runtime. If you have that need, you should look into Sequel's sharding support, or creating a separate Model
class per dataset
You should avoid calling this method directly if possible. Instead you should set the table name or dataset when creating the model class:
# table name class Artist < Sequel::Model(:tbl_artists) end # dataset class Artist < Sequel::Model(DB[:tbl_artists]) end
# File lib/sequel/model/base.rb 634 def set_dataset(ds, opts=OPTS) 635 inherited = opts[:inherited] 636 @dataset = convert_input_dataset(ds) 637 @require_modification = @dataset.provides_accurate_rows_matched? if require_modification.nil? 638 if inherited 639 self.simple_table = superclass.simple_table 640 @columns = superclass.instance_variable_get(:@columns) 641 @db_schema = superclass.instance_variable_get(:@db_schema) 642 else 643 @dataset = @dataset.with_extend(*@dataset_method_modules.reverse) if @dataset_method_modules 644 @db_schema = get_db_schema 645 end 646 647 reset_instance_dataset 648 self 649 end
Sets the primary key for this model. You can use either a regular or a composite primary key. To not use a primary key, set to nil or use no_primary_key
. On most adapters, Sequel
can automatically determine the primary key to use, so this method is not needed often.
class Person < Sequel::Model # regular key set_primary_key :person_id end class Tagging < Sequel::Model # composite key set_primary_key [:taggable_id, :tag_id] end
# File lib/sequel/model/base.rb 665 def set_primary_key(key) 666 clear_setter_methods_cache 667 if key.is_a?(Array) 668 if key.length < 2 669 key = key.first 670 else 671 key = key.dup.freeze 672 end 673 end 674 self.simple_pk = if key && !key.is_a?(Array) 675 (@dataset || db).literal(key).freeze 676 end 677 @primary_key = key 678 end
Cache of setter methods to allow by default, in order to speed up mass assignment.
# File lib/sequel/model/base.rb 681 def setter_methods 682 return @setter_methods if @setter_methods 683 @setter_methods = get_setter_methods 684 end
Returns name of primary table for the dataset. If the table for the dataset is aliased, returns the aliased name.
Artist.table_name # => :artists Sequel::Model(:foo).table_name # => :foo Sequel::Model(Sequel[:foo].as(:bar)).table_name # => :bar
# File lib/sequel/model/base.rb 692 def table_name 693 dataset.first_source_alias 694 end
Allow the setting of the primary key(s) when using the mass assignment methods. Using this method can open up security issues, be very careful before using it.
Artist.set(id: 1) # Error Artist.unrestrict_primary_key Artist.set(id: 1) # No Error
# File lib/sequel/model/base.rb 702 def unrestrict_primary_key 703 clear_setter_methods_cache 704 @restrict_primary_key = false 705 end
Return the model instance with the primary key, or nil if there is no matching record.
# File lib/sequel/model/base.rb 708 def with_pk(pk) 709 primary_key_lookup(pk) 710 end
Return the model instance with the primary key, or raise NoMatchingRow
if there is no matching record.
# File lib/sequel/model/base.rb 713 def with_pk!(pk) 714 with_pk(pk) || raise(NoMatchingRow.new(dataset)) 715 end
Private Instance Methods
Yield to the passed block and if do_raise is false, swallow all errors other than DatabaseConnectionErrors.
# File lib/sequel/model/base.rb 723 def check_non_connection_error(do_raise=require_valid_table) 724 begin 725 db.transaction(:savepoint=>:only){yield} 726 rescue Sequel::DatabaseConnectionError 727 raise 728 rescue Sequel::Error 729 raise if do_raise 730 end 731 end
Convert the given object to a Dataset
that should be used as this model's dataset.
# File lib/sequel/model/base.rb 735 def convert_input_dataset(ds) 736 case ds 737 when Symbol, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression, LiteralString 738 self.simple_table = db.literal(ds).freeze 739 ds = db.from(ds) 740 when Dataset 741 ds = ds.from_self(:alias=>ds.first_source) if ds.joined_dataset? 742 743 self.simple_table = if ds.send(:simple_select_all?) 744 ds.literal(ds.first_source_table).freeze 745 end 746 @db = ds.db 747 else 748 raise(Error, "Model.set_dataset takes one of the following classes as an argument: Symbol, LiteralString, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression, Dataset") 749 end 750 751 set_dataset_row_proc(ds.clone(:model=>self)) 752 end
Add the module to the class's dataset_method_modules. Extend the dataset with the module if the model has a dataset. Add dataset methods to the class for all public dataset methods.
# File lib/sequel/model/base.rb 757 def dataset_extend(mod, opts=OPTS) 758 @dataset = @dataset.with_extend(mod) if @dataset 759 reset_instance_dataset 760 dataset_method_modules << mod 761 unless opts[:create_class_methods] == false 762 mod.public_instance_methods.each{|meth| def_model_dataset_method(meth)} 763 end 764 end
Create a column accessor for a column with a method name that is hard to use in ruby code.
# File lib/sequel/model/base.rb 767 def def_bad_column_accessor(column) 768 im = instance_methods 769 overridable_methods_module.module_eval do 770 meth = :"#{column}=" 771 define_method(column){self[column]} unless im.include?(column) 772 define_method(meth){|v| self[column] = v} unless im.include?(meth) 773 end 774 end
Create the column accessors. For columns that can be used as method names directly in ruby code, use a string to define the method for speed. For other columns names, use a block.
# File lib/sequel/model/base.rb 778 def def_column_accessor(*columns) 779 clear_setter_methods_cache 780 columns, bad_columns = columns.partition{|x| /\A[A-Za-z_][A-Za-z0-9_]*\z/.match(x.to_s)} 781 bad_columns.each{|x| def_bad_column_accessor(x)} 782 im = instance_methods 783 columns.each do |column| 784 meth = :"#{column}=" 785 overridable_methods_module.module_eval("def #{column}; self[:#{column}] end", __FILE__, __LINE__) unless im.include?(column) 786 overridable_methods_module.module_eval("def #{meth}(v); self[:#{column}] = v end", __FILE__, __LINE__) unless im.include?(meth) 787 end 788 end
Define a model method that calls the dataset method with the same name, only used for methods with names that can't be represented directly in ruby code.
# File lib/sequel/model/base.rb 793 def def_model_dataset_method(meth) 794 return if respond_to?(meth, true) 795 796 if meth.to_s =~ /\A[A-Za-z_][A-Za-z0-9_]*\z/ 797 instance_eval("def #{meth}(*args, &block); dataset.#{meth}(*args, &block) end", __FILE__, __LINE__) 798 else 799 define_singleton_method(meth){|*args, &block| dataset.public_send(meth, *args, &block)} 800 end 801 end
Get the schema from the database, fall back on checking the columns via the database if that will return inaccurate results or if it raises an error.
# File lib/sequel/model/base.rb 806 def get_db_schema(reload = reload_db_schema?) 807 set_columns(nil) 808 return nil unless @dataset 809 schema_hash = {} 810 ds_opts = dataset.opts 811 get_columns = proc{check_non_connection_error{columns} || []} 812 schema_array = check_non_connection_error(false){db.schema(dataset, :reload=>reload)} if db.supports_schema_parsing? 813 if schema_array 814 schema_array.each{|k,v| schema_hash[k] = v} 815 816 # Set the primary key(s) based on the schema information, 817 # if the schema information includes primary key information 818 if schema_array.all?{|k,v| v.has_key?(:primary_key)} 819 pks = schema_array.map{|k,v| k if v[:primary_key]}.compact 820 pks.length > 0 ? set_primary_key(pks) : no_primary_key 821 end 822 823 if (select = ds_opts[:select]) && !(select.length == 1 && select.first.is_a?(SQL::ColumnAll)) 824 # We don't remove the columns from the schema_hash, 825 # as it's possible they will be used for typecasting 826 # even if they are not selected. 827 cols = get_columns.call 828 cols.each{|c| schema_hash[c] ||= {}} 829 def_column_accessor(*schema_hash.keys) 830 else 831 # Dataset is for a single table with all columns, 832 # so set the columns based on the order they were 833 # returned by the schema. 834 cols = schema_array.map{|k,v| k} 835 set_columns(cols) 836 # Also set the columns for the dataset, so the dataset 837 # doesn't have to do a query to get them. 838 dataset.send(:columns=, cols) 839 end 840 else 841 # If the dataset uses multiple tables or custom sql or getting 842 # the schema raised an error, just get the columns and 843 # create an empty schema hash for it. 844 get_columns.call.each{|c| schema_hash[c] = {}} 845 end 846 schema_hash 847 end
Uncached version of setter_methods
, to be overridden by plugins that want to modify the methods used.
# File lib/sequel/model/base.rb 851 def get_setter_methods 852 meths = instance_methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS 853 meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && restrict_primary_key? 854 meths 855 end
A hash of instance variables to automatically set up in subclasses. Keys are instance variable symbols, values should be:
- nil
-
Assign directly from superclass to subclass (frozen objects)
- :dup
-
Dup object when assigning from superclass to subclass (mutable objects)
- :hash_dup
-
Assign hash with same keys, but dup all the values
- Proc
-
Call with subclass to do the assignment
# File lib/sequel/model/base.rb 863 def inherited_instance_variables 864 { 865 :@cache_anonymous_models=>nil, 866 :@dataset_method_modules=>:dup, 867 :@dataset_module_class=>nil, 868 :@db=>nil, 869 :@default_set_fields_options=>:dup, 870 :@fast_instance_delete_sql=>nil, 871 :@fast_pk_lookup_sql=>nil, 872 :@plugins=>:dup, 873 :@primary_key=>nil, 874 :@raise_on_save_failure=>nil, 875 :@raise_on_typecast_failure=>nil, 876 :@require_modification=>nil, 877 :@require_valid_table=>nil, 878 :@restrict_primary_key=>nil, 879 :@setter_methods=>nil, 880 :@simple_pk=>nil, 881 :@simple_table=>nil, 882 :@strict_param_setting=>nil, 883 :@typecast_empty_string_to_nil=>nil, 884 :@typecast_on_assignment=>nil, 885 :@use_transactions=>nil 886 } 887 end
For the given opts hash and default name or :class option, add a :class_name option unless already present which contains the name of the class to use as a string. The purpose is to allow late binding to the class later using constantize.
# File lib/sequel/model/base.rb 893 def late_binding_class_option(opts, default) 894 case opts[:class] 895 when String, Symbol 896 # Delete :class to allow late binding 897 class_name = opts.delete(:class).to_s 898 899 if (namespace = opts[:class_namespace]) && !class_name.start_with?('::') 900 class_name = "::#{namespace}::#{class_name}" 901 end 902 903 opts[:class_name] ||= class_name 904 when Class 905 opts[:class_name] ||= opts[:class].name 906 end 907 908 opts[:class_name] ||= '::' + ((name || '').split("::")[0..-2] + [camelize(default)]).join('::') 909 end
Module that the class includes that holds methods the class adds for column accessors and associations so that the methods can be overridden with super
.
# File lib/sequel/model/base.rb 913 def overridable_methods_module 914 include(@overridable_methods_module = Module.new) unless @overridable_methods_module 915 @overridable_methods_module 916 end
Returns the module for the specified plugin. If the module is not defined, the corresponding plugin required.
# File lib/sequel/model/base.rb 920 def plugin_module(plugin) 921 module_name = plugin.to_s.gsub(/(^|_)(.)/){|x| x[-1..-1].upcase} 922 unless Sequel::Plugins.const_defined?(module_name, false) 923 require "sequel/plugins/#{plugin}" 924 end 925 Sequel::Plugins.const_get(module_name) 926 end
Find the row in the dataset that matches the primary key. Uses a static SQL
optimization if the table and primary key are simple.
This method should not be called with a nil primary key, in case it is overridden by plugins which assume that the passed argument is valid.
# File lib/sequel/model/base.rb 934 def primary_key_lookup(pk) 935 if sql = @fast_pk_lookup_sql 936 sql = sql.dup 937 ds = dataset 938 ds.literal_append(sql, pk) 939 ds.fetch_rows(sql){|r| return ds.row_proc.call(r)} 940 nil 941 else 942 dataset.first(primary_key_hash(pk)) 943 end 944 end
Whether to reload the database schema by default, ignoring any cached value.
# File lib/sequel/model/base.rb 947 def reload_db_schema? 948 false 949 end
Reset the cached fast primary lookup SQL
if a simple table and primary key are used, or set it to nil if not used.
# File lib/sequel/model/base.rb 953 def reset_fast_pk_lookup_sql 954 @fast_pk_lookup_sql = if @simple_table && @simple_pk 955 "SELECT * FROM #{@simple_table} WHERE #{@simple_pk} = ".freeze 956 end 957 @fast_instance_delete_sql = if @simple_table && @simple_pk 958 "DELETE FROM #{@simple_table} WHERE #{@simple_pk} = ".freeze 959 end 960 end
Reset the instance dataset to a modified copy of the current dataset, should be used whenever the model's dataset is modified.
# File lib/sequel/model/base.rb 964 def reset_instance_dataset 965 @instance_dataset = @dataset.limit(1).naked.skip_limit_check if @dataset 966 end
Set the columns for this model and create accessor methods for each column.
# File lib/sequel/model/base.rb 969 def set_columns(new_columns) 970 @columns = new_columns 971 def_column_accessor(*new_columns) if new_columns 972 @columns 973 end
Set the dataset's row_proc to the current model.
# File lib/sequel/model/base.rb 976 def set_dataset_row_proc(ds) 977 ds.with_row_proc(self) 978 end
Reset the fast primary key lookup SQL
when the simple_table
value changes.
# File lib/sequel/model/base.rb 987 def simple_table=(t) 988 @simple_table = t 989 reset_fast_pk_lookup_sql 990 end