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.
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 1065 def initialize(values = OPTS) 1066 @values = {} 1067 @new = true 1068 @modified = true 1069 initialize_set(values) 1070 _changed_columns.clear 1071 yield self if block_given? 1072 end
Public Instance Methods
Alias of eql?
# File lib/sequel/model/base.rb 1102 def ==(obj) 1103 eql?(obj) 1104 end
If pk is not nil, true only if the objects have the same class and pk. If pk is nil, false.
Artist[1] === Artist[1] # true Artist.new === Artist.new # false Artist[1].set(:name=>'Bob') == Artist[1] # => true
# File lib/sequel/model/base.rb 1112 def ===(obj) 1113 pk.nil? ? false : (obj.class == model) && (obj.pk == pk) 1114 end
Returns value of the column's attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb 1077 def [](column) 1078 @values[column] 1079 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 1089 def []=(column, value) 1090 # If it is new, it doesn't have a value yet, so we should 1091 # definitely set the new value. 1092 # If the column isn't in @values, we can't assume it is 1093 # NULL in the database, so assume it has changed. 1094 v = typecast_value(column, value) 1095 vals = @values 1096 if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class 1097 change_column_value(column, v) 1098 end 1099 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 1127 def autoincrementing_primary_key 1128 primary_key 1129 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 1135 def cancel_action(msg=nil) 1136 raise_hook_failure(msg) 1137 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 1146 def changed_columns 1147 _changed_columns 1148 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 1155 def delete 1156 raise Sequel::Error, "can't delete frozen object" if frozen? 1157 _delete 1158 self 1159 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 1167 def destroy(opts = OPTS) 1168 raise Sequel::Error, "can't destroy frozen object" if frozen? 1169 checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 1170 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 1177 def each(&block) 1178 @values.each(&block) 1179 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 1186 def eql?(obj) 1187 (obj.class == model) && (obj.values == @values) 1188 end
Returns the validation errors associated with this object. See Errors
.
# File lib/sequel/model/base.rb 1192 def errors 1193 @errors ||= errors_class.new 1194 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 FROM artists WHERE (id = 1) # => true Artist.new.exists? # => false
# File lib/sequel/model/base.rb 1206 def exists? 1207 new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil? 1208 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 1212 def extend(mod) 1213 @singleton_setter_added = true 1214 super 1215 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 1220 def freeze 1221 values.freeze 1222 _changed_columns.freeze 1223 unless errors.frozen? 1224 validate 1225 errors.freeze 1226 end 1227 this if !new? && model.primary_key 1228 super 1229 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 1238 def hash 1239 case primary_key 1240 when Array 1241 [model, !pk.all? ? @values : pk].hash 1242 when Symbol 1243 [model, pk.nil? ? @values : pk].hash 1244 else 1245 [model, @values].hash 1246 end 1247 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 1253 def id 1254 @values[:id] 1255 end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb 1259 def inspect 1260 "#<#{model.name} @values=#{inspect_values}>" 1261 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 1268 def keys 1269 @values.keys 1270 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 1295 def lock!(style=:update) 1296 _refresh(this.lock_style(style)) unless new? 1297 self 1298 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 1305 def marshallable! 1306 @this = nil 1307 self 1308 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 1325 def modified!(column=nil) 1326 _add_changed_column(column) if column 1327 @modified = true 1328 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 1345 def modified?(column=nil) 1346 if column 1347 changed_columns.include?(column) 1348 else 1349 @modified || !changed_columns.empty? 1350 end 1351 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 1357 def new? 1358 defined?(@new) ? @new : (@new = false) 1359 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 1367 def pk 1368 raise(Error, "No primary key is associated with this model") unless key = primary_key 1369 if key.is_a?(Array) 1370 vals = @values 1371 key.map{|k| vals[k]} 1372 else 1373 @values[key] 1374 end 1375 end
Returns a hash mapping the receivers primary key column(s) to their values.
Artist[1].pk_hash # => {:id=>1} Artist[[1, 2]].pk_hash # => {:id1=>1, :id2=>2}
# File lib/sequel/model/base.rb 1381 def pk_hash 1382 model.primary_key_hash(pk) 1383 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 1391 def qualified_pk_hash(qualifier=model.table_name) 1392 model.qualified_primary_key_hash(pk, qualifier) 1393 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 1403 def refresh 1404 raise Sequel::Error, "can't refresh frozen object" if frozen? 1405 _refresh(this) 1406 self 1407 end
Alias of refresh, but not aliased directly to make overriding in a plugin easier.
# File lib/sequel/model/base.rb 1410 def reload 1411 refresh 1412 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 returns false, or
-
the record is new and before_create returns false, or
-
the record is not new and before_update returns false.
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 1439 def save(opts=OPTS) 1440 raise Sequel::Error, "can't save frozen object" if frozen? 1441 set_server(opts[:server]) if opts[:server] 1442 unless checked_save_failure(opts){_valid?(opts)} 1443 raise(ValidationFailed.new(self)) if raise_on_failure?(opts) 1444 return 1445 end 1446 checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 1447 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 1458 def save_changes(opts=OPTS) 1459 save(Hash[opts].merge!(:changed=>true)) || false if modified? 1460 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 1469 def set(hash) 1470 set_restricted(hash, :default) 1471 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 1499 def set_fields(hash, fields, opts=nil) 1500 opts = if opts 1501 Hash[model.default_set_fields_options].merge!(opts) 1502 else 1503 model.default_set_fields_options 1504 end 1505 1506 case missing = opts[:missing] 1507 when :skip, :raise 1508 do_raise = true if missing == :raise 1509 fields.each do |f| 1510 if hash.has_key?(f) 1511 set_column_value("#{f}=", hash[f]) 1512 elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1513 set_column_value("#{sf}=", hash[sf]) 1514 elsif do_raise 1515 raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1516 end 1517 end 1518 else 1519 fields.each{|f| set_column_value("#{f}=", hash[f])} 1520 end 1521 self 1522 end
Set the shard that this object is tied to. Returns self.
# File lib/sequel/model/base.rb 1525 def set_server(s) 1526 @server = s 1527 @this = @this.server(s) if @this 1528 self 1529 end
Clear the setter_methods
cache when a method is added
# File lib/sequel/model/base.rb 1532 def singleton_method_added(meth) 1533 @singleton_setter_added = true if meth.to_s.end_with?('=') 1534 super 1535 end
Returns (naked) dataset that should return only this instance.
Artist[1].this # SELECT * FROM artists WHERE (id = 1) LIMIT 1
# File lib/sequel/model/base.rb 1541 def this 1542 return @this if @this 1543 raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1544 @this = use_server(ds.where(pk_hash)) 1545 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 1550 def update(hash) 1551 update_restricted(hash, :default) 1552 end
Update the instances values by calling set_fields
with the arguments, then saves any changes to the record. Returns self.
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 1562 def update_fields(hash, fields, opts=nil) 1563 set_fields(hash, fields, opts) 1564 save_changes 1565 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 1581 def valid?(opts = OPTS) 1582 begin 1583 _valid?(opts) 1584 rescue HookFailed 1585 false 1586 end 1587 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 1573 def validate 1574 end
Private Instance Methods
Add a column as a changed column.
# File lib/sequel/model/base.rb 1592 def _add_changed_column(column) 1593 cc = _changed_columns 1594 cc << column unless cc.include?(column) 1595 end
Internal changed_columns
method that just returns stored array.
# File lib/sequel/model/base.rb 1598 def _changed_columns 1599 @changed_columns ||= [] 1600 end
Do the deletion of the object's dataset, and check that the row was actually deleted.
# File lib/sequel/model/base.rb 1604 def _delete 1605 n = _delete_without_checking 1606 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 1607 n 1608 end
The dataset to use when deleting the object. The same as the object's dataset by default.
# File lib/sequel/model/base.rb 1612 def _delete_dataset 1613 this 1614 end
Actually do the deletion of the object's dataset. Return the number of rows modified.
# File lib/sequel/model/base.rb 1618 def _delete_without_checking 1619 if sql = (m = model).fast_instance_delete_sql 1620 sql = sql.dup 1621 ds = use_server(m.dataset) 1622 ds.literal_append(sql, pk) 1623 ds.with_sql_delete(sql) 1624 else 1625 _delete_dataset.delete 1626 end 1627 end
Internal destroy method, separted from destroy to allow running inside a transaction
# File lib/sequel/model/base.rb 1631 def _destroy(opts) 1632 called = false 1633 around_destroy do 1634 called = true 1635 before_destroy 1636 _destroy_delete 1637 after_destroy 1638 end 1639 raise_hook_failure(:around_destroy) unless called 1640 self 1641 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 1646 def _destroy_delete 1647 delete 1648 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 1652 def _insert 1653 ds = _insert_dataset 1654 if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil? 1655 _save_set_values(h) if h 1656 nil 1657 else 1658 iid = _insert_raw(ds) 1659 # if we have a regular primary key and it's not set in @values, 1660 # we assume it's the last inserted id 1661 if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk] 1662 vals[pk] = iid 1663 end 1664 pk 1665 end 1666 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 1670 def _insert_dataset 1671 use_server(model.instance_dataset) 1672 end
Insert into the given dataset and return the primary key created (if any).
# File lib/sequel/model/base.rb 1675 def _insert_raw(ds) 1676 ds.insert(_insert_values) 1677 end
Insert into the given dataset and return the hash of column values.
# File lib/sequel/model/base.rb 1680 def _insert_select_raw(ds) 1681 ds.insert_select(_insert_values) 1682 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 1689 def _refresh(dataset) 1690 _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found")) 1691 _changed_columns.clear 1692 end
Get the row of column data from the database.
# File lib/sequel/model/base.rb 1695 def _refresh_get(dataset) 1696 if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock] 1697 sql = sql.dup 1698 ds = use_server(dataset) 1699 ds.literal_append(sql, pk) 1700 ds.with_sql_first(sql) 1701 else 1702 dataset.first 1703 end 1704 end
Set the values to the given hash after refreshing.
# File lib/sequel/model/base.rb 1707 def _refresh_set_values(h) 1708 @values = h 1709 end
Internal version of save, split from save to allow running inside it's own transaction.
# File lib/sequel/model/base.rb 1713 def _save(opts) 1714 pk = nil 1715 called_save = false 1716 called_cu = false 1717 around_save do 1718 called_save = true 1719 before_save 1720 1721 if new? 1722 around_create do 1723 called_cu = true 1724 before_create 1725 pk = _insert 1726 @this = nil 1727 @new = false 1728 @modified = false 1729 pk ? _save_refresh : _changed_columns.clear 1730 after_create 1731 true 1732 end 1733 raise_hook_failure(:around_create) unless called_cu 1734 else 1735 around_update do 1736 called_cu = true 1737 before_update 1738 columns = opts[:columns] 1739 if columns.nil? 1740 if opts[:changed] 1741 cc = changed_columns 1742 columns_updated = @values.reject{|k,v| !cc.include?(k)} 1743 cc.clear 1744 else 1745 columns_updated = _save_update_all_columns_hash 1746 _changed_columns.clear 1747 end 1748 else # update only the specified columns 1749 columns = Array(columns) 1750 columns_updated = @values.reject{|k, v| !columns.include?(k)} 1751 _changed_columns.reject!{|c| columns.include?(c)} 1752 end 1753 _update_columns(columns_updated) 1754 @this = nil 1755 @modified = false 1756 after_update 1757 true 1758 end 1759 raise_hook_failure(:around_update) unless called_cu 1760 end 1761 after_save 1762 true 1763 end 1764 raise_hook_failure(:around_save) unless called_save 1765 self 1766 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 1771 def _save_refresh 1772 _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found")) 1773 _changed_columns.clear 1774 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 1778 def _save_set_values(h) 1779 @values = h 1780 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 1788 def _save_update_all_columns_hash 1789 v = Hash[@values] 1790 cc = changed_columns 1791 Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)} 1792 v 1793 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 1804 def _update(columns) 1805 n = _update_without_checking(columns) 1806 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 1807 n 1808 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 1798 def _update_columns(columns) 1799 _update(columns) unless columns.empty? 1800 end
The dataset to use when updating an object. The same as the object's dataset by default.
# File lib/sequel/model/base.rb 1812 def _update_dataset 1813 this 1814 end
Update this instances dataset with the supplied column hash.
# File lib/sequel/model/base.rb 1817 def _update_without_checking(columns) 1818 _update_dataset.update(columns) 1819 end
Whether to use insert_select when inserting a new row.
# File lib/sequel/model/base.rb 1822 def _use_insert_select?(ds) 1823 (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 1824 end
Internal validation method, running validation hooks.
# File lib/sequel/model/base.rb 1827 def _valid?(opts) 1828 return errors.empty? if frozen? 1829 errors.clear 1830 called = false 1831 skip_validate = opts[:validate] == false 1832 around_validation do 1833 called = true 1834 before_validation 1835 validate unless skip_validate 1836 after_validation 1837 end 1838 1839 return true if skip_validate 1840 1841 if called 1842 errors.empty? 1843 else 1844 raise_hook_failure(:around_validation) 1845 end 1846 end
Change the value of the column to given value, recording the change.
# File lib/sequel/model/base.rb 1868 def change_column_value(column, value) 1869 _add_changed_column(column) 1870 @values[column] = value 1871 end
If not raising on failure, check for HookFailed
being raised by yielding and swallow it.
# File lib/sequel/model/base.rb 1850 def checked_save_failure(opts) 1851 if raise_on_failure?(opts) 1852 yield 1853 else 1854 begin 1855 yield 1856 rescue HookFailed 1857 nil 1858 end 1859 end 1860 end
If transactions should be used, wrap the yield in a transaction block.
# File lib/sequel/model/base.rb 1863 def checked_transaction(opts=OPTS) 1864 use_transaction?(opts) ? db.transaction({:server=>this_server}.merge!(opts)){yield} : yield 1865 end
Default error class used for errors.
# File lib/sequel/model/base.rb 1874 def errors_class 1875 Errors 1876 end
Clone constructor – freeze internal data structures if the original's are frozen.
# File lib/sequel/model/base.rb 1880 def initialize_clone(other) 1881 super 1882 freeze if other.frozen? 1883 self 1884 end
Copy constructor – Duplicate internal data structures.
# File lib/sequel/model/base.rb 1887 def initialize_copy(other) 1888 super 1889 @values = Hash[@values] 1890 @changed_columns = @changed_columns.dup if @changed_columns 1891 @errors = @errors.dup if @errors 1892 self 1893 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 1898 def initialize_set(h) 1899 set(h) unless h.empty? 1900 end
Default inspection output for the values hash, overwrite to change what inspect
displays.
# File lib/sequel/model/base.rb 1903 def inspect_values 1904 @values.inspect 1905 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 1917 def raise_hook_failure(type=nil) 1918 msg = case type 1919 when String 1920 type 1921 when Symbol 1922 "the #{type} hook failed" 1923 else 1924 "a hook failed" 1925 end 1926 1927 raise HookFailed.new(msg, self) 1928 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 1911 def raise_on_failure?(opts) 1912 opts.fetch(:raise_on_failure, raise_on_save_failure) 1913 end
Get the ruby class or classes related to the given column's type.
# File lib/sequel/model/base.rb 1931 def schema_type_class(column) 1932 if (sch = db_schema[column]) && (type = sch[:type]) 1933 db.schema_type_class(type) 1934 end 1935 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 1939 def set_restricted(hash, type) 1940 return self if hash.empty? 1941 meths = setter_methods(type) 1942 strict = strict_param_setting 1943 hash.each do |k,v| 1944 m = "#{k}=" 1945 if meths.include?(m) 1946 set_column_value(m, v) 1947 elsif strict 1948 # Avoid using respond_to? or creating symbols from user input 1949 if public_methods.map(&:to_s).include?(m) 1950 if Array(model.primary_key).map(&:to_s).member?(k.to_s) && model.restrict_primary_key? 1951 raise MassAssignmentRestriction, "#{k} is a restricted primary key" 1952 else 1953 raise MassAssignmentRestriction, "#{k} is a restricted column" 1954 end 1955 else 1956 raise MassAssignmentRestriction, "method #{m} doesn't exist" 1957 end 1958 end 1959 end 1960 self 1961 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 1969 def setter_methods(type) 1970 if type == :default && !@singleton_setter_added 1971 return model.setter_methods 1972 end 1973 1974 meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS 1975 meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key? 1976 meths 1977 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 1981 def this_server 1982 if (s = @server) 1983 s 1984 elsif (t = @this) 1985 t.opts[:server] || :default 1986 else 1987 model.dataset.opts[:server] || :default 1988 end 1989 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 1994 def typecast_value(column, value) 1995 return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column]) 1996 value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type]) 1997 raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false) 1998 begin 1999 model.db.typecast_value(col_schema[:type], value) 2000 rescue InvalidValue 2001 raise_on_typecast_failure ? raise : value 2002 end 2003 end
Set the columns, filtered by the only and except arrays.
# File lib/sequel/model/base.rb 2006 def update_restricted(hash, type) 2007 set_restricted(hash, type) 2008 save_changes 2009 end
Set the given dataset to use the current object's shard.
# File lib/sequel/model/base.rb 2012 def use_server(ds) 2013 @server ? ds.server(@server) : ds 2014 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 2019 def use_transaction?(opts = OPTS) 2020 opts.fetch(:transaction, use_transactions) 2021 end