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
Source
# File lib/sequel/model/base.rb 1116 def initialize(values = OPTS) 1117 @values = {} 1118 @new = true 1119 @modified = true 1120 initialize_set(values) 1121 _clear_changed_columns(:initialize) 1122 yield self if defined?(yield) 1123 end
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
Public Instance Methods
Source
# File lib/sequel/model/base.rb 1153 def ==(obj) 1154 eql?(obj) 1155 end
Alias of eql?
Source
# File lib/sequel/model/base.rb 1163 def ===(obj) 1164 case pkv = pk 1165 when nil 1166 return false 1167 when Array 1168 return false if pkv.any?(&:nil?) 1169 end 1170 1171 (obj.class == model) && (obj.pk == pkv) 1172 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
Source
# File lib/sequel/model/base.rb 1128 def [](column) 1129 @values[column] 1130 end
Returns value of the column’s attribute.
Artist[1][:id] #=> 1
Source
# File lib/sequel/model/base.rb 1140 def []=(column, value) 1141 # If it is new, it doesn't have a value yet, so we should 1142 # definitely set the new value. 1143 # If the column isn't in @values, we can't assume it is 1144 # NULL in the database, so assume it has changed. 1145 v = typecast_value(column, value) 1146 vals = @values 1147 if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class 1148 change_column_value(column, v) 1149 end 1150 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'}
Source
# File lib/sequel/model/base.rb 1195 def autoincrementing_primary_key 1196 primary_key 1197 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.
Source
# File lib/sequel/model/base.rb 1203 def cancel_action(msg=nil) 1204 raise_hook_failure(msg) 1205 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.
Source
# File lib/sequel/model/base.rb 1214 def changed_columns 1215 _changed_columns 1216 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]
Source
# File lib/sequel/model/base.rb 1223 def delete 1224 raise Sequel::Error, "can't delete frozen object" if frozen? 1225 _delete 1226 self 1227 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, ...}>
Source
# File lib/sequel/model/base.rb 1235 def destroy(opts = OPTS) 1236 raise Sequel::Error, "can't destroy frozen object" if frozen? 1237 checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 1238 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, ...}>
Source
# File lib/sequel/model/base.rb 1245 def each(&block) 1246 @values.each(&block) 1247 end
Iterates through all of the current values using each.
Album[1].each{|k, v| puts "#{k} => #{v}"} # id => 1 # name => 'Bob'
Source
# File lib/sequel/model/base.rb 1254 def eql?(obj) 1255 (obj.class == model) && (obj.values == @values) 1256 end
Compares model instances by values.
Artist[1] == Artist[1] # => true Artist.new == Artist.new # => true Artist[1].set(name: 'Bob') == Artist[1] # => false
Source
# File lib/sequel/model/base.rb 1260 def errors 1261 @errors ||= errors_class.new 1262 end
Returns the validation errors associated with this object. See Errors
.
Source
# File lib/sequel/model/base.rb 1277 def exists? 1278 new? ? false : !this.get(EXISTS_SELECT_).nil? 1279 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
Source
# File lib/sequel/model/base.rb 1283 def extend(mod) 1284 @singleton_setter_added = true 1285 super 1286 end
Ignore the model’s setter method cache when this instances extends a module, as the module may contain setter methods.
Source
# File lib/sequel/model/base.rb 1291 def freeze 1292 unless errors.frozen? 1293 validate 1294 errors.freeze 1295 end 1296 values.freeze 1297 _changed_columns.freeze 1298 this if !new? && model.primary_key 1299 super 1300 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.
Source
# File lib/sequel/model/base.rb 1309 def hash 1310 case primary_key 1311 when Array 1312 [model, !pk.all? ? @values : pk].hash 1313 when Symbol 1314 [model, pk.nil? ? @values : pk].hash 1315 else 1316 [model, @values].hash 1317 end 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
Source
# File lib/sequel/model/base.rb 1324 def id 1325 @values[:id] 1326 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
Source
# File lib/sequel/model/base.rb 1330 def inspect 1331 "#<#{inspect_prefix} @values=#{inspect_values}>" 1332 end
Returns a string representation of the model instance including the class name and values.
Source
# File lib/sequel/model/base.rb 1339 def keys 1340 @values.keys 1341 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]
Source
# File lib/sequel/model/base.rb 1366 def lock!(style=:update) 1367 _refresh(this.lock_style(style)) unless new? 1368 self 1369 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
Source
# File lib/sequel/model/base.rb 1376 def marshallable! 1377 @this = nil 1378 self 1379 end
Remove elements of the model object that make marshalling fail. Returns self.
a = Artist[1] a.marshallable! Marshal.dump(a)
Source
# File lib/sequel/model/base.rb 1396 def modified!(column=nil) 1397 _add_changed_column(column) if column 1398 @modified = true 1399 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')
Source
# File lib/sequel/model/base.rb 1416 def modified?(column=nil) 1417 if column 1418 changed_columns.include?(column) 1419 else 1420 @modified || !changed_columns.empty? 1421 end 1422 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
Source
# File lib/sequel/model/base.rb 1428 def new? 1429 defined?(@new) ? @new : (@new = false) 1430 end
Returns true if the current instance represents a new record.
Artist.new.new? # => true Artist[1].new? # => false
Source
# File lib/sequel/model/base.rb 1438 def pk 1439 raise(Error, "No primary key is associated with this model") unless key = primary_key 1440 if key.is_a?(Array) 1441 vals = @values 1442 key.map{|k| vals[k]} 1443 else 1444 @values[key] 1445 end 1446 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]
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
Source
# File lib/sequel/model/base.rb 1452 def pk_hash 1453 model.primary_key_hash(pk) 1454 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}
Source
# File lib/sequel/model/base.rb 1462 def qualified_pk_hash(qualifier=model.table_name) 1463 model.qualified_primary_key_hash(pk, qualifier) 1464 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}
Source
# File lib/sequel/model/base.rb 1474 def refresh 1475 raise Sequel::Error, "can't refresh frozen object" if frozen? 1476 _refresh(this) 1477 self 1478 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'
Source
# File lib/sequel/model/base.rb 1481 def reload 1482 refresh 1483 end
Alias of refresh, but not aliased directly to make overriding in a plugin easier.
Source
# File lib/sequel/model/base.rb 1510 def save(opts=OPTS) 1511 raise Sequel::Error, "can't save frozen object" if frozen? 1512 set_server(opts[:server]) if opts[:server] 1513 unless _save_valid?(opts) 1514 raise(validation_failed_error) if raise_on_failure?(opts) 1515 return 1516 end 1517 checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 1518 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
Source
# File lib/sequel/model/base.rb 1529 def save_changes(opts=OPTS) 1530 save(Hash[opts].merge!(:changed=>true)) || false if modified? 1531 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', ...}
Source
# File lib/sequel/model/base.rb 1540 def set(hash) 1541 set_restricted(hash, :default) 1542 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'
Source
# File lib/sequel/model/base.rb 1570 def set_fields(hash, fields, opts=nil) 1571 opts = if opts 1572 model.default_set_fields_options.merge(opts) 1573 else 1574 model.default_set_fields_options 1575 end 1576 1577 case missing = opts[:missing] 1578 when :skip, :raise 1579 do_raise = true if missing == :raise 1580 fields.each do |f| 1581 if hash.has_key?(f) 1582 set_column_value("#{f}=", hash[f]) 1583 elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1584 set_column_value("#{sf}=", hash[sf]) 1585 elsif do_raise 1586 raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1587 end 1588 end 1589 else 1590 fields.each{|f| set_column_value("#{f}=", hash[f])} 1591 end 1592 self 1593 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
Source
# File lib/sequel/model/base.rb 1596 def set_server(s) 1597 @server = s 1598 @this = @this.server(s) if @this 1599 self 1600 end
Set the shard that this object is tied to. Returns self.
Source
# File lib/sequel/model/base.rb 1603 def singleton_method_added(meth) 1604 @singleton_setter_added = true if meth.to_s.end_with?('=') 1605 super 1606 end
Clear the setter_methods
cache when a method is added
Source
# File lib/sequel/model/base.rb 1613 def skip_validation_on_next_save! 1614 @skip_validation_on_next_save = true 1615 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
.
Source
# File lib/sequel/model/base.rb 1621 def this 1622 return @this if @this 1623 raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1624 @this = use_server(ds.where(pk_hash)) 1625 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
Source
# File lib/sequel/model/base.rb 1630 def update(hash) 1631 update_restricted(hash, :default) 1632 end
Runs set
with the passed hash and then runs save_changes.
artist.update(name: 'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)
Source
# File lib/sequel/model/base.rb 1642 def update_fields(hash, fields, opts=nil) 1643 set_fields(hash, fields, opts) 1644 save_changes 1645 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)
Source
# File lib/sequel/model/base.rb 1661 def valid?(opts = OPTS) 1662 _valid?(opts) 1663 rescue HookFailed 1664 false 1665 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']
Source
# File lib/sequel/model/base.rb 1653 def validate 1654 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.
Private Instance Methods
Source
# File lib/sequel/model/base.rb 1670 def _add_changed_column(column) 1671 cc = _changed_columns 1672 cc << column unless cc.include?(column) 1673 end
Add a column as a changed column.
Source
# File lib/sequel/model/base.rb 1676 def _changed_columns 1677 @changed_columns ||= [] 1678 end
Internal changed_columns
method that just returns stored array.
Source
# File lib/sequel/model/base.rb 1683 def _clear_changed_columns(_reason) 1684 _changed_columns.clear 1685 end
Clear the changed columns. Reason is the reason for clearing the columns, and should be one of: :initialize, :refresh, :create or :update.
Source
# File lib/sequel/model/base.rb 1689 def _delete 1690 n = _delete_without_checking 1691 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 1692 n 1693 end
Do the deletion of the object’s dataset, and check that the row was actually deleted.
Source
# File lib/sequel/model/base.rb 1697 def _delete_dataset 1698 this 1699 end
The dataset to use when deleting the object. The same as the object’s dataset by default.
Source
# File lib/sequel/model/base.rb 1703 def _delete_without_checking 1704 if sql = (m = model).fast_instance_delete_sql 1705 sql = sql.dup 1706 ds = use_server(m.dataset) 1707 ds.literal_append(sql, pk) 1708 ds.with_sql_delete(sql) 1709 else 1710 _delete_dataset.delete 1711 end 1712 end
Actually do the deletion of the object’s dataset. Return the number of rows modified.
Source
# File lib/sequel/model/base.rb 1716 def _destroy(opts) 1717 called = false 1718 around_destroy do 1719 called = true 1720 before_destroy 1721 _destroy_delete 1722 after_destroy 1723 end 1724 raise_hook_failure(:around_destroy) unless called 1725 self 1726 end
Internal destroy method, separted from destroy to allow running inside a transaction
Source
# File lib/sequel/model/base.rb 1731 def _destroy_delete 1732 delete 1733 end
Internal delete method to call when destroying an object, separated from delete to allow you to override destroy’s version without affecting delete.
Source
# File lib/sequel/model/base.rb 1737 def _insert 1738 ds = _insert_dataset 1739 if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil? 1740 _save_set_values(h) if h 1741 nil 1742 else 1743 iid = _insert_raw(ds) 1744 # if we have a regular primary key and it's not set in @values, 1745 # we assume it's the last inserted id 1746 if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk] 1747 vals[pk] = iid 1748 end 1749 pk 1750 end 1751 end
Insert the record into the database, returning the primary key if the record should be refreshed from the database.
Source
# File lib/sequel/model/base.rb 1755 def _insert_dataset 1756 use_server(model.instance_dataset) 1757 end
The dataset to use when inserting a new object. The same as the model’s dataset by default.
Source
# File lib/sequel/model/base.rb 1760 def _insert_raw(ds) 1761 ds.insert(_insert_values) 1762 end
Insert into the given dataset and return the primary key created (if any).
Source
# File lib/sequel/model/base.rb 1765 def _insert_select_raw(ds) 1766 ds.insert_select(_insert_values) 1767 end
Insert into the given dataset and return the hash of column values.
Source
# File lib/sequel/model/base.rb 1775 def _refresh(dataset) 1776 _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found")) 1777 _clear_changed_columns(:refresh) 1778 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
Source
# File lib/sequel/model/base.rb 1781 def _refresh_get(dataset) 1782 if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock] 1783 sql = sql.dup 1784 ds = use_server(dataset) 1785 ds.literal_append(sql, pk) 1786 ds.with_sql_first(sql) 1787 else 1788 dataset.first 1789 end 1790 end
Get the row of column data from the database.
Source
# File lib/sequel/model/base.rb 1793 def _refresh_set_values(h) 1794 @values = h 1795 end
Set the values to the given hash after refreshing.
Source
# File lib/sequel/model/base.rb 1799 def _save(opts) 1800 pk = nil 1801 called_save = false 1802 called_cu = false 1803 around_save do 1804 called_save = true 1805 before_save 1806 1807 if new? 1808 around_create do 1809 called_cu = true 1810 before_create 1811 pk = _insert 1812 @this = nil 1813 @new = false 1814 @modified = false 1815 pk ? _save_refresh : _clear_changed_columns(:create) 1816 after_create 1817 true 1818 end 1819 raise_hook_failure(:around_create) unless called_cu 1820 else 1821 around_update do 1822 called_cu = true 1823 before_update 1824 columns = opts[:columns] 1825 if columns.nil? 1826 columns_updated = if opts[:changed] 1827 _save_update_changed_colums_hash 1828 else 1829 _save_update_all_columns_hash 1830 end 1831 _clear_changed_columns(:update) 1832 else # update only the specified columns 1833 columns = Array(columns) 1834 columns_updated = @values.reject{|k, v| !columns.include?(k)} 1835 _changed_columns.reject!{|c| columns.include?(c)} 1836 end 1837 _update_columns(columns_updated) 1838 @this = nil 1839 @modified = false 1840 after_update 1841 true 1842 end 1843 raise_hook_failure(:around_update) unless called_cu 1844 end 1845 after_save 1846 true 1847 end 1848 raise_hook_failure(:around_save) unless called_save 1849 self 1850 end
Internal version of save, split from save to allow running inside it’s own transaction.
Source
# File lib/sequel/model/base.rb 1855 def _save_refresh 1856 _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found")) 1857 _clear_changed_columns(:create) 1858 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.
Source
# File lib/sequel/model/base.rb 1862 def _save_set_values(h) 1863 @values = h 1864 end
Set values to the provided hash. Called after a create, to set the full values from the database in the model instance.
Source
# File lib/sequel/model/base.rb 1872 def _save_update_all_columns_hash 1873 v = Hash[@values] 1874 cc = changed_columns 1875 Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)} 1876 v 1877 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.
Source
# File lib/sequel/model/base.rb 1882 def _save_update_changed_colums_hash 1883 cc = changed_columns 1884 @values.reject{|k,v| !cc.include?(k)} 1885 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.
Source
# File lib/sequel/model/base.rb 1891 def _save_valid?(opts) 1892 if @skip_validation_on_next_save 1893 @skip_validation_on_next_save = false 1894 return true 1895 end 1896 1897 checked_save_failure(opts){_valid?(opts)} 1898 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.
Source
# File lib/sequel/model/base.rb 1909 def _update(columns) 1910 n = _update_without_checking(columns) 1911 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 1912 n 1913 end
Update this instance’s dataset with the supplied column hash, checking that only a single row was modified.
Source
# File lib/sequel/model/base.rb 1903 def _update_columns(columns) 1904 _update(columns) unless columns.empty? 1905 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.
Source
# File lib/sequel/model/base.rb 1917 def _update_dataset 1918 this 1919 end
The dataset to use when updating an object. The same as the object’s dataset by default.
Source
# File lib/sequel/model/base.rb 1922 def _update_without_checking(columns) 1923 _update_dataset.update(columns) 1924 end
Update this instances dataset with the supplied column hash.
Source
# File lib/sequel/model/base.rb 1927 def _use_insert_select?(ds) 1928 (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 1929 end
Whether to use insert_select when inserting a new row.
Source
# File lib/sequel/model/base.rb 1932 def _valid?(opts) 1933 return errors.empty? if frozen? 1934 errors.clear 1935 called = false 1936 skip_validate = opts[:validate] == false 1937 around_validation do 1938 called = true 1939 before_validation 1940 validate unless skip_validate 1941 after_validation 1942 end 1943 1944 return true if skip_validate 1945 1946 if called 1947 errors.empty? 1948 else 1949 raise_hook_failure(:around_validation) 1950 end 1951 end
Internal validation method, running validation hooks.
Source
# File lib/sequel/model/base.rb 1975 def change_column_value(column, value) 1976 _add_changed_column(column) 1977 @values[column] = value 1978 end
Change the value of the column to given value, recording the change.
Source
# File lib/sequel/model/base.rb 1955 def checked_save_failure(opts) 1956 if raise_on_failure?(opts) 1957 yield 1958 else 1959 begin 1960 yield 1961 rescue HookFailed 1962 nil 1963 end 1964 end 1965 end
If not raising on failure, check for HookFailed
being raised by yielding and swallow it.
Source
# File lib/sequel/model/base.rb 1968 def checked_transaction(opts=OPTS, &block) 1969 h = {:server=>this_server}.merge!(opts) 1970 h[:skip_transaction] = true unless use_transaction?(opts) 1971 db.transaction(h, &block) 1972 end
If transactions should be used, wrap the yield in a transaction block.
Source
# File lib/sequel/model/base.rb 1981 def errors_class 1982 Errors 1983 end
Default error class used for errors.
Source
# File lib/sequel/model/base.rb 1986 def hook_failed_error(msg) 1987 HookFailed.new(msg, self) 1988 end
A HookFailed
exception for the given message tied to the current instance.
Source
# File lib/sequel/model/base.rb 1992 def initialize_clone(other) 1993 super 1994 freeze if other.frozen? 1995 self 1996 end
Clone constructor – freeze internal data structures if the original’s are frozen.
Source
# File lib/sequel/model/base.rb 1999 def initialize_copy(other) 2000 super 2001 @values = Hash[@values] 2002 @changed_columns = @changed_columns.dup if @changed_columns 2003 @errors = @errors.dup if @errors 2004 self 2005 end
Copy constructor – Duplicate internal data structures.
Source
# File lib/sequel/model/base.rb 2010 def initialize_set(h) 2011 set(h) unless h.empty? 2012 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.
Source
# File lib/sequel/model/base.rb 2015 def inspect_prefix 2016 model.name 2017 end
Default inspect output for the inspect, by default, just showing the class.
Source
# File lib/sequel/model/base.rb 2020 def inspect_values 2021 @values.inspect 2022 end
Default inspect output for the values hash, overwrite to change what inspect
displays.
Source
# File lib/sequel/model/base.rb 2034 def raise_hook_failure(type=nil) 2035 msg = case type 2036 when String 2037 type 2038 when Symbol 2039 "the #{type} hook failed" 2040 else 2041 "a hook failed" 2042 end 2043 2044 raise hook_failed_error(msg) 2045 end
Raise an error appropriate to the hook type. May be swallowed by checked_save_failure
depending on the raise_on_failure? setting.
Source
# File lib/sequel/model/base.rb 2028 def raise_on_failure?(opts) 2029 opts.fetch(:raise_on_failure, raise_on_save_failure) 2030 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).
Source
# File lib/sequel/model/base.rb 2048 def schema_type_class(column) 2049 if (sch = db_schema[column]) && (type = sch[:type]) 2050 db.schema_type_class(type) 2051 end 2052 end
Get the ruby class or classes related to the given column’s type.
Source
# File lib/sequel/model/base.rb 2056 def set_restricted(hash, type) 2057 return self if hash.empty? 2058 meths = setter_methods(type) 2059 strict = strict_param_setting 2060 hash.each do |k,v| 2061 k = k.to_s 2062 m = "#{k}=" 2063 if meths.include?(m) 2064 set_column_value(m, v) 2065 elsif strict 2066 # Avoid using respond_to? or creating symbols from user input 2067 if public_methods.map(&:to_s).include?(m) 2068 if Array(model.primary_key).map(&:to_s).member?(k) && model.restrict_primary_key? 2069 raise MassAssignmentRestriction.create("#{k} is a restricted primary key", self, k) 2070 else 2071 raise MassAssignmentRestriction.create("#{k} is a restricted column", self, k) 2072 end 2073 else 2074 raise MassAssignmentRestriction.create("method #{m} doesn't exist", self, k) 2075 end 2076 end 2077 end 2078 self 2079 end
Call setter methods based on keys in hash, with the appropriate values. Restrict which methods can be called based on the provided type.
Source
# File lib/sequel/model/base.rb 2087 def setter_methods(type) 2088 if type == :default && !@singleton_setter_added 2089 return model.setter_methods 2090 end 2091 2092 meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS 2093 meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key? 2094 meths 2095 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.
Source
# File lib/sequel/model/base.rb 2099 def this_server 2100 if (s = @server) 2101 s 2102 elsif (t = @this) 2103 t.opts[:server] || :default 2104 else 2105 model.dataset.opts[:server] || :default 2106 end 2107 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.
Source
# File lib/sequel/model/base.rb 2112 def typecast_value(column, value) 2113 return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column]) 2114 value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type]) 2115 raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false) 2116 begin 2117 model.db.typecast_value(col_schema[:type], value) 2118 rescue InvalidValue 2119 raise_on_typecast_failure ? raise : value 2120 end 2121 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.
Source
# File lib/sequel/model/base.rb 2124 def update_restricted(hash, type) 2125 set_restricted(hash, type) 2126 save_changes 2127 end
Set the columns, filtered by the only and except arrays.
Source
# File lib/sequel/model/base.rb 2130 def use_server(ds) 2131 @server ? ds.server(@server) : ds 2132 end
Set the given dataset to use the current object’s shard.
Source
# File lib/sequel/model/base.rb 2137 def use_transaction?(opts = OPTS) 2138 opts.fetch(:transaction, use_transactions) 2139 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).
Source
# File lib/sequel/model/base.rb 2142 def validation_failed_error 2143 ValidationFailed.new(self) 2144 end
An ValidationFailed
exception instance to raise for this instance.