module Sequel::Model::InstanceMethods
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.
Constants
- EXISTS_SELECT_
Attributes
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', ...}
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', ...}
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 for_update
(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 is updating the record at the same time.
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 for database independent locking behavior, but all supported symbols have separate methods (e.g. for_update).
a = Artist[1] Artist.db.transaction do a.lock! a.update(name: 'A') end a = Artist[2] Artist.db.transaction do a.lock!('FOR NO KEY UPDATE') a.update(name: 'B') end
# File lib/sequel/model/base.rb 1384 def lock!(style=:update) 1385 _refresh(this.lock_style(style)) unless new? 1386 self 1387 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 1394 def marshallable! 1395 @this = nil 1396 self 1397 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 1414 def modified!(column=nil) 1415 _add_changed_column(column) if column 1416 @modified = true 1417 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 1434 def modified?(column=nil) 1435 if column 1436 changed_columns.include?(column) 1437 else 1438 @modified || !changed_columns.empty? 1439 end 1440 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 1446 def new? 1447 defined?(@new) ? @new : (@new = false) 1448 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 1456 def pk 1457 raise(Error, "No primary key is associated with this model") unless key = primary_key 1458 if key.is_a?(Array) 1459 vals = @values 1460 key.map{|k| vals[k]} 1461 else 1462 @values[key] 1463 end 1464 end
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
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 1470 def pk_hash 1471 model.primary_key_hash(pk) 1472 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 1480 def qualified_pk_hash(qualifier=model.table_name) 1481 model.qualified_primary_key_hash(pk, qualifier) 1482 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 1492 def refresh 1493 raise Sequel::Error, "can't refresh frozen object" if frozen? 1494 _refresh(this) 1495 self 1496 end
Alias of refresh, but not aliased directly to make overriding in a plugin easier.
# File lib/sequel/model/base.rb 1499 def reload 1500 refresh 1501 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
raise_on_save_failure
setting - :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
use_transactions
setting - :validate
-
set to false to skip validation
# File lib/sequel/model/base.rb 1528 def save(opts=OPTS) 1529 raise Sequel::Error, "can't save frozen object" if frozen? 1530 set_server(opts[:server]) if opts[:server] 1531 unless _save_valid?(opts) 1532 raise(validation_failed_error) if raise_on_failure?(opts) 1533 return 1534 end 1535 checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 1536 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 1547 def save_changes(opts=OPTS) 1548 save(Hash[opts].merge!(:changed=>true)) || false if modified? 1549 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 1558 def set(hash) 1559 set_restricted(hash, :default) 1560 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
Error
for missing entries. The default behavior is not to check for missing entries, in which case the default value is used. To be friendly with most web frameworks, the missing check will also check for the string version of the argument in the hash if given a symbol.
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 1588 def set_fields(hash, fields, opts=nil) 1589 opts = if opts 1590 model.default_set_fields_options.merge(opts) 1591 else 1592 model.default_set_fields_options 1593 end 1594 1595 case missing = opts[:missing] 1596 when :skip, :raise 1597 do_raise = true if missing == :raise 1598 fields.each do |f| 1599 if hash.has_key?(f) 1600 set_column_value("#{f}=", hash[f]) 1601 elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1602 set_column_value("#{sf}=", hash[sf]) 1603 elsif do_raise 1604 raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1605 end 1606 end 1607 else 1608 fields.each{|f| set_column_value("#{f}=", hash[f])} 1609 end 1610 self 1611 end
Set the shard that this object is tied to. Returns self.
# File lib/sequel/model/base.rb 1614 def set_server(s) 1615 @server = s 1616 @this = @this.server(s) if @this 1617 self 1618 end
Clear the setter_methods
cache when a method is added
# File lib/sequel/model/base.rb 1621 def singleton_method_added(meth) 1622 @singleton_setter_added = true if meth.to_s.end_with?('=') 1623 super 1624 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 1631 def skip_validation_on_next_save! 1632 @skip_validation_on_next_save = true 1633 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 1639 def this 1640 return @this if @this 1641 raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1642 @this = use_server(ds.where(pk_hash)) 1643 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 1648 def update(hash) 1649 update_restricted(hash, :default) 1650 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 1660 def update_fields(hash, fields, opts=nil) 1661 set_fields(hash, fields, opts) 1662 save_changes 1663 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 1679 def valid?(opts = OPTS) 1680 _valid?(opts) 1681 rescue HookFailed 1682 false 1683 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 1671 def validate 1672 end
Private Instance Methods
Add a column as a changed column.
# File lib/sequel/model/base.rb 1688 def _add_changed_column(column) 1689 cc = _changed_columns 1690 cc << column unless cc.include?(column) 1691 end
Internal changed_columns
method that just returns stored array.
# File lib/sequel/model/base.rb 1694 def _changed_columns 1695 @changed_columns ||= [] 1696 end
Clear the changed columns. Reason is the reason for clearing the columns, and should be one of: :initialize, :refresh, :create or :update.
# File lib/sequel/model/base.rb 1701 def _clear_changed_columns(_reason) 1702 _changed_columns.clear 1703 end
Do the deletion of the object’s dataset, and check that the row was actually deleted.
# File lib/sequel/model/base.rb 1707 def _delete 1708 n = _delete_without_checking 1709 raise(NoExistingObject, "Attempt to delete object did not result in a single row modification (Rows Deleted: #{n}, SQL: #{_delete_dataset.delete_sql})") if require_modification && n != 1 1710 n 1711 end
The dataset to use when deleting the object. The same as the object’s dataset by default.
# File lib/sequel/model/base.rb 1715 def _delete_dataset 1716 this 1717 end
Actually do the deletion of the object’s dataset. Return the number of rows modified.
# File lib/sequel/model/base.rb 1721 def _delete_without_checking 1722 if sql = (m = model).fast_instance_delete_sql 1723 sql = sql.dup 1724 ds = use_server(m.dataset) 1725 ds.literal_append(sql, pk) 1726 ds.with_sql_delete(sql) 1727 else 1728 _delete_dataset.delete 1729 end 1730 end
Internal destroy method, separted from destroy to allow running inside a transaction
# File lib/sequel/model/base.rb 1734 def _destroy(opts) 1735 called = false 1736 around_destroy do 1737 called = true 1738 before_destroy 1739 _destroy_delete 1740 after_destroy 1741 end 1742 raise_hook_failure(:around_destroy) unless called 1743 self 1744 end
Internal delete method to call when destroying an object, separated from delete to allow you to override destroy’s version without affecting delete.
# File lib/sequel/model/base.rb 1749 def _destroy_delete 1750 delete 1751 end
Insert the record into the database, returning the primary key if the record should be refreshed from the database.
# File lib/sequel/model/base.rb 1755 def _insert 1756 ds = _insert_dataset 1757 if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil? 1758 _save_set_values(h) if h 1759 nil 1760 else 1761 iid = _insert_raw(ds) 1762 # if we have a regular primary key and it's not set in @values, 1763 # we assume it's the last inserted id 1764 if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk] 1765 vals[pk] = iid 1766 end 1767 pk 1768 end 1769 end
The dataset to use when inserting a new object. The same as the model’s dataset by default.
# File lib/sequel/model/base.rb 1773 def _insert_dataset 1774 use_server(model.instance_dataset) 1775 end
Insert into the given dataset and return the primary key created (if any).
# File lib/sequel/model/base.rb 1778 def _insert_raw(ds) 1779 ds.insert(_insert_values) 1780 end
Insert into the given dataset and return the hash of column values.
# File lib/sequel/model/base.rb 1783 def _insert_select_raw(ds) 1784 ds.insert_select(_insert_values) 1785 end
Refresh using a particular dataset, used inside save to make sure the same server is used for reading newly inserted values from the database
# File lib/sequel/model/base.rb 1793 def _refresh(dataset) 1794 _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found")) 1795 _clear_changed_columns(:refresh) 1796 end
Get the row of column data from the database.
# File lib/sequel/model/base.rb 1799 def _refresh_get(dataset) 1800 if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock] 1801 sql = sql.dup 1802 ds = use_server(dataset) 1803 ds.literal_append(sql, pk) 1804 ds.with_sql_first(sql) 1805 else 1806 dataset.first 1807 end 1808 end
Set the values to the given hash after refreshing.
# File lib/sequel/model/base.rb 1811 def _refresh_set_values(h) 1812 @values = h 1813 end
Internal version of save, split from save to allow running inside it’s own transaction.
# File lib/sequel/model/base.rb 1817 def _save(opts) 1818 pk = nil 1819 called_save = false 1820 called_cu = false 1821 around_save do 1822 called_save = true 1823 before_save 1824 1825 if new? 1826 around_create do 1827 called_cu = true 1828 before_create 1829 pk = _insert 1830 @this = nil 1831 @new = false 1832 @modified = false 1833 pk ? _save_refresh : _clear_changed_columns(:create) 1834 after_create 1835 true 1836 end 1837 raise_hook_failure(:around_create) unless called_cu 1838 else 1839 around_update do 1840 called_cu = true 1841 before_update 1842 columns = opts[:columns] 1843 if columns.nil? 1844 columns_updated = if opts[:changed] 1845 _save_update_changed_colums_hash 1846 else 1847 _save_update_all_columns_hash 1848 end 1849 _clear_changed_columns(:update) 1850 else # update only the specified columns 1851 columns = Array(columns) 1852 columns_updated = @values.reject{|k, v| !columns.include?(k)} 1853 _changed_columns.reject!{|c| columns.include?(c)} 1854 end 1855 _update_columns(columns_updated) 1856 @this = nil 1857 @modified = false 1858 after_update 1859 true 1860 end 1861 raise_hook_failure(:around_update) unless called_cu 1862 end 1863 after_save 1864 true 1865 end 1866 raise_hook_failure(:around_save) unless called_save 1867 self 1868 end
Refresh the object after saving it, used to get default values of all columns. Separated from _save so it can be overridden to avoid the refresh.
# File lib/sequel/model/base.rb 1873 def _save_refresh 1874 _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found")) 1875 _clear_changed_columns(:create) 1876 end
Set values to the provided hash. Called after a create, to set the full values from the database in the model instance.
# File lib/sequel/model/base.rb 1880 def _save_set_values(h) 1881 @values = h 1882 end
Return a hash of values used when saving all columns of an existing object (i.e. not passing specific columns to save or using update/save_changes). Defaults to all of the object’s values except unmodified primary key columns, as some databases don’t like you setting primary key values even to their existing values.
# File lib/sequel/model/base.rb 1890 def _save_update_all_columns_hash 1891 v = Hash[@values] 1892 cc = changed_columns 1893 Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)} 1894 v 1895 end
Return a hash of values used when saving changed columns of an existing object. Defaults to all of the objects current values that are recorded as modified.
# File lib/sequel/model/base.rb 1900 def _save_update_changed_colums_hash 1901 cc = changed_columns 1902 @values.reject{|k,v| !cc.include?(k)} 1903 end
Validate the object if validating on save. Skips validation completely (including validation hooks) if skip_validation_on_save! has been called on the object, resetting the flag so that future saves will validate.
# File lib/sequel/model/base.rb 1909 def _save_valid?(opts) 1910 if @skip_validation_on_next_save 1911 @skip_validation_on_next_save = false 1912 return true 1913 end 1914 1915 checked_save_failure(opts){_valid?(opts)} 1916 end
Update this instance’s dataset with the supplied column hash, checking that only a single row was modified.
# File lib/sequel/model/base.rb 1927 def _update(columns) 1928 n = _update_without_checking(columns) 1929 raise(NoExistingObject, "Attempt to update object did not result in a single row modification (SQL: #{_update_dataset.update_sql(columns)})") if require_modification && n != 1 1930 n 1931 end
Call _update with the given columns, if any are present. Plugins
can override this method in order to update with additional columns, even when the column hash is initially empty.
# File lib/sequel/model/base.rb 1921 def _update_columns(columns) 1922 _update(columns) unless columns.empty? 1923 end
The dataset to use when updating an object. The same as the object’s dataset by default.
# File lib/sequel/model/base.rb 1935 def _update_dataset 1936 this 1937 end
Update this instances dataset with the supplied column hash.
# File lib/sequel/model/base.rb 1940 def _update_without_checking(columns) 1941 _update_dataset.update(columns) 1942 end
Whether to use insert_select when inserting a new row.
# File lib/sequel/model/base.rb 1945 def _use_insert_select?(ds) 1946 (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 1947 end
Internal validation method, running validation hooks.
# File lib/sequel/model/base.rb 1950 def _valid?(opts) 1951 return errors.empty? if frozen? 1952 errors.clear 1953 called = false 1954 skip_validate = opts[:validate] == false 1955 around_validation do 1956 called = true 1957 before_validation 1958 validate unless skip_validate 1959 after_validation 1960 end 1961 1962 return true if skip_validate 1963 1964 if called 1965 errors.empty? 1966 else 1967 raise_hook_failure(:around_validation) 1968 end 1969 end
Change the value of the column to given value, recording the change.
# File lib/sequel/model/base.rb 1993 def change_column_value(column, value) 1994 _add_changed_column(column) 1995 @values[column] = value 1996 end
If not raising on failure, check for HookFailed
being raised by yielding and swallow it.
# File lib/sequel/model/base.rb 1973 def checked_save_failure(opts) 1974 if raise_on_failure?(opts) 1975 yield 1976 else 1977 begin 1978 yield 1979 rescue HookFailed 1980 nil 1981 end 1982 end 1983 end
If transactions should be used, wrap the yield in a transaction block.
# File lib/sequel/model/base.rb 1986 def checked_transaction(opts=OPTS, &block) 1987 h = {:server=>this_server}.merge!(opts) 1988 h[:skip_transaction] = true unless use_transaction?(opts) 1989 db.transaction(h, &block) 1990 end
Default error class used for errors.
# File lib/sequel/model/base.rb 1999 def errors_class 2000 Errors 2001 end
A HookFailed
exception for the given message tied to the current instance.
# File lib/sequel/model/base.rb 2004 def hook_failed_error(msg) 2005 HookFailed.new(msg, self) 2006 end
Clone constructor – freeze internal data structures if the original’s are frozen.
# File lib/sequel/model/base.rb 2010 def initialize_clone(other) 2011 super 2012 freeze if other.frozen? 2013 self 2014 end
Copy constructor – Duplicate internal data structures.
# File lib/sequel/model/base.rb 2017 def initialize_copy(other) 2018 super 2019 @values = Hash[@values] 2020 @changed_columns = @changed_columns.dup if @changed_columns 2021 @errors = @errors.dup if @errors 2022 self 2023 end
Set the columns with the given hash. By default, the same as set
, but exists so it can be overridden. This is called only for new records, before changed_columns
is cleared.
# File lib/sequel/model/base.rb 2028 def initialize_set(h) 2029 set(h) unless h.empty? 2030 end
Default inspect output for the inspect, by default, just showing the class.
# File lib/sequel/model/base.rb 2033 def inspect_prefix 2034 model.name 2035 end
Default inspect output for the values hash, overwrite to change what inspect
displays.
# File lib/sequel/model/base.rb 2038 def inspect_values 2039 @values.inspect 2040 end
Raise an error appropriate to the hook type. May be swallowed by checked_save_failure
depending on the raise_on_failure? setting.
# File lib/sequel/model/base.rb 2052 def raise_hook_failure(type=nil) 2053 msg = case type 2054 when String 2055 type 2056 when Symbol 2057 "the #{type} hook failed" 2058 else 2059 "a hook failed" 2060 end 2061 2062 raise hook_failed_error(msg) 2063 end
Whether to raise or return false if this action fails. If the :raise_on_failure option is present in the hash, use that, otherwise, fallback to the object’s raise_on_save_failure (if set), or class’s default (if not).
# File lib/sequel/model/base.rb 2046 def raise_on_failure?(opts) 2047 opts.fetch(:raise_on_failure, raise_on_save_failure) 2048 end
Get the ruby class or classes related to the given column’s type.
# File lib/sequel/model/base.rb 2066 def schema_type_class(column) 2067 if (sch = db_schema[column]) && (type = sch[:type]) 2068 db.schema_type_class(type) 2069 end 2070 end
Call setter methods based on keys in hash, with the appropriate values. Restrict which methods can be called based on the provided type.
# File lib/sequel/model/base.rb 2074 def set_restricted(hash, type) 2075 return self if hash.empty? 2076 meths = setter_methods(type) 2077 strict = strict_param_setting 2078 hash.each do |k,v| 2079 k = k.to_s 2080 m = "#{k}=" 2081 if meths.include?(m) 2082 set_column_value(m, v) 2083 elsif strict 2084 # Avoid using respond_to? or creating symbols from user input 2085 if public_methods.map(&:to_s).include?(m) 2086 if Array(model.primary_key).map(&:to_s).member?(k) && model.restrict_primary_key? 2087 raise MassAssignmentRestriction.create("#{k} is a restricted primary key", self, k) 2088 else 2089 raise MassAssignmentRestriction.create("#{k} is a restricted column", self, k) 2090 end 2091 else 2092 raise MassAssignmentRestriction.create("method #{m} doesn't exist", self, k) 2093 end 2094 end 2095 end 2096 self 2097 end
Returns all methods that can be used for attribute assignment (those that end with =), depending on the type:
- :default
-
Use the default methods allowed in the model class.
- :all
-
Allow setting all setters, except those specifically restricted (such as ==).
Array
-
Only allow setting of columns in the given array.
# File lib/sequel/model/base.rb 2105 def setter_methods(type) 2106 if type == :default && !@singleton_setter_added 2107 return model.setter_methods 2108 end 2109 2110 meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS 2111 meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key? 2112 meths 2113 end
The server/shard that the model object’s dataset uses, or :default if the model object’s dataset does not have an associated shard.
# File lib/sequel/model/base.rb 2117 def this_server 2118 if (s = @server) 2119 s 2120 elsif (t = @this) 2121 t.opts[:server] || :default 2122 else 2123 model.dataset.opts[:server] || :default 2124 end 2125 end
Typecast the value to the column’s type if typecasting. Calls the database’s typecast_value
method, so database adapters can override/augment the handling for database specific column types.
# File lib/sequel/model/base.rb 2130 def typecast_value(column, value) 2131 return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column]) 2132 value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type]) 2133 raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false) 2134 begin 2135 model.db.typecast_value(col_schema[:type], value) 2136 rescue InvalidValue 2137 raise_on_typecast_failure ? raise : value 2138 end 2139 end
Set the columns, filtered by the only and except arrays.
# File lib/sequel/model/base.rb 2142 def update_restricted(hash, type) 2143 set_restricted(hash, type) 2144 save_changes 2145 end
Set the given dataset to use the current object’s shard.
# File lib/sequel/model/base.rb 2148 def use_server(ds) 2149 @server ? ds.server(@server) : ds 2150 end
Whether to use a transaction for this action. If the :transaction option is present in the hash, use that, otherwise, fallback to the object’s default (if set), or class’s default (if not).
# File lib/sequel/model/base.rb 2155 def use_transaction?(opts = OPTS) 2156 opts.fetch(:transaction, use_transactions) 2157 end
An ValidationFailed
exception instance to raise for this instance.
# File lib/sequel/model/base.rb 2160 def validation_failed_error 2161 ValidationFailed.new(self) 2162 end