Sequel::Model
instance methods that implement basic model functionality.
-
All of the model before/after/around hooks are implemented as instance methods that are called by
Sequel
when the appropriate action occurs. For example, when destroying a model object,Sequel
will callaround_destroy
, which will callbefore_destroy
, do the destroy, and then callafter_destroy
. -
The following instance_methods all call the class method of the same name: columns, db, primary_key, db_schema.
-
The following accessor methods are defined via metaprogramming: raise_on_save_failure, raise_on_typecast_failure, require_modification, strict_param_setting, typecast_empty_string_to_nil, typecast_on_assignment, and use_transactions. The setter methods will change the setting for the instance, and the getter methods will check for an instance setting, then try the class setting if no instance setting has been set.
Methods
Public Class
Public Instance
- ==
- ===
- []
- []=
- autoincrementing_primary_key
- cancel_action
- changed_columns
- delete
- destroy
- each
- eql?
- errors
- exists?
- extend
- freeze
- hash
- id
- inspect
- keys
- lock!
- marshallable!
- modified!
- modified?
- new?
- pk
- pk_hash
- qualified_pk_hash
- refresh
- reload
- save
- save_changes
- set
- set_fields
- set_server
- singleton_method_added
- skip_validation_on_next_save!
- this
- update
- update_fields
- valid?
- validate
- values
Public Instance Aliases
pk_equal? | -> | === |
If the receiver has a primary key value, returns true if the objects have the same class and primary key value. If the receiver’s primary key value is nil or is an array containing nil, returns false. Artist[1].pk_equal?(Artist[1]) # => true Artist.new.pk_equal?(Artist.new) # => false Artist[1].set(name: 'Bob').pk_equal?(Artist[1]) # => true |
Attributes
to_hash | [R] |
The hash of attribute values. Keys are symbols with the names of the underlying database columns. The returned hash is a reference to the receiver’s values hash, and modifying it will also modify the receiver’s values. Artist.new(name: 'Bob').values # => {:name=>'Bob'} Artist[1].values # => {:id=>1, :name=>'Jim', ...} |
values | [R] |
The hash of attribute values. Keys are symbols with the names of the underlying database columns. The returned hash is a reference to the receiver’s values hash, and modifying it will also modify the receiver’s values. Artist.new(name: 'Bob').values # => {:name=>'Bob'} Artist[1].values # => {:id=>1, :name=>'Jim', ...} |
Public Class methods
Creates new instance and passes the given values to set. If a block is given, yield the instance to the block.
Arguments:
values |
should be a hash to pass to set. |
Artist.new(name: 'Bob') Artist.new do |a| a.name = 'Bob' end
# File lib/sequel/model/base.rb 1134 def initialize(values = OPTS) 1135 @values = {} 1136 @new = true 1137 @modified = true 1138 initialize_set(values) 1139 _clear_changed_columns(:initialize) 1140 yield self if defined?(yield) 1141 end
Public Instance methods
Alias of eql?
# File lib/sequel/model/base.rb 1171 def ==(obj) 1172 eql?(obj) 1173 end
Case equality. By default, checks equality of the primary key value, see pk_equal?.
Artist[1] === Artist[1] # => true Artist.new === Artist.new # => false Artist[1].set(name: 'Bob') === Artist[1] # => true
# File lib/sequel/model/base.rb 1181 def ===(obj) 1182 case pkv = pk 1183 when nil 1184 return false 1185 when Array 1186 return false if pkv.any?(&:nil?) 1187 end 1188 1189 (obj.class == model) && (obj.pk == pkv) 1190 end
Returns value of the column’s attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb 1146 def [](column) 1147 @values[column] 1148 end
Sets the value for the given column. If typecasting is enabled for this object, typecast the value based on the column’s type. If this is a new record or the typecasted value isn’t the same as the current value for the column, mark the column as changed.
a = Artist.new a[:name] = 'Bob' a.values #=> {:name=>'Bob'}
# File lib/sequel/model/base.rb 1158 def []=(column, value) 1159 # If it is new, it doesn't have a value yet, so we should 1160 # definitely set the new value. 1161 # If the column isn't in @values, we can't assume it is 1162 # NULL in the database, so assume it has changed. 1163 v = typecast_value(column, value) 1164 vals = @values 1165 if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class 1166 change_column_value(column, v) 1167 end 1168 end
The autoincrementing primary key for this model object. Should be overridden if you have a composite primary key with one part of it being autoincrementing.
# File lib/sequel/model/base.rb 1213 def autoincrementing_primary_key 1214 primary_key 1215 end
Cancel the current action. Should be called in before hooks to halt the processing of the action. If a msg
argument is given and the model instance is configured to raise exceptions on failure, sets the message to use for the raised HookFailed
exception.
# File lib/sequel/model/base.rb 1221 def cancel_action(msg=nil) 1222 raise_hook_failure(msg) 1223 end
The columns that have been updated. This isn’t completely accurate, as it could contain columns whose values have not changed.
a = Artist[1] a.changed_columns # => [] a.name = 'Bob' a.changed_columns # => [:name]
# File lib/sequel/model/base.rb 1232 def changed_columns 1233 _changed_columns 1234 end
Deletes and returns self
. Does not run destroy hooks. Look into using destroy
instead.
Artist[1].delete # DELETE FROM artists WHERE (id = 1) # => #<Artist {:id=>1, ...}>
# File lib/sequel/model/base.rb 1241 def delete 1242 raise Sequel::Error, "can't delete frozen object" if frozen? 1243 _delete 1244 self 1245 end
Like delete but runs hooks before and after delete. Uses a transaction if use_transactions is true or if the :transaction option is given and true.
Artist[1].destroy # BEGIN; DELETE FROM artists WHERE (id = 1); COMMIT; # => #<Artist {:id=>1, ...}>
# File lib/sequel/model/base.rb 1253 def destroy(opts = OPTS) 1254 raise Sequel::Error, "can't destroy frozen object" if frozen? 1255 checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 1256 end
Iterates through all of the current values using each.
Album[1].each{|k, v| puts "#{k} => #{v}"} # id => 1 # name => 'Bob'
# File lib/sequel/model/base.rb 1263 def each(&block) 1264 @values.each(&block) 1265 end
Compares model instances by values.
Artist[1] == Artist[1] # => true Artist.new == Artist.new # => true Artist[1].set(name: 'Bob') == Artist[1] # => false
# File lib/sequel/model/base.rb 1272 def eql?(obj) 1273 (obj.class == model) && (obj.values == @values) 1274 end
Returns the validation errors associated with this object. See Errors
.
# File lib/sequel/model/base.rb 1278 def errors 1279 @errors ||= errors_class.new 1280 end
Returns true when current instance exists, false otherwise. Generally an object that isn’t new will exist unless it has been deleted. Uses a database query to check for existence, unless the model object is new, in which case this is always false.
Artist[1].exists? # SELECT 1 AS one FROM artists WHERE (id = 1) # => true Artist.new.exists? # => false
# File lib/sequel/model/base.rb 1295 def exists? 1296 new? ? false : !this.get(EXISTS_SELECT_).nil? 1297 end
Ignore the model’s setter method cache when this instances extends a module, as the module may contain setter methods.
# File lib/sequel/model/base.rb 1301 def extend(mod) 1302 @singleton_setter_added = true 1303 super 1304 end
Freeze the object in such a way that it is still usable but not modifiable. Once an object is frozen, you cannot modify it’s values, changed_columns
, errors, or dataset.
# File lib/sequel/model/base.rb 1309 def freeze 1310 unless errors.frozen? 1311 validate 1312 errors.freeze 1313 end 1314 values.freeze 1315 _changed_columns.freeze 1316 this if !new? && model.primary_key 1317 super 1318 end
Value that should be unique for objects with the same class and pk (if pk is not nil), or the same class and values (if pk is nil).
Artist[1].hash == Artist[1].hash # true Artist[1].set(name: 'Bob').hash == Artist[1].hash # true Artist.new.hash == Artist.new.hash # true Artist.new(name: 'Bob').hash == Artist.new.hash # false
# File lib/sequel/model/base.rb 1327 def hash 1328 case primary_key 1329 when Array 1330 [model, !pk.all? ? @values : pk].hash 1331 when Symbol 1332 [model, pk.nil? ? @values : pk].hash 1333 else 1334 [model, @values].hash 1335 end 1336 end
Returns value for the :id attribute, even if the primary key is not id. To get the primary key value, use pk
.
Artist[1].id # => 1
# File lib/sequel/model/base.rb 1342 def id 1343 @values[:id] 1344 end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb 1348 def inspect 1349 "#<#{inspect_prefix} @values=#{inspect_values}>" 1350 end
Returns the keys in values
. May not include all column names.
Artist.new.keys # => [] Artist.new(name: 'Bob').keys # => [:name] Artist[1].keys # => [:id, :name]
# File lib/sequel/model/base.rb 1357 def keys 1358 @values.keys 1359 end
Refresh this record using :update
lock style (by default, or the specified style when given), unless this is a new record. Returns self. This can be used to make sure no other process can modify the record during the transaction containing this call. Using this method only makes sense inside transactions.
If style is a string, it will be used directly. You should never pass a string to this method that is derived from user input, as that can lead to SQL
injection.
A symbol may be used if the adapter supports that lock style.
a = Artist[1] Artist.db.transaction do a.lock! a.update(name: 'A') end a = Artist[2] Artist.db.transaction do a.lock!(:no_key_update) a.update(name: 'B') end
# File lib/sequel/model/base.rb 1383 def lock!(style=:update) 1384 _refresh(this.lock_style(style)) unless new? 1385 self 1386 end
Remove elements of the model object that make marshalling fail. Returns self.
a = Artist[1] a.marshallable! Marshal.dump(a)
# File lib/sequel/model/base.rb 1393 def marshallable! 1394 @this = nil 1395 self 1396 end
Explicitly mark the object as modified, so save_changes
/update
will run callbacks even if no columns have changed.
a = Artist[1] a.save_changes # No callbacks run, as no changes a.modified! a.save_changes # Callbacks run, even though no changes made
If a column is given, specifically marked that column as modified, so that save_changes
/update
will include that column in the update. This should be used if you plan on mutating the column value instead of assigning a new column value:
a.modified!(:name) a.name.gsub!(/[aeou]/, 'i')
# File lib/sequel/model/base.rb 1413 def modified!(column=nil) 1414 _add_changed_column(column) if column 1415 @modified = true 1416 end
Whether this object has been modified since last saved, used by save_changes
to determine whether changes should be saved. New values are always considered modified.
a = Artist[1] a.modified? # => false a.set(name: 'Jim') a.modified? # => true
If a column is given, specifically check if the given column has been modified:
a.modified?(:num_albums) # => false a.num_albums = 10 a.modified?(:num_albums) # => true
# File lib/sequel/model/base.rb 1433 def modified?(column=nil) 1434 if column 1435 changed_columns.include?(column) 1436 else 1437 @modified || !changed_columns.empty? 1438 end 1439 end
Returns true if the current instance represents a new record.
Artist.new.new? # => true Artist[1].new? # => false
# File lib/sequel/model/base.rb 1445 def new? 1446 defined?(@new) ? @new : (@new = false) 1447 end
Returns the primary key value identifying the model instance. Raises an Error
if this model does not have a primary key. If the model has a composite primary key, returns an array of values.
Artist[1].pk # => 1 Artist[[1, 2]].pk # => [1, 2]
# File lib/sequel/model/base.rb 1455 def pk 1456 raise(Error, "No primary key is associated with this model") unless key = primary_key 1457 if key.is_a?(Array) 1458 vals = @values 1459 key.map{|k| vals[k]} 1460 else 1461 @values[key] 1462 end 1463 end
Returns a hash mapping the receivers primary key column(s) to their values.
Artist[1].pk_hash # => {:id=>1} Artist[[1, 2]].pk_hash # => {:id1=>1, :id2=>2}
# File lib/sequel/model/base.rb 1469 def pk_hash 1470 model.primary_key_hash(pk) 1471 end
Returns a hash mapping the receivers qualified primary key column(s) to their values.
Artist[1].qualified_pk_hash # => {Sequel[:artists][:id]=>1} Artist[[1, 2]].qualified_pk_hash # => {Sequel[:artists][:id1]=>1, Sequel[:artists][:id2]=>2}
# File lib/sequel/model/base.rb 1479 def qualified_pk_hash(qualifier=model.table_name) 1480 model.qualified_primary_key_hash(pk, qualifier) 1481 end
Reloads attributes from database and returns self. Also clears all changed_columns
information. Raises an Error
if the record no longer exists in the database.
a = Artist[1] a.name = 'Jim' a.refresh a.name # => 'Bob'
# File lib/sequel/model/base.rb 1491 def refresh 1492 raise Sequel::Error, "can't refresh frozen object" if frozen? 1493 _refresh(this) 1494 self 1495 end
Alias of refresh, but not aliased directly to make overriding in a plugin easier.
# File lib/sequel/model/base.rb 1498 def reload 1499 refresh 1500 end
Creates or updates the record, after making sure the record is valid and before hooks execute successfully. Fails if:
-
the record is not valid, or
-
before_save calls
cancel_action
, or -
the record is new and before_create calls
cancel_action
, or -
the record is not new and before_update calls cancel_action.
If save
fails and either raise_on_save_failure or the :raise_on_failure option is true, it raises ValidationFailed
or HookFailed
. Otherwise it returns nil.
If it succeeds, it returns self.
Takes the following options:
:changed |
save all changed columns, instead of all columns or the columns given |
:columns |
array of specific columns that should be saved. |
:raise_on_failure |
set to true or false to override the current |
:server |
set the server/shard on the object before saving, and use that server/shard in any transaction. |
:transaction |
set to true or false to override the current |
:validate |
set to false to skip validation |
# File lib/sequel/model/base.rb 1527 def save(opts=OPTS) 1528 raise Sequel::Error, "can't save frozen object" if frozen? 1529 set_server(opts[:server]) if opts[:server] 1530 unless _save_valid?(opts) 1531 raise(validation_failed_error) if raise_on_failure?(opts) 1532 return 1533 end 1534 checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 1535 end
Saves only changed columns if the object has been modified. If the object has not been modified, returns nil. If unable to save, returns false unless raise_on_save_failure
is true.
a = Artist[1] a.save_changes # => nil a.name = 'Jim' a.save_changes # UPDATE artists SET name = 'Bob' WHERE (id = 1) # => #<Artist {:id=>1, :name=>'Jim', ...}
# File lib/sequel/model/base.rb 1546 def save_changes(opts=OPTS) 1547 save(Hash[opts].merge!(:changed=>true)) || false if modified? 1548 end
Updates the instance with the supplied values with support for virtual attributes, raising an exception if a value is used that doesn’t have a setter method (or ignoring it if strict_param_setting = false
). Does not save the record.
artist.set(name: 'Jim') artist.name # => 'Jim'
# File lib/sequel/model/base.rb 1557 def set(hash) 1558 set_restricted(hash, :default) 1559 end
For each of the fields in the given array fields
, call the setter method with the value of that hash
entry for the field. Returns self.
You can provide an options hash, with the following options currently respected:
:missing |
Can be set to :skip to skip missing entries or :raise to raise an |
Examples:
artist.set_fields({name: 'Jim'}, [:name]) artist.name # => 'Jim' artist.set_fields({hometown: 'LA'}, [:name]) artist.name # => nil artist.hometown # => 'Sac' artist.name # => 'Jim' artist.set_fields({}, [:name], missing: :skip) artist.name # => 'Jim' artist.name # => 'Jim' artist.set_fields({}, [:name], missing: :raise) # Sequel::Error raised
# File lib/sequel/model/base.rb 1587 def set_fields(hash, fields, opts=nil) 1588 opts = if opts 1589 model.default_set_fields_options.merge(opts) 1590 else 1591 model.default_set_fields_options 1592 end 1593 1594 case missing = opts[:missing] 1595 when :skip, :raise 1596 do_raise = true if missing == :raise 1597 fields.each do |f| 1598 if hash.has_key?(f) 1599 set_column_value("#{f}=", hash[f]) 1600 elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1601 set_column_value("#{sf}=", hash[sf]) 1602 elsif do_raise 1603 raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1604 end 1605 end 1606 else 1607 fields.each{|f| set_column_value("#{f}=", hash[f])} 1608 end 1609 self 1610 end
Set the shard that this object is tied to. Returns self.
# File lib/sequel/model/base.rb 1613 def set_server(s) 1614 @server = s 1615 @this = @this.server(s) if @this 1616 self 1617 end
Clear the setter_methods cache when a method is added
# File lib/sequel/model/base.rb 1620 def singleton_method_added(meth) 1621 @singleton_setter_added = true if meth.to_s.end_with?('=') 1622 super 1623 end
Skip all validation of the object on the next call to save
, including the running of validation hooks. This is designed for and should only be used in cases where valid?
is called before saving and the validate: false
option cannot be passed to save
.
# File lib/sequel/model/base.rb 1630 def skip_validation_on_next_save! 1631 @skip_validation_on_next_save = true 1632 end
Returns naked dataset that should return only the row related to this instance.
Artist[1].this # SELECT * FROM artists WHERE (id = 1) LIMIT 1
# File lib/sequel/model/base.rb 1638 def this 1639 return @this if @this 1640 raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1641 @this = use_server(ds.where(pk_hash)) 1642 end
Runs set
with the passed hash and then runs save_changes.
artist.update(name: 'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)
# File lib/sequel/model/base.rb 1647 def update(hash) 1648 update_restricted(hash, :default) 1649 end
Update the instance’s values by calling set_fields
with the arguments, then calls save_changes.
artist.update_fields({name: 'Jim'}, [:name]) # UPDATE artists SET name = 'Jim' WHERE (id = 1) artist.update_fields({hometown: 'LA'}, [:name]) # UPDATE artists SET name = NULL WHERE (id = 1)
# File lib/sequel/model/base.rb 1659 def update_fields(hash, fields, opts=nil) 1660 set_fields(hash, fields, opts) 1661 save_changes 1662 end
Validates the object and returns true if no errors are reported.
artist.set(name: 'Valid').valid? # => true artist.set(name: 'Invalid').valid? # => false artist.errors.full_messages # => ['name cannot be Invalid']
# File lib/sequel/model/base.rb 1678 def valid?(opts = OPTS) 1679 _valid?(opts) 1680 rescue HookFailed 1681 false 1682 end
Validates the object. If the object is invalid, errors should be added to the errors attribute. By default, does nothing, as all models are valid by default. See the “Model Validations” guide. for details about validation. Should not be called directly by user code, call valid?
instead to check if an object is valid.
# File lib/sequel/model/base.rb 1670 def validate 1671 end