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 1099 def initialize(values = OPTS) 1100 @values = {} 1101 @new = true 1102 @modified = true 1103 initialize_set(values) 1104 _clear_changed_columns(:initialize) 1105 yield self if defined?(yield) 1106 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 1136 def ==(obj) 1137 eql?(obj) 1138 end
Alias of eql?
Source
# File lib/sequel/model/base.rb 1146 def ===(obj) 1147 case pkv = pk 1148 when nil 1149 return false 1150 when Array 1151 return false if pkv.any?(&:nil?) 1152 end 1153 1154 (obj.class == model) && (obj.pk == pkv) 1155 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 1111 def [](column) 1112 @values[column] 1113 end
Returns value of the column’s attribute.
Artist[1][:id] #=> 1
Source
# File lib/sequel/model/base.rb 1123 def []=(column, value) 1124 # If it is new, it doesn't have a value yet, so we should 1125 # definitely set the new value. 1126 # If the column isn't in @values, we can't assume it is 1127 # NULL in the database, so assume it has changed. 1128 v = typecast_value(column, value) 1129 vals = @values 1130 if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class 1131 change_column_value(column, v) 1132 end 1133 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 1178 def autoincrementing_primary_key 1179 primary_key 1180 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 1186 def cancel_action(msg=nil) 1187 raise_hook_failure(msg) 1188 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 1197 def changed_columns 1198 _changed_columns 1199 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 1206 def delete 1207 raise Sequel::Error, "can't delete frozen object" if frozen? 1208 _delete 1209 self 1210 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 1218 def destroy(opts = OPTS) 1219 raise Sequel::Error, "can't destroy frozen object" if frozen? 1220 checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 1221 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 1228 def each(&block) 1229 @values.each(&block) 1230 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 1237 def eql?(obj) 1238 (obj.class == model) && (obj.values == @values) 1239 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 1243 def errors 1244 @errors ||= errors_class.new 1245 end
Returns the validation errors associated with this object. See Errors
.
Source
# File lib/sequel/model/base.rb 1260 def exists? 1261 new? ? false : !this.get(EXISTS_SELECT_).nil? 1262 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 1266 def extend(mod) 1267 @singleton_setter_added = true 1268 super 1269 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 1274 def freeze 1275 unless errors.frozen? 1276 validate 1277 errors.freeze 1278 end 1279 values.freeze 1280 _changed_columns.freeze 1281 this if !new? && model.primary_key 1282 super 1283 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 1292 def hash 1293 case primary_key 1294 when Array 1295 [model, !pk.all? ? @values : pk].hash 1296 when Symbol 1297 [model, pk.nil? ? @values : pk].hash 1298 else 1299 [model, @values].hash 1300 end 1301 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 1307 def id 1308 @values[:id] 1309 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 1313 def inspect 1314 "#<#{model.name} @values=#{inspect_values}>" 1315 end
Returns a string representation of the model instance including the class name and values.
Source
# File lib/sequel/model/base.rb 1322 def keys 1323 @values.keys 1324 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 1349 def lock!(style=:update) 1350 _refresh(this.lock_style(style)) unless new? 1351 self 1352 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 1359 def marshallable! 1360 @this = nil 1361 self 1362 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 1379 def modified!(column=nil) 1380 _add_changed_column(column) if column 1381 @modified = true 1382 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 1399 def modified?(column=nil) 1400 if column 1401 changed_columns.include?(column) 1402 else 1403 @modified || !changed_columns.empty? 1404 end 1405 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 1411 def new? 1412 defined?(@new) ? @new : (@new = false) 1413 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 1421 def pk 1422 raise(Error, "No primary key is associated with this model") unless key = primary_key 1423 if key.is_a?(Array) 1424 vals = @values 1425 key.map{|k| vals[k]} 1426 else 1427 @values[key] 1428 end 1429 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 1435 def pk_hash 1436 model.primary_key_hash(pk) 1437 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 1445 def qualified_pk_hash(qualifier=model.table_name) 1446 model.qualified_primary_key_hash(pk, qualifier) 1447 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 1457 def refresh 1458 raise Sequel::Error, "can't refresh frozen object" if frozen? 1459 _refresh(this) 1460 self 1461 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 1464 def reload 1465 refresh 1466 end
Alias of refresh, but not aliased directly to make overriding in a plugin easier.
Source
# File lib/sequel/model/base.rb 1493 def save(opts=OPTS) 1494 raise Sequel::Error, "can't save frozen object" if frozen? 1495 set_server(opts[:server]) if opts[:server] 1496 unless _save_valid?(opts) 1497 raise(validation_failed_error) if raise_on_failure?(opts) 1498 return 1499 end 1500 checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 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
Source
# File lib/sequel/model/base.rb 1512 def save_changes(opts=OPTS) 1513 save(Hash[opts].merge!(:changed=>true)) || false if modified? 1514 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 1523 def set(hash) 1524 set_restricted(hash, :default) 1525 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 1553 def set_fields(hash, fields, opts=nil) 1554 opts = if opts 1555 model.default_set_fields_options.merge(opts) 1556 else 1557 model.default_set_fields_options 1558 end 1559 1560 case missing = opts[:missing] 1561 when :skip, :raise 1562 do_raise = true if missing == :raise 1563 fields.each do |f| 1564 if hash.has_key?(f) 1565 set_column_value("#{f}=", hash[f]) 1566 elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1567 set_column_value("#{sf}=", hash[sf]) 1568 elsif do_raise 1569 raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1570 end 1571 end 1572 else 1573 fields.each{|f| set_column_value("#{f}=", hash[f])} 1574 end 1575 self 1576 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 1579 def set_server(s) 1580 @server = s 1581 @this = @this.server(s) if @this 1582 self 1583 end
Set the shard that this object is tied to. Returns self.
Source
# File lib/sequel/model/base.rb 1586 def singleton_method_added(meth) 1587 @singleton_setter_added = true if meth.to_s.end_with?('=') 1588 super 1589 end
Clear the setter_methods
cache when a method is added
Source
# File lib/sequel/model/base.rb 1596 def skip_validation_on_next_save! 1597 @skip_validation_on_next_save = true 1598 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 1604 def this 1605 return @this if @this 1606 raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1607 @this = use_server(ds.where(pk_hash)) 1608 end
Returns (naked) dataset that should return only this instance.
Artist[1].this # SELECT * FROM artists WHERE (id = 1) LIMIT 1
Source
# File lib/sequel/model/base.rb 1613 def update(hash) 1614 update_restricted(hash, :default) 1615 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 1625 def update_fields(hash, fields, opts=nil) 1626 set_fields(hash, fields, opts) 1627 save_changes 1628 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 1644 def valid?(opts = OPTS) 1645 _valid?(opts) 1646 rescue HookFailed 1647 false 1648 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 1636 def validate 1637 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 1653 def _add_changed_column(column) 1654 cc = _changed_columns 1655 cc << column unless cc.include?(column) 1656 end
Add a column as a changed column.
Source
# File lib/sequel/model/base.rb 1659 def _changed_columns 1660 @changed_columns ||= [] 1661 end
Internal changed_columns
method that just returns stored array.
Source
# File lib/sequel/model/base.rb 1666 def _clear_changed_columns(_reason) 1667 _changed_columns.clear 1668 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 1672 def _delete 1673 n = _delete_without_checking 1674 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 1675 n 1676 end
Do the deletion of the object’s dataset, and check that the row was actually deleted.
Source
# File lib/sequel/model/base.rb 1680 def _delete_dataset 1681 this 1682 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 1686 def _delete_without_checking 1687 if sql = (m = model).fast_instance_delete_sql 1688 sql = sql.dup 1689 ds = use_server(m.dataset) 1690 ds.literal_append(sql, pk) 1691 ds.with_sql_delete(sql) 1692 else 1693 _delete_dataset.delete 1694 end 1695 end
Actually do the deletion of the object’s dataset. Return the number of rows modified.
Source
# File lib/sequel/model/base.rb 1699 def _destroy(opts) 1700 called = false 1701 around_destroy do 1702 called = true 1703 before_destroy 1704 _destroy_delete 1705 after_destroy 1706 end 1707 raise_hook_failure(:around_destroy) unless called 1708 self 1709 end
Internal destroy method, separted from destroy to allow running inside a transaction
Source
# File lib/sequel/model/base.rb 1714 def _destroy_delete 1715 delete 1716 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 1720 def _insert 1721 ds = _insert_dataset 1722 if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil? 1723 _save_set_values(h) if h 1724 nil 1725 else 1726 iid = _insert_raw(ds) 1727 # if we have a regular primary key and it's not set in @values, 1728 # we assume it's the last inserted id 1729 if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk] 1730 vals[pk] = iid 1731 end 1732 pk 1733 end 1734 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 1738 def _insert_dataset 1739 use_server(model.instance_dataset) 1740 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 1743 def _insert_raw(ds) 1744 ds.insert(_insert_values) 1745 end
Insert into the given dataset and return the primary key created (if any).
Source
# File lib/sequel/model/base.rb 1748 def _insert_select_raw(ds) 1749 ds.insert_select(_insert_values) 1750 end
Insert into the given dataset and return the hash of column values.
Source
# File lib/sequel/model/base.rb 1758 def _refresh(dataset) 1759 _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found")) 1760 _clear_changed_columns(:refresh) 1761 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 1764 def _refresh_get(dataset) 1765 if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock] 1766 sql = sql.dup 1767 ds = use_server(dataset) 1768 ds.literal_append(sql, pk) 1769 ds.with_sql_first(sql) 1770 else 1771 dataset.first 1772 end 1773 end
Get the row of column data from the database.
Source
# File lib/sequel/model/base.rb 1776 def _refresh_set_values(h) 1777 @values = h 1778 end
Set the values to the given hash after refreshing.
Source
# File lib/sequel/model/base.rb 1782 def _save(opts) 1783 pk = nil 1784 called_save = false 1785 called_cu = false 1786 around_save do 1787 called_save = true 1788 before_save 1789 1790 if new? 1791 around_create do 1792 called_cu = true 1793 before_create 1794 pk = _insert 1795 @this = nil 1796 @new = false 1797 @modified = false 1798 pk ? _save_refresh : _clear_changed_columns(:create) 1799 after_create 1800 true 1801 end 1802 raise_hook_failure(:around_create) unless called_cu 1803 else 1804 around_update do 1805 called_cu = true 1806 before_update 1807 columns = opts[:columns] 1808 if columns.nil? 1809 columns_updated = if opts[:changed] 1810 _save_update_changed_colums_hash 1811 else 1812 _save_update_all_columns_hash 1813 end 1814 _clear_changed_columns(:update) 1815 else # update only the specified columns 1816 columns = Array(columns) 1817 columns_updated = @values.reject{|k, v| !columns.include?(k)} 1818 _changed_columns.reject!{|c| columns.include?(c)} 1819 end 1820 _update_columns(columns_updated) 1821 @this = nil 1822 @modified = false 1823 after_update 1824 true 1825 end 1826 raise_hook_failure(:around_update) unless called_cu 1827 end 1828 after_save 1829 true 1830 end 1831 raise_hook_failure(:around_save) unless called_save 1832 self 1833 end
Internal version of save, split from save to allow running inside it’s own transaction.
Source
# File lib/sequel/model/base.rb 1838 def _save_refresh 1839 _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found")) 1840 _clear_changed_columns(:create) 1841 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 1845 def _save_set_values(h) 1846 @values = h 1847 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 1855 def _save_update_all_columns_hash 1856 v = Hash[@values] 1857 cc = changed_columns 1858 Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)} 1859 v 1860 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 1865 def _save_update_changed_colums_hash 1866 cc = changed_columns 1867 @values.reject{|k,v| !cc.include?(k)} 1868 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 1874 def _save_valid?(opts) 1875 if @skip_validation_on_next_save 1876 @skip_validation_on_next_save = false 1877 return true 1878 end 1879 1880 checked_save_failure(opts){_valid?(opts)} 1881 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 1892 def _update(columns) 1893 n = _update_without_checking(columns) 1894 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 1895 n 1896 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 1886 def _update_columns(columns) 1887 _update(columns) unless columns.empty? 1888 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 1900 def _update_dataset 1901 this 1902 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 1905 def _update_without_checking(columns) 1906 _update_dataset.update(columns) 1907 end
Update this instances dataset with the supplied column hash.
Source
# File lib/sequel/model/base.rb 1910 def _use_insert_select?(ds) 1911 (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 1912 end
Whether to use insert_select when inserting a new row.
Source
# File lib/sequel/model/base.rb 1915 def _valid?(opts) 1916 return errors.empty? if frozen? 1917 errors.clear 1918 called = false 1919 skip_validate = opts[:validate] == false 1920 around_validation do 1921 called = true 1922 before_validation 1923 validate unless skip_validate 1924 after_validation 1925 end 1926 1927 return true if skip_validate 1928 1929 if called 1930 errors.empty? 1931 else 1932 raise_hook_failure(:around_validation) 1933 end 1934 end
Internal validation method, running validation hooks.
Source
# File lib/sequel/model/base.rb 1958 def change_column_value(column, value) 1959 _add_changed_column(column) 1960 @values[column] = value 1961 end
Change the value of the column to given value, recording the change.
Source
# File lib/sequel/model/base.rb 1938 def checked_save_failure(opts) 1939 if raise_on_failure?(opts) 1940 yield 1941 else 1942 begin 1943 yield 1944 rescue HookFailed 1945 nil 1946 end 1947 end 1948 end
If not raising on failure, check for HookFailed
being raised by yielding and swallow it.
Source
# File lib/sequel/model/base.rb 1951 def checked_transaction(opts=OPTS, &block) 1952 h = {:server=>this_server}.merge!(opts) 1953 h[:skip_transaction] = true unless use_transaction?(opts) 1954 db.transaction(h, &block) 1955 end
If transactions should be used, wrap the yield in a transaction block.
Source
# File lib/sequel/model/base.rb 1964 def errors_class 1965 Errors 1966 end
Default error class used for errors.
Source
# File lib/sequel/model/base.rb 1969 def hook_failed_error(msg) 1970 HookFailed.new(msg, self) 1971 end
A HookFailed
exception for the given message tied to the current instance.
Source
# File lib/sequel/model/base.rb 1975 def initialize_clone(other) 1976 super 1977 freeze if other.frozen? 1978 self 1979 end
Clone constructor – freeze internal data structures if the original’s are frozen.
Source
# File lib/sequel/model/base.rb 1982 def initialize_copy(other) 1983 super 1984 @values = Hash[@values] 1985 @changed_columns = @changed_columns.dup if @changed_columns 1986 @errors = @errors.dup if @errors 1987 self 1988 end
Copy constructor – Duplicate internal data structures.
Source
# File lib/sequel/model/base.rb 1993 def initialize_set(h) 1994 set(h) unless h.empty? 1995 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 1998 def inspect_values 1999 @values.inspect 2000 end
Default inspection output for the values hash, overwrite to change what inspect
displays.
Source
# File lib/sequel/model/base.rb 2012 def raise_hook_failure(type=nil) 2013 msg = case type 2014 when String 2015 type 2016 when Symbol 2017 "the #{type} hook failed" 2018 else 2019 "a hook failed" 2020 end 2021 2022 raise hook_failed_error(msg) 2023 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 2006 def raise_on_failure?(opts) 2007 opts.fetch(:raise_on_failure, raise_on_save_failure) 2008 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 2026 def schema_type_class(column) 2027 if (sch = db_schema[column]) && (type = sch[:type]) 2028 db.schema_type_class(type) 2029 end 2030 end
Get the ruby class or classes related to the given column’s type.
Source
# File lib/sequel/model/base.rb 2034 def set_restricted(hash, type) 2035 return self if hash.empty? 2036 meths = setter_methods(type) 2037 strict = strict_param_setting 2038 hash.each do |k,v| 2039 k = k.to_s 2040 m = "#{k}=" 2041 if meths.include?(m) 2042 set_column_value(m, v) 2043 elsif strict 2044 # Avoid using respond_to? or creating symbols from user input 2045 if public_methods.map(&:to_s).include?(m) 2046 if Array(model.primary_key).map(&:to_s).member?(k) && model.restrict_primary_key? 2047 raise MassAssignmentRestriction.create("#{k} is a restricted primary key", self, k) 2048 else 2049 raise MassAssignmentRestriction.create("#{k} is a restricted column", self, k) 2050 end 2051 else 2052 raise MassAssignmentRestriction.create("method #{m} doesn't exist", self, k) 2053 end 2054 end 2055 end 2056 self 2057 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 2065 def setter_methods(type) 2066 if type == :default && !@singleton_setter_added 2067 return model.setter_methods 2068 end 2069 2070 meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS 2071 meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key? 2072 meths 2073 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 2077 def this_server 2078 if (s = @server) 2079 s 2080 elsif (t = @this) 2081 t.opts[:server] || :default 2082 else 2083 model.dataset.opts[:server] || :default 2084 end 2085 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 2090 def typecast_value(column, value) 2091 return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column]) 2092 value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type]) 2093 raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false) 2094 begin 2095 model.db.typecast_value(col_schema[:type], value) 2096 rescue InvalidValue 2097 raise_on_typecast_failure ? raise : value 2098 end 2099 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 2102 def update_restricted(hash, type) 2103 set_restricted(hash, type) 2104 save_changes 2105 end
Set the columns, filtered by the only and except arrays.
Source
# File lib/sequel/model/base.rb 2108 def use_server(ds) 2109 @server ? ds.server(@server) : ds 2110 end
Set the given dataset to use the current object’s shard.
Source
# File lib/sequel/model/base.rb 2115 def use_transaction?(opts = OPTS) 2116 opts.fetch(:transaction, use_transactions) 2117 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 2120 def validation_failed_error 2121 ValidationFailed.new(self) 2122 end
An ValidationFailed
exception instance to raise for this instance.