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 1073 def initialize(values = OPTS) 1074 @values = {} 1075 @new = true 1076 @modified = true 1077 initialize_set(values) 1078 _clear_changed_columns(:initialize) 1079 yield self if block_given? 1080 end
Public Instance Methods
Alias of eql?
# File lib/sequel/model/base.rb 1110 def ==(obj) 1111 eql?(obj) 1112 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 1120 def ===(obj) 1121 case pkv = pk 1122 when nil 1123 return false 1124 when Array 1125 return false if pkv.any?(&:nil?) 1126 end 1127 1128 (obj.class == model) && (obj.pk == pkv) 1129 end
Returns value of the column's attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb 1085 def [](column) 1086 @values[column] 1087 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 1097 def []=(column, value) 1098 # If it is new, it doesn't have a value yet, so we should 1099 # definitely set the new value. 1100 # If the column isn't in @values, we can't assume it is 1101 # NULL in the database, so assume it has changed. 1102 v = typecast_value(column, value) 1103 vals = @values 1104 if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class 1105 change_column_value(column, v) 1106 end 1107 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 1152 def autoincrementing_primary_key 1153 primary_key 1154 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 1160 def cancel_action(msg=nil) 1161 raise_hook_failure(msg) 1162 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 1171 def changed_columns 1172 _changed_columns 1173 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 1180 def delete 1181 raise Sequel::Error, "can't delete frozen object" if frozen? 1182 _delete 1183 self 1184 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 1192 def destroy(opts = OPTS) 1193 raise Sequel::Error, "can't destroy frozen object" if frozen? 1194 checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 1195 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 1202 def each(&block) 1203 @values.each(&block) 1204 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 1211 def eql?(obj) 1212 (obj.class == model) && (obj.values == @values) 1213 end
Returns the validation errors associated with this object. See Errors
.
# File lib/sequel/model/base.rb 1217 def errors 1218 @errors ||= errors_class.new 1219 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 1231 def exists? 1232 new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil? 1233 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 1237 def extend(mod) 1238 @singleton_setter_added = true 1239 super 1240 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 1245 def freeze 1246 values.freeze 1247 _changed_columns.freeze 1248 unless errors.frozen? 1249 validate 1250 errors.freeze 1251 end 1252 this if !new? && model.primary_key 1253 super 1254 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 1263 def hash 1264 case primary_key 1265 when Array 1266 [model, !pk.all? ? @values : pk].hash 1267 when Symbol 1268 [model, pk.nil? ? @values : pk].hash 1269 else 1270 [model, @values].hash 1271 end 1272 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 1278 def id 1279 @values[:id] 1280 end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb 1284 def inspect 1285 "#<#{model.name} @values=#{inspect_values}>" 1286 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 1293 def keys 1294 @values.keys 1295 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 1320 def lock!(style=:update) 1321 _refresh(this.lock_style(style)) unless new? 1322 self 1323 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 1330 def marshallable! 1331 @this = nil 1332 self 1333 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 1350 def modified!(column=nil) 1351 _add_changed_column(column) if column 1352 @modified = true 1353 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 1370 def modified?(column=nil) 1371 if column 1372 changed_columns.include?(column) 1373 else 1374 @modified || !changed_columns.empty? 1375 end 1376 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 1382 def new? 1383 defined?(@new) ? @new : (@new = false) 1384 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 1392 def pk 1393 raise(Error, "No primary key is associated with this model") unless key = primary_key 1394 if key.is_a?(Array) 1395 vals = @values 1396 key.map{|k| vals[k]} 1397 else 1398 @values[key] 1399 end 1400 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 1406 def pk_hash 1407 model.primary_key_hash(pk) 1408 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 1416 def qualified_pk_hash(qualifier=model.table_name) 1417 model.qualified_primary_key_hash(pk, qualifier) 1418 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 1428 def refresh 1429 raise Sequel::Error, "can't refresh frozen object" if frozen? 1430 _refresh(this) 1431 self 1432 end
Alias of refresh, but not aliased directly to make overriding in a plugin easier.
# File lib/sequel/model/base.rb 1435 def reload 1436 refresh 1437 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 1464 def save(opts=OPTS) 1465 raise Sequel::Error, "can't save frozen object" if frozen? 1466 set_server(opts[:server]) if opts[:server] 1467 unless _save_valid?(opts) 1468 raise(validation_failed_error) if raise_on_failure?(opts) 1469 return 1470 end 1471 checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 1472 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 1483 def save_changes(opts=OPTS) 1484 save(Hash[opts].merge!(:changed=>true)) || false if modified? 1485 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 1494 def set(hash) 1495 set_restricted(hash, :default) 1496 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 1524 def set_fields(hash, fields, opts=nil) 1525 opts = if opts 1526 model.default_set_fields_options.merge(opts) 1527 else 1528 model.default_set_fields_options 1529 end 1530 1531 case missing = opts[:missing] 1532 when :skip, :raise 1533 do_raise = true if missing == :raise 1534 fields.each do |f| 1535 if hash.has_key?(f) 1536 set_column_value("#{f}=", hash[f]) 1537 elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1538 set_column_value("#{sf}=", hash[sf]) 1539 elsif do_raise 1540 raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1541 end 1542 end 1543 else 1544 fields.each{|f| set_column_value("#{f}=", hash[f])} 1545 end 1546 self 1547 end
Set the shard that this object is tied to. Returns self.
# File lib/sequel/model/base.rb 1550 def set_server(s) 1551 @server = s 1552 @this = @this.server(s) if @this 1553 self 1554 end
Clear the setter_methods
cache when a method is added
# File lib/sequel/model/base.rb 1557 def singleton_method_added(meth) 1558 @singleton_setter_added = true if meth.to_s.end_with?('=') 1559 super 1560 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 1567 def skip_validation_on_next_save! 1568 @skip_validation_on_next_save = true 1569 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 1575 def this 1576 return @this if @this 1577 raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1578 @this = use_server(ds.where(pk_hash)) 1579 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 1584 def update(hash) 1585 update_restricted(hash, :default) 1586 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 1596 def update_fields(hash, fields, opts=nil) 1597 set_fields(hash, fields, opts) 1598 save_changes 1599 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 1615 def valid?(opts = OPTS) 1616 begin 1617 _valid?(opts) 1618 rescue HookFailed 1619 false 1620 end 1621 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 1607 def validate 1608 end
Private Instance Methods
Add a column as a changed column.
# File lib/sequel/model/base.rb 1626 def _add_changed_column(column) 1627 cc = _changed_columns 1628 cc << column unless cc.include?(column) 1629 end
Internal changed_columns
method that just returns stored array.
# File lib/sequel/model/base.rb 1632 def _changed_columns 1633 @changed_columns ||= [] 1634 end
Clear the changed columns. Reason is the reason for clearing the columns, and should be one of: :initialize, :refresh, :create or :update.
# File lib/sequel/model/base.rb 1639 def _clear_changed_columns(_reason) 1640 _changed_columns.clear 1641 end
Do the deletion of the object's dataset, and check that the row was actually deleted.
# File lib/sequel/model/base.rb 1645 def _delete 1646 n = _delete_without_checking 1647 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 1648 n 1649 end
The dataset to use when deleting the object. The same as the object's dataset by default.
# File lib/sequel/model/base.rb 1653 def _delete_dataset 1654 this 1655 end
Actually do the deletion of the object's dataset. Return the number of rows modified.
# File lib/sequel/model/base.rb 1659 def _delete_without_checking 1660 if sql = (m = model).fast_instance_delete_sql 1661 sql = sql.dup 1662 ds = use_server(m.dataset) 1663 ds.literal_append(sql, pk) 1664 ds.with_sql_delete(sql) 1665 else 1666 _delete_dataset.delete 1667 end 1668 end
Internal destroy method, separted from destroy to allow running inside a transaction
# File lib/sequel/model/base.rb 1672 def _destroy(opts) 1673 called = false 1674 around_destroy do 1675 called = true 1676 before_destroy 1677 _destroy_delete 1678 after_destroy 1679 end 1680 raise_hook_failure(:around_destroy) unless called 1681 self 1682 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 1687 def _destroy_delete 1688 delete 1689 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 1693 def _insert 1694 ds = _insert_dataset 1695 if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil? 1696 _save_set_values(h) if h 1697 nil 1698 else 1699 iid = _insert_raw(ds) 1700 # if we have a regular primary key and it's not set in @values, 1701 # we assume it's the last inserted id 1702 if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk] 1703 vals[pk] = iid 1704 end 1705 pk 1706 end 1707 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 1711 def _insert_dataset 1712 use_server(model.instance_dataset) 1713 end
Insert into the given dataset and return the primary key created (if any).
# File lib/sequel/model/base.rb 1716 def _insert_raw(ds) 1717 ds.insert(_insert_values) 1718 end
Insert into the given dataset and return the hash of column values.
# File lib/sequel/model/base.rb 1721 def _insert_select_raw(ds) 1722 ds.insert_select(_insert_values) 1723 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 1731 def _refresh(dataset) 1732 _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found")) 1733 _clear_changed_columns(:refresh) 1734 end
Get the row of column data from the database.
# File lib/sequel/model/base.rb 1737 def _refresh_get(dataset) 1738 if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock] 1739 sql = sql.dup 1740 ds = use_server(dataset) 1741 ds.literal_append(sql, pk) 1742 ds.with_sql_first(sql) 1743 else 1744 dataset.first 1745 end 1746 end
Set the values to the given hash after refreshing.
# File lib/sequel/model/base.rb 1749 def _refresh_set_values(h) 1750 @values = h 1751 end
Internal version of save, split from save to allow running inside it's own transaction.
# File lib/sequel/model/base.rb 1755 def _save(opts) 1756 pk = nil 1757 called_save = false 1758 called_cu = false 1759 around_save do 1760 called_save = true 1761 before_save 1762 1763 if new? 1764 around_create do 1765 called_cu = true 1766 before_create 1767 pk = _insert 1768 @this = nil 1769 @new = false 1770 @modified = false 1771 pk ? _save_refresh : _clear_changed_columns(:create) 1772 after_create 1773 true 1774 end 1775 raise_hook_failure(:around_create) unless called_cu 1776 else 1777 around_update do 1778 called_cu = true 1779 before_update 1780 columns = opts[:columns] 1781 if columns.nil? 1782 columns_updated = if opts[:changed] 1783 _save_update_changed_colums_hash 1784 else 1785 _save_update_all_columns_hash 1786 end 1787 _clear_changed_columns(:update) 1788 else # update only the specified columns 1789 columns = Array(columns) 1790 columns_updated = @values.reject{|k, v| !columns.include?(k)} 1791 _changed_columns.reject!{|c| columns.include?(c)} 1792 end 1793 _update_columns(columns_updated) 1794 @this = nil 1795 @modified = false 1796 after_update 1797 true 1798 end 1799 raise_hook_failure(:around_update) unless called_cu 1800 end 1801 after_save 1802 true 1803 end 1804 raise_hook_failure(:around_save) unless called_save 1805 self 1806 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 1811 def _save_refresh 1812 _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found")) 1813 _clear_changed_columns(:create) 1814 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 1818 def _save_set_values(h) 1819 @values = h 1820 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 1828 def _save_update_all_columns_hash 1829 v = Hash[@values] 1830 cc = changed_columns 1831 Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)} 1832 v 1833 end
Return a hash of values used when saving changed columns of an existing object. Defaults to all of the objects current values that are recorded as modified.
# File lib/sequel/model/base.rb 1838 def _save_update_changed_colums_hash 1839 cc = changed_columns 1840 @values.reject{|k,v| !cc.include?(k)} 1841 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 1847 def _save_valid?(opts) 1848 if @skip_validation_on_next_save 1849 @skip_validation_on_next_save = false 1850 return true 1851 end 1852 1853 checked_save_failure(opts){_valid?(opts)} 1854 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 1865 def _update(columns) 1866 n = _update_without_checking(columns) 1867 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 1868 n 1869 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 1859 def _update_columns(columns) 1860 _update(columns) unless columns.empty? 1861 end
The dataset to use when updating an object. The same as the object's dataset by default.
# File lib/sequel/model/base.rb 1873 def _update_dataset 1874 this 1875 end
Update this instances dataset with the supplied column hash.
# File lib/sequel/model/base.rb 1878 def _update_without_checking(columns) 1879 _update_dataset.update(columns) 1880 end
Whether to use insert_select when inserting a new row.
# File lib/sequel/model/base.rb 1883 def _use_insert_select?(ds) 1884 (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 1885 end
Internal validation method, running validation hooks.
# File lib/sequel/model/base.rb 1888 def _valid?(opts) 1889 return errors.empty? if frozen? 1890 errors.clear 1891 called = false 1892 skip_validate = opts[:validate] == false 1893 around_validation do 1894 called = true 1895 before_validation 1896 validate unless skip_validate 1897 after_validation 1898 end 1899 1900 return true if skip_validate 1901 1902 if called 1903 errors.empty? 1904 else 1905 raise_hook_failure(:around_validation) 1906 end 1907 end
Change the value of the column to given value, recording the change.
# File lib/sequel/model/base.rb 1929 def change_column_value(column, value) 1930 _add_changed_column(column) 1931 @values[column] = value 1932 end
If not raising on failure, check for HookFailed
being raised by yielding and swallow it.
# File lib/sequel/model/base.rb 1911 def checked_save_failure(opts) 1912 if raise_on_failure?(opts) 1913 yield 1914 else 1915 begin 1916 yield 1917 rescue HookFailed 1918 nil 1919 end 1920 end 1921 end
If transactions should be used, wrap the yield in a transaction block.
# File lib/sequel/model/base.rb 1924 def checked_transaction(opts=OPTS) 1925 use_transaction?(opts) ? db.transaction({:server=>this_server}.merge!(opts)){yield} : yield 1926 end
Default error class used for errors.
# File lib/sequel/model/base.rb 1935 def errors_class 1936 Errors 1937 end
A HookFailed
exception for the given message tied to the current instance.
# File lib/sequel/model/base.rb 1940 def hook_failed_error(msg) 1941 HookFailed.new(msg, self) 1942 end
Clone constructor – freeze internal data structures if the original's are frozen.
# File lib/sequel/model/base.rb 1946 def initialize_clone(other) 1947 super 1948 freeze if other.frozen? 1949 self 1950 end
Copy constructor – Duplicate internal data structures.
# File lib/sequel/model/base.rb 1953 def initialize_copy(other) 1954 super 1955 @values = Hash[@values] 1956 @changed_columns = @changed_columns.dup if @changed_columns 1957 @errors = @errors.dup if @errors 1958 self 1959 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 1964 def initialize_set(h) 1965 set(h) unless h.empty? 1966 end
Default inspection output for the values hash, overwrite to change what inspect
displays.
# File lib/sequel/model/base.rb 1969 def inspect_values 1970 @values.inspect 1971 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 1983 def raise_hook_failure(type=nil) 1984 msg = case type 1985 when String 1986 type 1987 when Symbol 1988 "the #{type} hook failed" 1989 else 1990 "a hook failed" 1991 end 1992 1993 raise hook_failed_error(msg) 1994 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 1977 def raise_on_failure?(opts) 1978 opts.fetch(:raise_on_failure, raise_on_save_failure) 1979 end
Get the ruby class or classes related to the given column's type.
# File lib/sequel/model/base.rb 1997 def schema_type_class(column) 1998 if (sch = db_schema[column]) && (type = sch[:type]) 1999 db.schema_type_class(type) 2000 end 2001 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 2005 def set_restricted(hash, type) 2006 return self if hash.empty? 2007 meths = setter_methods(type) 2008 strict = strict_param_setting 2009 hash.each do |k,v| 2010 m = "#{k}=" 2011 if meths.include?(m) 2012 set_column_value(m, v) 2013 elsif strict 2014 # Avoid using respond_to? or creating symbols from user input 2015 if public_methods.map(&:to_s).include?(m) 2016 if Array(model.primary_key).map(&:to_s).member?(k.to_s) && model.restrict_primary_key? 2017 raise MassAssignmentRestriction, "#{k} is a restricted primary key" 2018 else 2019 raise MassAssignmentRestriction, "#{k} is a restricted column" 2020 end 2021 else 2022 raise MassAssignmentRestriction, "method #{m} doesn't exist" 2023 end 2024 end 2025 end 2026 self 2027 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 2035 def setter_methods(type) 2036 if type == :default && !@singleton_setter_added 2037 return model.setter_methods 2038 end 2039 2040 meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS 2041 meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key? 2042 meths 2043 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 2047 def this_server 2048 if (s = @server) 2049 s 2050 elsif (t = @this) 2051 t.opts[:server] || :default 2052 else 2053 model.dataset.opts[:server] || :default 2054 end 2055 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 2060 def typecast_value(column, value) 2061 return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column]) 2062 value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type]) 2063 raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false) 2064 begin 2065 model.db.typecast_value(col_schema[:type], value) 2066 rescue InvalidValue 2067 raise_on_typecast_failure ? raise : value 2068 end 2069 end
Set the columns, filtered by the only and except arrays.
# File lib/sequel/model/base.rb 2072 def update_restricted(hash, type) 2073 set_restricted(hash, type) 2074 save_changes 2075 end
Set the given dataset to use the current object's shard.
# File lib/sequel/model/base.rb 2078 def use_server(ds) 2079 @server ? ds.server(@server) : ds 2080 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 2085 def use_transaction?(opts = OPTS) 2086 opts.fetch(:transaction, use_transactions) 2087 end
An ValidationFailed
exception instance to raise for this instance.
# File lib/sequel/model/base.rb 2090 def validation_failed_error 2091 ValidationFailed.new(self) 2092 end