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 1067 def initialize(values = OPTS) 1068 @values = {} 1069 @new = true 1070 @modified = true 1071 initialize_set(values) 1072 _changed_columns.clear 1073 yield self if block_given? 1074 end
Public Instance Methods
Alias of eql?
# File lib/sequel/model/base.rb 1104 def ==(obj) 1105 eql?(obj) 1106 end
Case equality. By default, checks equality of the primary key value, see pk_equal?.
Artist[1] === Artist[1] # => true Artist.new === Artist.new # => false Artist[1].set(:name=>'Bob') === Artist[1] # => true
# File lib/sequel/model/base.rb 1114 def ===(obj) 1115 case pkv = pk 1116 when nil 1117 return false 1118 when Array 1119 return false if pk.any?(&:nil?) 1120 end 1121 1122 (obj.class == model) && (obj.pk == pkv) 1123 end
Returns value of the column's attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb 1079 def [](column) 1080 @values[column] 1081 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 1091 def []=(column, value) 1092 # If it is new, it doesn't have a value yet, so we should 1093 # definitely set the new value. 1094 # If the column isn't in @values, we can't assume it is 1095 # NULL in the database, so assume it has changed. 1096 v = typecast_value(column, value) 1097 vals = @values 1098 if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class 1099 change_column_value(column, v) 1100 end 1101 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 1146 def autoincrementing_primary_key 1147 primary_key 1148 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 1154 def cancel_action(msg=nil) 1155 raise_hook_failure(msg) 1156 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 1165 def changed_columns 1166 _changed_columns 1167 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 1174 def delete 1175 raise Sequel::Error, "can't delete frozen object" if frozen? 1176 _delete 1177 self 1178 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 1186 def destroy(opts = OPTS) 1187 raise Sequel::Error, "can't destroy frozen object" if frozen? 1188 checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 1189 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 1196 def each(&block) 1197 @values.each(&block) 1198 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 1205 def eql?(obj) 1206 (obj.class == model) && (obj.values == @values) 1207 end
Returns the validation errors associated with this object. See Errors
.
# File lib/sequel/model/base.rb 1211 def errors 1212 @errors ||= errors_class.new 1213 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 1225 def exists? 1226 new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil? 1227 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 1231 def extend(mod) 1232 @singleton_setter_added = true 1233 super 1234 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 1239 def freeze 1240 values.freeze 1241 _changed_columns.freeze 1242 unless errors.frozen? 1243 validate 1244 errors.freeze 1245 end 1246 this if !new? && model.primary_key 1247 super 1248 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 1257 def hash 1258 case primary_key 1259 when Array 1260 [model, !pk.all? ? @values : pk].hash 1261 when Symbol 1262 [model, pk.nil? ? @values : pk].hash 1263 else 1264 [model, @values].hash 1265 end 1266 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 1272 def id 1273 @values[:id] 1274 end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb 1278 def inspect 1279 "#<#{model.name} @values=#{inspect_values}>" 1280 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 1287 def keys 1288 @values.keys 1289 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 1314 def lock!(style=:update) 1315 _refresh(this.lock_style(style)) unless new? 1316 self 1317 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 1324 def marshallable! 1325 @this = nil 1326 self 1327 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 1344 def modified!(column=nil) 1345 _add_changed_column(column) if column 1346 @modified = true 1347 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 1364 def modified?(column=nil) 1365 if column 1366 changed_columns.include?(column) 1367 else 1368 @modified || !changed_columns.empty? 1369 end 1370 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 1376 def new? 1377 defined?(@new) ? @new : (@new = false) 1378 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 1386 def pk 1387 raise(Error, "No primary key is associated with this model") unless key = primary_key 1388 if key.is_a?(Array) 1389 vals = @values 1390 key.map{|k| vals[k]} 1391 else 1392 @values[key] 1393 end 1394 end
If the receiver has a primary key value, returns true if the objects have the same class and primary key value. If the receiver's primary key value is nil or is an array containing nil, returns false.
Artist[1].pk_equal?(Artist[1]) # => true Artist.new.pk_equal?(Artist.new) # => false Artist[1].set(:name=>'Bob').pk_equal?(Artist[1]) # => true
Returns a hash mapping the receivers primary key column(s) to their values.
Artist[1].pk_hash # => {:id=>1} Artist[[1, 2]].pk_hash # => {:id1=>1, :id2=>2}
# File lib/sequel/model/base.rb 1400 def pk_hash 1401 model.primary_key_hash(pk) 1402 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 1410 def qualified_pk_hash(qualifier=model.table_name) 1411 model.qualified_primary_key_hash(pk, qualifier) 1412 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 1422 def refresh 1423 raise Sequel::Error, "can't refresh frozen object" if frozen? 1424 _refresh(this) 1425 self 1426 end
Alias of refresh, but not aliased directly to make overriding in a plugin easier.
# File lib/sequel/model/base.rb 1429 def reload 1430 refresh 1431 end
Creates or updates the record, after making sure the record is valid and before hooks execute successfully. Fails if:
-
the record is not valid, or
-
before_save calls
cancel_action
, or -
the record is new and before_create calls
cancel_action
, or -
the record is not new and before_update calls cancel_action.
If save
fails and either raise_on_save_failure or the :raise_on_failure option is true, it raises ValidationFailed
or HookFailed
. Otherwise it returns nil.
If it succeeds, it returns self.
Takes the following options:
- :changed
-
save all changed columns, instead of all columns or the columns given
- :columns
-
array of specific columns that should be saved.
- :raise_on_failure
-
set to true or false to override the current
raise_on_save_failure
setting - :server
-
set the server/shard on the object before saving, and use that server/shard in any transaction.
- :transaction
-
set to true or false to override the current
use_transactions
setting - :validate
-
set to false to skip validation
# File lib/sequel/model/base.rb 1458 def save(opts=OPTS) 1459 raise Sequel::Error, "can't save frozen object" if frozen? 1460 set_server(opts[:server]) if opts[:server] 1461 unless _save_valid?(opts) 1462 raise(validation_failed_error) if raise_on_failure?(opts) 1463 return 1464 end 1465 checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 1466 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 1477 def save_changes(opts=OPTS) 1478 save(Hash[opts].merge!(:changed=>true)) || false if modified? 1479 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 1488 def set(hash) 1489 set_restricted(hash, :default) 1490 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 1518 def set_fields(hash, fields, opts=nil) 1519 opts = if opts 1520 model.default_set_fields_options.merge(opts) 1521 else 1522 model.default_set_fields_options 1523 end 1524 1525 case missing = opts[:missing] 1526 when :skip, :raise 1527 do_raise = true if missing == :raise 1528 fields.each do |f| 1529 if hash.has_key?(f) 1530 set_column_value("#{f}=", hash[f]) 1531 elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1532 set_column_value("#{sf}=", hash[sf]) 1533 elsif do_raise 1534 raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1535 end 1536 end 1537 else 1538 fields.each{|f| set_column_value("#{f}=", hash[f])} 1539 end 1540 self 1541 end
Set the shard that this object is tied to. Returns self.
# File lib/sequel/model/base.rb 1544 def set_server(s) 1545 @server = s 1546 @this = @this.server(s) if @this 1547 self 1548 end
Clear the setter_methods
cache when a method is added
# File lib/sequel/model/base.rb 1551 def singleton_method_added(meth) 1552 @singleton_setter_added = true if meth.to_s.end_with?('=') 1553 super 1554 end
Skip all validation of the object on the next call to save
, including the running of validation hooks. This is designed for and should only be used in cases where valid?
is called before saving and the validate: false
option cannot be passed to save
.
# File lib/sequel/model/base.rb 1561 def skip_validation_on_next_save! 1562 @skip_validation_on_next_save = true 1563 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 1569 def this 1570 return @this if @this 1571 raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1572 @this = use_server(ds.where(pk_hash)) 1573 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 1578 def update(hash) 1579 update_restricted(hash, :default) 1580 end
Update the instance's values by calling set_fields
with the arguments, then calls save_changes.
artist.update_fields({name: 'Jim'}, [:name]) # UPDATE artists SET name = 'Jim' WHERE (id = 1) artist.update_fields({hometown: 'LA'}, [:name]) # UPDATE artists SET name = NULL WHERE (id = 1)
# File lib/sequel/model/base.rb 1590 def update_fields(hash, fields, opts=nil) 1591 set_fields(hash, fields, opts) 1592 save_changes 1593 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 1609 def valid?(opts = OPTS) 1610 begin 1611 _valid?(opts) 1612 rescue HookFailed 1613 false 1614 end 1615 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 1601 def validate 1602 end
Private Instance Methods
Add a column as a changed column.
# File lib/sequel/model/base.rb 1620 def _add_changed_column(column) 1621 cc = _changed_columns 1622 cc << column unless cc.include?(column) 1623 end
Internal changed_columns
method that just returns stored array.
# File lib/sequel/model/base.rb 1626 def _changed_columns 1627 @changed_columns ||= [] 1628 end
Do the deletion of the object's dataset, and check that the row was actually deleted.
# File lib/sequel/model/base.rb 1632 def _delete 1633 n = _delete_without_checking 1634 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 1635 n 1636 end
The dataset to use when deleting the object. The same as the object's dataset by default.
# File lib/sequel/model/base.rb 1640 def _delete_dataset 1641 this 1642 end
Actually do the deletion of the object's dataset. Return the number of rows modified.
# File lib/sequel/model/base.rb 1646 def _delete_without_checking 1647 if sql = (m = model).fast_instance_delete_sql 1648 sql = sql.dup 1649 ds = use_server(m.dataset) 1650 ds.literal_append(sql, pk) 1651 ds.with_sql_delete(sql) 1652 else 1653 _delete_dataset.delete 1654 end 1655 end
Internal destroy method, separted from destroy to allow running inside a transaction
# File lib/sequel/model/base.rb 1659 def _destroy(opts) 1660 called = false 1661 around_destroy do 1662 called = true 1663 before_destroy 1664 _destroy_delete 1665 after_destroy 1666 end 1667 raise_hook_failure(:around_destroy) unless called 1668 self 1669 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 1674 def _destroy_delete 1675 delete 1676 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 1680 def _insert 1681 ds = _insert_dataset 1682 if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil? 1683 _save_set_values(h) if h 1684 nil 1685 else 1686 iid = _insert_raw(ds) 1687 # if we have a regular primary key and it's not set in @values, 1688 # we assume it's the last inserted id 1689 if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk] 1690 vals[pk] = iid 1691 end 1692 pk 1693 end 1694 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 1698 def _insert_dataset 1699 use_server(model.instance_dataset) 1700 end
Insert into the given dataset and return the primary key created (if any).
# File lib/sequel/model/base.rb 1703 def _insert_raw(ds) 1704 ds.insert(_insert_values) 1705 end
Insert into the given dataset and return the hash of column values.
# File lib/sequel/model/base.rb 1708 def _insert_select_raw(ds) 1709 ds.insert_select(_insert_values) 1710 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 1717 def _refresh(dataset) 1718 _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found")) 1719 _changed_columns.clear 1720 end
Get the row of column data from the database.
# File lib/sequel/model/base.rb 1723 def _refresh_get(dataset) 1724 if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock] 1725 sql = sql.dup 1726 ds = use_server(dataset) 1727 ds.literal_append(sql, pk) 1728 ds.with_sql_first(sql) 1729 else 1730 dataset.first 1731 end 1732 end
Set the values to the given hash after refreshing.
# File lib/sequel/model/base.rb 1735 def _refresh_set_values(h) 1736 @values = h 1737 end
Internal version of save, split from save to allow running inside it's own transaction.
# File lib/sequel/model/base.rb 1741 def _save(opts) 1742 pk = nil 1743 called_save = false 1744 called_cu = false 1745 around_save do 1746 called_save = true 1747 before_save 1748 1749 if new? 1750 around_create do 1751 called_cu = true 1752 before_create 1753 pk = _insert 1754 @this = nil 1755 @new = false 1756 @modified = false 1757 pk ? _save_refresh : _changed_columns.clear 1758 after_create 1759 true 1760 end 1761 raise_hook_failure(:around_create) unless called_cu 1762 else 1763 around_update do 1764 called_cu = true 1765 before_update 1766 columns = opts[:columns] 1767 if columns.nil? 1768 if opts[:changed] 1769 cc = changed_columns 1770 columns_updated = @values.reject{|k,v| !cc.include?(k)} 1771 cc.clear 1772 else 1773 columns_updated = _save_update_all_columns_hash 1774 _changed_columns.clear 1775 end 1776 else # update only the specified columns 1777 columns = Array(columns) 1778 columns_updated = @values.reject{|k, v| !columns.include?(k)} 1779 _changed_columns.reject!{|c| columns.include?(c)} 1780 end 1781 _update_columns(columns_updated) 1782 @this = nil 1783 @modified = false 1784 after_update 1785 true 1786 end 1787 raise_hook_failure(:around_update) unless called_cu 1788 end 1789 after_save 1790 true 1791 end 1792 raise_hook_failure(:around_save) unless called_save 1793 self 1794 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 1799 def _save_refresh 1800 _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found")) 1801 _changed_columns.clear 1802 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 1806 def _save_set_values(h) 1807 @values = h 1808 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 1816 def _save_update_all_columns_hash 1817 v = Hash[@values] 1818 cc = changed_columns 1819 Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)} 1820 v 1821 end
Validate the object if validating on save. Skips validation completely (including validation hooks) if skip_validation_on_save! has been called on the object, resetting the flag so that future saves will validate.
# File lib/sequel/model/base.rb 1827 def _save_valid?(opts) 1828 if @skip_validation_on_next_save 1829 @skip_validation_on_next_save = false 1830 return true 1831 end 1832 1833 checked_save_failure(opts){_valid?(opts)} 1834 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 1845 def _update(columns) 1846 n = _update_without_checking(columns) 1847 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 1848 n 1849 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 1839 def _update_columns(columns) 1840 _update(columns) unless columns.empty? 1841 end
The dataset to use when updating an object. The same as the object's dataset by default.
# File lib/sequel/model/base.rb 1853 def _update_dataset 1854 this 1855 end
Update this instances dataset with the supplied column hash.
# File lib/sequel/model/base.rb 1858 def _update_without_checking(columns) 1859 _update_dataset.update(columns) 1860 end
Whether to use insert_select when inserting a new row.
# File lib/sequel/model/base.rb 1863 def _use_insert_select?(ds) 1864 (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 1865 end
Internal validation method, running validation hooks.
# File lib/sequel/model/base.rb 1868 def _valid?(opts) 1869 return errors.empty? if frozen? 1870 errors.clear 1871 called = false 1872 skip_validate = opts[:validate] == false 1873 around_validation do 1874 called = true 1875 before_validation 1876 validate unless skip_validate 1877 after_validation 1878 end 1879 1880 return true if skip_validate 1881 1882 if called 1883 errors.empty? 1884 else 1885 raise_hook_failure(:around_validation) 1886 end 1887 end
Change the value of the column to given value, recording the change.
# File lib/sequel/model/base.rb 1909 def change_column_value(column, value) 1910 _add_changed_column(column) 1911 @values[column] = value 1912 end
If not raising on failure, check for HookFailed
being raised by yielding and swallow it.
# File lib/sequel/model/base.rb 1891 def checked_save_failure(opts) 1892 if raise_on_failure?(opts) 1893 yield 1894 else 1895 begin 1896 yield 1897 rescue HookFailed 1898 nil 1899 end 1900 end 1901 end
If transactions should be used, wrap the yield in a transaction block.
# File lib/sequel/model/base.rb 1904 def checked_transaction(opts=OPTS) 1905 use_transaction?(opts) ? db.transaction({:server=>this_server}.merge!(opts)){yield} : yield 1906 end
Default error class used for errors.
# File lib/sequel/model/base.rb 1915 def errors_class 1916 Errors 1917 end
A HookFailed
exception for the given message tied to the current instance.
# File lib/sequel/model/base.rb 1920 def hook_failed_error(msg) 1921 HookFailed.new(msg, self) 1922 end
Clone constructor – freeze internal data structures if the original's are frozen.
# File lib/sequel/model/base.rb 1926 def initialize_clone(other) 1927 super 1928 freeze if other.frozen? 1929 self 1930 end
Copy constructor – Duplicate internal data structures.
# File lib/sequel/model/base.rb 1933 def initialize_copy(other) 1934 super 1935 @values = Hash[@values] 1936 @changed_columns = @changed_columns.dup if @changed_columns 1937 @errors = @errors.dup if @errors 1938 self 1939 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 1944 def initialize_set(h) 1945 set(h) unless h.empty? 1946 end
Default inspection output for the values hash, overwrite to change what inspect
displays.
# File lib/sequel/model/base.rb 1949 def inspect_values 1950 @values.inspect 1951 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 1963 def raise_hook_failure(type=nil) 1964 msg = case type 1965 when String 1966 type 1967 when Symbol 1968 "the #{type} hook failed" 1969 else 1970 "a hook failed" 1971 end 1972 1973 raise hook_failed_error(msg) 1974 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 1957 def raise_on_failure?(opts) 1958 opts.fetch(:raise_on_failure, raise_on_save_failure) 1959 end
Get the ruby class or classes related to the given column's type.
# File lib/sequel/model/base.rb 1977 def schema_type_class(column) 1978 if (sch = db_schema[column]) && (type = sch[:type]) 1979 db.schema_type_class(type) 1980 end 1981 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 1985 def set_restricted(hash, type) 1986 return self if hash.empty? 1987 meths = setter_methods(type) 1988 strict = strict_param_setting 1989 hash.each do |k,v| 1990 m = "#{k}=" 1991 if meths.include?(m) 1992 set_column_value(m, v) 1993 elsif strict 1994 # Avoid using respond_to? or creating symbols from user input 1995 if public_methods.map(&:to_s).include?(m) 1996 if Array(model.primary_key).map(&:to_s).member?(k.to_s) && model.restrict_primary_key? 1997 raise MassAssignmentRestriction, "#{k} is a restricted primary key" 1998 else 1999 raise MassAssignmentRestriction, "#{k} is a restricted column" 2000 end 2001 else 2002 raise MassAssignmentRestriction, "method #{m} doesn't exist" 2003 end 2004 end 2005 end 2006 self 2007 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 2015 def setter_methods(type) 2016 if type == :default && !@singleton_setter_added 2017 return model.setter_methods 2018 end 2019 2020 meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS 2021 meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key? 2022 meths 2023 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 2027 def this_server 2028 if (s = @server) 2029 s 2030 elsif (t = @this) 2031 t.opts[:server] || :default 2032 else 2033 model.dataset.opts[:server] || :default 2034 end 2035 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 2040 def typecast_value(column, value) 2041 return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column]) 2042 value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type]) 2043 raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false) 2044 begin 2045 model.db.typecast_value(col_schema[:type], value) 2046 rescue InvalidValue 2047 raise_on_typecast_failure ? raise : value 2048 end 2049 end
Set the columns, filtered by the only and except arrays.
# File lib/sequel/model/base.rb 2052 def update_restricted(hash, type) 2053 set_restricted(hash, type) 2054 save_changes 2055 end
Set the given dataset to use the current object's shard.
# File lib/sequel/model/base.rb 2058 def use_server(ds) 2059 @server ? ds.server(@server) : ds 2060 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 2065 def use_transaction?(opts = OPTS) 2066 opts.fetch(:transaction, use_transactions) 2067 end
An ValidationFailed
exception instance to raise for this instance.
# File lib/sequel/model/base.rb 2070 def validation_failed_error 2071 ValidationFailed.new(self) 2072 end