Module | Sequel::Model::ClassMethods |
In: |
lib/sequel/model/base.rb
|
Class methods for Sequel::Model that implement basic model functionality.
allowed_columns | [R] | Which columns should be the only columns allowed in a call to a mass assignment method (e.g. set) (default: not set, so all columns not otherwise restricted are allowed). |
dataset_method_modules | [R] | 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. |
dataset_methods | [R] | Hash of dataset methods with method name keys and proc values that are stored so when the dataset changes, methods defined with def_dataset_method will be applied to the new dataset. |
plugins | [R] |
Array of plugin modules loaded by this class
Sequel::Model.plugins # => [Sequel::Model, Sequel::Model::Associations] |
primary_key | [R] | 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. |
raise_on_save_failure | [RW] | Whether to raise an error instead of returning nil on a failure to save/create/save_changes/etc due to a validation failure or a before_* hook returning false. |
raise_on_typecast_failure | [RW] | Whether to raise an error when unable to typecast data for a column (default: true). This should be set to false if you want to use validations to display nice error messages to the user (e.g. most web applications). You can use the validates_not_string validations (from either the validation_helpers or validation_class_methods standard plugins) in connection with option to check for typecast failures for columns that aren‘t blobs or strings. |
require_modification | [RW] | 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). |
restricted_columns | [R] | Which columns are specifically restricted in a call to set/update/new/etc. (default: not set). Some columns are restricted regardless of this setting, such as the primary key column and columns in Model::RESTRICTED_SETTER_METHODS. |
simple_pk | [R] | 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. |
simple_table | [R] | 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.[]. |
strict_param_setting | [RW] | Whether new/set/update and their variants 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. |
typecast_empty_string_to_nil | [RW] | 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. |
typecast_on_assignment | [RW] | 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. |
use_after_commit_rollback | [RW] | Whether to enable the after_commit and after_rollback hooks when saving/destroying instances. On by default, can be turned off for performance reasons or when using prepared transactions (which aren‘t compatible with after commit/rollback). |
use_transactions | [RW] | 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. |
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, line 109 109: def [](*args) 110: args = args.first if (args.size == 1) 111: args.is_a?(Hash) ? dataset[args] : primary_key_lookup(args) 112: 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, line 118 118: def call(values) 119: o = allocate 120: o.set_values(values) 121: o.after_initialize 122: o 123: end
Clear the setter_methods cache
# File lib/sequel/model/base.rb, line 126 126: def clear_setter_methods_cache 127: @setter_methods = nil 128: 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, line 137 137: def columns 138: @columns || set_columns(dataset.naked.columns) 139: 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, line 149 149: def create(values = {}, &block) 150: new(values, &block).save 151: 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, line 159 159: def dataset 160: @dataset || raise(Error, "No dataset associated with #{self}") 161: end
Alias of set_dataset
# File lib/sequel/model/base.rb, line 164 164: def dataset=(ds) 165: set_dataset(ds) 166: end
Extend the dataset with a module, similar to adding a plugin with the methods defined in DatasetMethods. If a block is given, an anonymous module is created and the module_evaled, otherwise the argument should be a module. Returns the module given or the anonymous module created.
Artist.dataset_module Sequel::ColumnsIntrospection Artist.dataset_module do def foo :bar end end Artist.dataset.foo # => :bar Artist.foo # => :bar
# File lib/sequel/model/base.rb, line 185 185: def dataset_module(mod = nil) 186: if mod 187: raise Error, "can't provide both argument and block to Model.dataset_module" if block_given? 188: dataset_extend(mod) 189: mod 190: else 191: @dataset_module ||= Module.new 192: @dataset_module.module_eval(&Proc.new) if block_given? 193: dataset_extend(@dataset_module) 194: @dataset_module 195: end 196: 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, line 208 208: def db 209: return @db if @db 210: @db = self == Model ? DATABASES.first : superclass.db 211: raise(Error, "No database associated with #{self}: have you called Sequel.connect or #{self}.db= ?") unless @db 212: @db 213: end
Sets the database associated with the Model class. If the model has an associated dataset, sets the model‘s dataset to a dataset on the new database with the same options used by the current dataset. 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.db = DB2
# File lib/sequel/model/base.rb, line 225 225: def db=(db) 226: @db = db 227: set_dataset(db.dataset(@dataset.opts)) if @dataset 228: 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, line 238 238: def db_schema 239: @db_schema ||= get_db_schema 240: 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, line 244 244: def def_column_alias(meth, column) 245: clear_setter_methods_cache 246: overridable_methods_module.module_eval do 247: define_method(meth){self[column]} 248: define_method("#{meth}="){|v| self[column] = v} 249: end 250: end
If a block is given, define a method on the dataset (if the model currently has an dataset) with the given argument name using the given block. Also define a class method on the model that calls the dataset method. Stores the method name and block so that it can be reapplied if the model‘s dataset changes.
If a block is not given, just define a class method on the model for each argument that calls the dataset method of the same argument name.
# Add new dataset method and class method that calls it Artist.def_dataset_method(:by_name){order(:name)} Artist.filter(:name.like('A%')).by_name Artist.by_name.filter(:name.like('A%')) # Just add a class method that calls an existing dataset method Artist.def_dataset_method(:server!) Artist.server!(:server1)
# File lib/sequel/model/base.rb, line 268 268: def def_dataset_method(*args, &block) 269: raise(Error, "No arguments given") if args.empty? 270: if block 271: raise(Error, "Defining a dataset method using a block requires only one argument") if args.length > 1 272: meth = args.first 273: @dataset_methods[meth] = block 274: dataset.meta_def(meth, &block) if @dataset 275: end 276: args.each do |arg| 277: if arg.to_s =~ NORMAL_METHOD_NAME_REGEXP 278: instance_eval("def #{arg}(*args, &block); dataset.#{arg}(*args, &block) end", __FILE__, __LINE__) unless respond_to?(arg, true) 279: else 280: def_model_dataset_method_block(arg) 281: end 282: end 283: 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, line 310 310: def find(*args, &block) 311: filter(*args, &block).first 312: 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, line 326 326: def find_or_create(cond, &block) 327: find(cond) || create(cond, &block) 328: 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, line 376 376: def implicit_table_name 377: pluralize(underscore(demodulize(name))).to_sym 378: end
Clear the setter_methods cache when a module is included, as it may contain setter methods.
# File lib/sequel/model/base.rb, line 332 332: def include(mod) 333: clear_setter_methods_cache 334: super 335: 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, line 346 346: def inherited(subclass) 347: super 348: ivs = subclass.instance_variables.collect{|x| x.to_s} 349: EMPTY_INSTANCE_VARIABLES.each{|iv| subclass.instance_variable_set(iv, nil) unless ivs.include?(iv.to_s)} 350: INHERITED_INSTANCE_VARIABLES.each do |iv, dup| 351: next if ivs.include?(iv.to_s) 352: sup_class_value = instance_variable_get(iv) 353: sup_class_value = sup_class_value.dup if dup == :dup && sup_class_value 354: subclass.instance_variable_set(iv, sup_class_value) 355: end 356: unless ivs.include?("@dataset") 357: db 358: begin 359: if self == Model || !@dataset 360: n = subclass.name 361: subclass.set_dataset(subclass.implicit_table_name) unless n.nil? || n.empty? 362: elsif @dataset 363: subclass.set_dataset(@dataset.clone, :inherited=>true) 364: end 365: rescue 366: nil 367: end 368: end 369: end
Clear the setter_methods cache when a setter method is added
# File lib/sequel/model/base.rb, line 386 386: def method_added(meth) 387: clear_setter_methods_cache if meth.to_s =~ SETTER_METHOD_REGEXP 388: super 389: 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, line 397 397: def no_primary_key 398: clear_setter_methods_cache 399: @simple_pk = @primary_key = nil 400: 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 either sequel/plugins/#{plugin} or sequel_#{plugin}, and then attempt to load the module using a the camelized plugin name under Sequel::Plugins.
# File lib/sequel/model/base.rb, line 407 407: def plugin(plugin, *args, &blk) 408: m = plugin.is_a?(Module) ? plugin : plugin_module(plugin) 409: unless @plugins.include?(m) 410: @plugins << m 411: m.apply(self, *args, &blk) if m.respond_to?(:apply) 412: include(m::InstanceMethods) if plugin_module_defined?(m, :InstanceMethods) 413: extend(m::ClassMethods)if plugin_module_defined?(m, :ClassMethods) 414: dataset_extend(m::DatasetMethods) if plugin_module_defined?(m, :DatasetMethods) 415: end 416: m.configure(self, *args, &blk) if m.respond_to?(:configure) 417: 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}
# File lib/sequel/model/base.rb, line 427 427: def primary_key_hash(value) 428: raise(Error, "#{self} does not have a primary key") unless key = @primary_key 429: case key 430: when Array 431: hash = {} 432: key.each_with_index{|k,i| hash[k] = value[i]} 433: hash 434: else 435: {key => value} 436: end 437: end
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.filter(Artist.qualified_primary_key_hash(1)) # SELECT * FROM artists WHERE (artists.id = 1)
# File lib/sequel/model/base.rb, line 446 446: def qualified_primary_key_hash(value, qualifier=table_name) 447: h = primary_key_hash(value) 448: h.to_a.each{|k,v| h[SQL::QualifiedIdentifier.new(qualifier, k)] = h.delete(k)} 449: h 450: 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, line 455 455: def restrict_primary_key 456: clear_setter_methods_cache 457: @restrict_primary_key = true 458: 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, line 462 462: def restrict_primary_key? 463: @restrict_primary_key 464: end
Set the columns to allow when using mass assignment (e.g. set). Using this means that any columns not listed here will not be modified. If you have any virtual setter methods (methods that end in =) that you want to be used during mass assignment, they need to be listed here as well (without the =).
It may be better to use a method such as set_only or set_fields that lets you specify the allowed fields per call.
Artist.set_allowed_columns(:name, :hometown) Artist.set(:name=>'Bob', :hometown=>'Sactown') # No Error Artist.set(:name=>'Bob', :records_sold=>30000) # Error
# File lib/sequel/model/base.rb, line 477 477: def set_allowed_columns(*cols) 478: clear_setter_methods_cache 479: @allowed_columns = cols 480: 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.
This changes the row_proc of the dataset to return model objects, extends the dataset with the dataset_method_modules, and defines methods on the dataset using the dataset_methods. It also attempts to determine the database schema for the model, based on the given dataset.
Artist.set_dataset(:tbl_artists) Artist.set_dataset(DB[:artists])
# File lib/sequel/model/base.rb, line 499 499: def set_dataset(ds, opts={}) 500: inherited = opts[:inherited] 501: @dataset = case ds 502: when Symbol, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression, LiteralString 503: @simple_table = db.literal(ds) 504: db.from(ds) 505: when Dataset 506: @simple_table = if ds.send(:simple_select_all?) 507: ds.literal(ds.first_source_table) 508: else 509: nil 510: end 511: @db = ds.db 512: ds 513: else 514: raise(Error, "Model.set_dataset takes one of the following classes as an argument: Symbol, LiteralString, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression, Dataset") 515: end 516: @dataset.row_proc = self 517: @require_modification = Sequel::Model.require_modification.nil? ? @dataset.provides_accurate_rows_matched? : Sequel::Model.require_modification 518: if inherited 519: @simple_table = superclass.simple_table 520: @columns = @dataset.columns rescue nil 521: else 522: @dataset_method_modules.each{|m| @dataset.extend(m)} if @dataset_method_modules 523: @dataset_methods.each{|meth, block| @dataset.meta_def(meth, &block)} if @dataset_methods 524: end 525: @dataset.model = self if @dataset.respond_to?(:model=) 526: check_non_connection_error{@db_schema = (inherited ? superclass.db_schema : get_db_schema)} 527: self 528: 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, line 544 544: def set_primary_key(*key) 545: clear_setter_methods_cache 546: key = key.flatten 547: @simple_pk = if key.length == 1 548: (@dataset || db).literal(key.first) 549: else 550: nil 551: end 552: @primary_key = (key.length == 1) ? key[0] : key 553: end
Set the columns to restrict when using mass assignment (e.g. set). Using this means that attempts to call setter methods for the columns listed here will cause an exception or be silently skipped (based on the strict_param_setting setting. If you have any virtual setter methods (methods that end in =) that you want not to be used during mass assignment, they need to be listed here as well (without the =).
It‘s generally a bad idea to rely on a blacklist approach for security. Using a whitelist approach such as set_allowed_columns or the instance level set_only or set_fields methods is usually a better choice. So use of this method is generally a bad idea.
Artist.set_restricted_column(:records_sold) Artist.set(:name=>'Bob', :hometown=>'Sactown') # No Error Artist.set(:name=>'Bob', :records_sold=>30000) # Error
# File lib/sequel/model/base.rb, line 568 568: def set_restricted_columns(*cols) 569: clear_setter_methods_cache 570: @restricted_columns = cols 571: end
Cache of setter methods to allow by default, in order to speed up new/set/update instance methods.
# File lib/sequel/model/base.rb, line 574 574: def setter_methods 575: @setter_methods ||= if allowed_columns 576: allowed_columns.map{|x| "#{x}="} 577: else 578: meths = instance_methods.collect{|x| x.to_s}.grep(SETTER_METHOD_REGEXP) - RESTRICTED_SETTER_METHODS 579: meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && restrict_primary_key? 580: meths -= restricted_columns.map{|x| "#{x}="} if restricted_columns 581: meths 582: end 583: end
Shortcut for def_dataset_method that is restricted to modifying the dataset‘s filter. Sometimes thought of as a scope, and like most dataset methods, they can be chained. For example:
Topic.subset(:joes, :username.like('%joe%')) Topic.subset(:popular){num_posts > 100} Topic.subset(:recent){created_on > Date.today - 7}
Allows you to do:
Topic.joes.recent.popular
to get topics with a username that includes joe that have more than 100 posts and were created less than 7 days ago.
Both the args given and the block are passed to Dataset#filter.
This method creates dataset methods that do not accept arguments. To create dataset methods that accept arguments, you have to use def_dataset_method.
# File lib/sequel/model/base.rb, line 606 606: def subset(name, *args, &block) 607: def_dataset_method(name){filter(*args, &block)} 608: 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(:foo___bar).table_name # => :bar
# File lib/sequel/model/base.rb, line 616 616: def table_name 617: dataset.first_source_alias 618: 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, line 626 626: def unrestrict_primary_key 627: clear_setter_methods_cache 628: @restrict_primary_key = false 629: end