module Sequel::Model::InstanceMethods

Sequel::Model instance methods that implement basic model functionality.

Attributes

_insert_values[R]

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', ...}
to_hash[R]

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', ...}
values[R]

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

new(values = OPTS) { |self| ... } click to toggle source

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
1099 def initialize(values = OPTS)
1100   @values = {}
1101   @new = true
1102   @modified = true
1103   initialize_set(values)
1104   _clear_changed_columns(:initialize)
1105   yield self if defined?(yield)
1106 end

Public Instance Methods

==(obj) click to toggle source

Alias of eql?

     # File lib/sequel/model/base.rb
1136 def ==(obj)
1137   eql?(obj)
1138 end
===(obj) click to toggle source

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
1146 def ===(obj)
1147   case pkv = pk
1148   when nil
1149     return false
1150   when Array
1151     return false if pkv.any?(&:nil?)
1152   end
1153 
1154   (obj.class == model) && (obj.pk == pkv)
1155 end
Also aliased as: pk_equal?
[](column) click to toggle source

Returns value of the column's attribute.

Artist[1][:id] #=> 1
     # File lib/sequel/model/base.rb
1111 def [](column)
1112   @values[column]
1113 end
[]=(column, value) click to toggle source

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
1123 def []=(column, value)
1124   # If it is new, it doesn't have a value yet, so we should
1125   # definitely set the new value.
1126   # If the column isn't in @values, we can't assume it is
1127   # NULL in the database, so assume it has changed.
1128   v = typecast_value(column, value)
1129   vals = @values
1130   if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
1131     change_column_value(column, v)
1132   end
1133 end
autoincrementing_primary_key() click to toggle source

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
1178 def autoincrementing_primary_key
1179   primary_key
1180 end
cancel_action(msg=nil) click to toggle source

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
1186 def cancel_action(msg=nil)
1187   raise_hook_failure(msg)
1188 end
changed_columns() click to toggle source

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
1197 def changed_columns
1198   _changed_columns
1199 end
delete() click to toggle source

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
1206 def delete
1207   raise Sequel::Error, "can't delete frozen object" if frozen?
1208   _delete
1209   self
1210 end
destroy(opts = OPTS) click to toggle source

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
1218 def destroy(opts = OPTS)
1219   raise Sequel::Error, "can't destroy frozen object" if frozen?
1220   checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
1221 end
each(&block) click to toggle source

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
1228 def each(&block)
1229   @values.each(&block)
1230 end
eql?(obj) click to toggle source

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
1237 def eql?(obj)
1238   (obj.class == model) && (obj.values == @values)
1239 end
errors() click to toggle source

Returns the validation errors associated with this object. See Errors.

     # File lib/sequel/model/base.rb
1243 def errors
1244   @errors ||= errors_class.new
1245 end
exists?() click to toggle source

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
1257 def exists?
1258   new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
1259 end
extend(mod) click to toggle source

Ignore the model's setter method cache when this instances extends a module, as the module may contain setter methods.

Calls superclass method
     # File lib/sequel/model/base.rb
1263 def extend(mod)
1264   @singleton_setter_added = true
1265   super
1266 end
freeze() click to toggle source

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.

Calls superclass method
     # File lib/sequel/model/base.rb
1271 def freeze
1272   unless errors.frozen?
1273     validate
1274     errors.freeze
1275   end
1276   values.freeze
1277   _changed_columns.freeze
1278   this if !new? && model.primary_key
1279   super
1280 end
hash() click to toggle source

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
1289 def hash
1290   case primary_key
1291   when Array
1292     [model, !pk.all? ? @values : pk].hash
1293   when Symbol
1294     [model, pk.nil? ? @values : pk].hash
1295   else
1296     [model, @values].hash
1297   end
1298 end
id() click to toggle source

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
1304 def id
1305   @values[:id]
1306 end
inspect() click to toggle source

Returns a string representation of the model instance including the class name and values.

     # File lib/sequel/model/base.rb
1310 def inspect
1311   "#<#{model.name} @values=#{inspect_values}>"
1312 end
keys() click to toggle source

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
1319 def keys
1320   @values.keys
1321 end
lock!(style=:update) click to toggle source

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
1346 def lock!(style=:update)
1347   _refresh(this.lock_style(style)) unless new?
1348   self
1349 end
marshallable!() click to toggle source

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
1356 def marshallable!
1357   @this = nil
1358   self
1359 end
modified!(column=nil) click to toggle source

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
1376 def modified!(column=nil)
1377   _add_changed_column(column) if column
1378   @modified = true
1379 end
modified?(column=nil) click to toggle source

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
1396 def modified?(column=nil)
1397   if column
1398     changed_columns.include?(column)
1399   else
1400     @modified || !changed_columns.empty?
1401   end
1402 end
new?() click to toggle source

Returns true if the current instance represents a new record.

Artist.new.new? # => true
Artist[1].new? # => false
     # File lib/sequel/model/base.rb
1408 def new?
1409   defined?(@new) ? @new : (@new = false)
1410 end
pk() click to toggle source

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
1418 def pk
1419   raise(Error, "No primary key is associated with this model") unless key = primary_key
1420   if key.is_a?(Array)
1421     vals = @values
1422     key.map{|k| vals[k]}
1423   else
1424     @values[key]
1425   end
1426 end
pk_equal?(obj)

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
Alias for: ===
pk_hash() click to toggle source

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
1432 def pk_hash
1433   model.primary_key_hash(pk)
1434 end
qualified_pk_hash(qualifier=model.table_name) click to toggle source

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
1442 def qualified_pk_hash(qualifier=model.table_name)
1443   model.qualified_primary_key_hash(pk, qualifier)
1444 end
refresh() click to toggle source

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
1454 def refresh
1455   raise Sequel::Error, "can't refresh frozen object" if frozen?
1456   _refresh(this)
1457   self
1458 end
reload() click to toggle source

Alias of refresh, but not aliased directly to make overriding in a plugin easier.

     # File lib/sequel/model/base.rb
1461 def reload
1462   refresh
1463 end
save(opts=OPTS) click to toggle source

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
1490 def save(opts=OPTS)
1491   raise Sequel::Error, "can't save frozen object" if frozen?
1492   set_server(opts[:server]) if opts[:server] 
1493   unless _save_valid?(opts)
1494     raise(validation_failed_error) if raise_on_failure?(opts)
1495     return
1496   end
1497   checked_save_failure(opts){checked_transaction(opts){_save(opts)}}
1498 end
save_changes(opts=OPTS) click to toggle source

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
1509 def save_changes(opts=OPTS)
1510   save(Hash[opts].merge!(:changed=>true)) || false if modified? 
1511 end
set(hash) click to toggle source

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
1520 def set(hash)
1521   set_restricted(hash, :default)
1522 end
set_fields(hash, fields, opts=nil) click to toggle source

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
1550 def set_fields(hash, fields, opts=nil)
1551   opts = if opts
1552     model.default_set_fields_options.merge(opts)
1553   else
1554     model.default_set_fields_options
1555   end
1556 
1557   case missing = opts[:missing]
1558   when :skip, :raise
1559     do_raise = true if missing == :raise
1560     fields.each do |f|
1561       if hash.has_key?(f) 
1562         set_column_value("#{f}=", hash[f])
1563       elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1564         set_column_value("#{sf}=", hash[sf])
1565       elsif do_raise
1566         raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
1567       end
1568     end
1569   else
1570     fields.each{|f| set_column_value("#{f}=", hash[f])}
1571   end
1572   self
1573 end
set_server(s) click to toggle source

Set the shard that this object is tied to. Returns self.

     # File lib/sequel/model/base.rb
1576 def set_server(s)
1577   @server = s
1578   @this = @this.server(s) if @this
1579   self
1580 end
singleton_method_added(meth) click to toggle source

Clear the setter_methods cache when a method is added

Calls superclass method
     # File lib/sequel/model/base.rb
1583 def singleton_method_added(meth)
1584   @singleton_setter_added = true if meth.to_s.end_with?('=')
1585   super
1586 end
skip_validation_on_next_save!() click to toggle source

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
1593 def skip_validation_on_next_save!
1594   @skip_validation_on_next_save = true
1595 end
this() click to toggle source

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
1601 def this
1602   return @this if @this
1603   raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset
1604   @this = use_server(ds.where(pk_hash))
1605 end
update(hash) click to toggle source

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
1610 def update(hash)
1611   update_restricted(hash, :default)
1612 end
update_fields(hash, fields, opts=nil) click to toggle source

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
1622 def update_fields(hash, fields, opts=nil)
1623   set_fields(hash, fields, opts)
1624   save_changes
1625 end
valid?(opts = OPTS) click to toggle source

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
1641 def valid?(opts = OPTS)
1642   _valid?(opts)
1643 rescue HookFailed
1644   false
1645 end
validate() click to toggle source

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
1633 def validate
1634 end

Private Instance Methods

_add_changed_column(column) click to toggle source

Add a column as a changed column.

     # File lib/sequel/model/base.rb
1650 def _add_changed_column(column)
1651   cc = _changed_columns
1652   cc << column unless cc.include?(column)
1653 end
_changed_columns() click to toggle source

Internal changed_columns method that just returns stored array.

     # File lib/sequel/model/base.rb
1656 def _changed_columns
1657   @changed_columns ||= []
1658 end
_clear_changed_columns(_reason) click to toggle source

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
1663 def _clear_changed_columns(_reason)
1664   _changed_columns.clear
1665 end
_delete() click to toggle source

Do the deletion of the object's dataset, and check that the row was actually deleted.

     # File lib/sequel/model/base.rb
1669 def _delete
1670   n = _delete_without_checking
1671   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
1672   n
1673 end
_delete_dataset() click to toggle source

The dataset to use when deleting the object. The same as the object's dataset by default.

     # File lib/sequel/model/base.rb
1677 def _delete_dataset
1678   this
1679 end
_delete_without_checking() click to toggle source

Actually do the deletion of the object's dataset. Return the number of rows modified.

     # File lib/sequel/model/base.rb
1683 def _delete_without_checking
1684   if sql = (m = model).fast_instance_delete_sql
1685     sql = sql.dup
1686     ds = use_server(m.dataset)
1687     ds.literal_append(sql, pk)
1688     ds.with_sql_delete(sql)
1689   else
1690     _delete_dataset.delete 
1691   end
1692 end
_destroy(opts) click to toggle source

Internal destroy method, separted from destroy to allow running inside a transaction

     # File lib/sequel/model/base.rb
1696 def _destroy(opts)
1697   called = false
1698   around_destroy do
1699     called = true
1700     before_destroy
1701     _destroy_delete
1702     after_destroy
1703   end
1704   raise_hook_failure(:around_destroy) unless called
1705   self
1706 end
_destroy_delete() click to toggle source

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
1711 def _destroy_delete
1712   delete
1713 end
_insert() click to toggle source

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
1717 def _insert
1718   ds = _insert_dataset
1719   if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil?
1720     _save_set_values(h) if h
1721     nil
1722   else
1723     iid = _insert_raw(ds)
1724     # if we have a regular primary key and it's not set in @values,
1725     # we assume it's the last inserted id
1726     if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk]
1727       vals[pk] = iid
1728     end
1729     pk
1730   end
1731 end
_insert_dataset() click to toggle source

The dataset to use when inserting a new object. The same as the model's dataset by default.

     # File lib/sequel/model/base.rb
1735 def _insert_dataset
1736   use_server(model.instance_dataset)
1737 end
_insert_raw(ds) click to toggle source

Insert into the given dataset and return the primary key created (if any).

     # File lib/sequel/model/base.rb
1740 def _insert_raw(ds)
1741   ds.insert(_insert_values)
1742 end
_insert_select_raw(ds) click to toggle source

Insert into the given dataset and return the hash of column values.

     # File lib/sequel/model/base.rb
1745 def _insert_select_raw(ds)
1746   ds.insert_select(_insert_values)
1747 end
_refresh(dataset) click to toggle source

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
1755 def _refresh(dataset)
1756   _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found"))
1757   _clear_changed_columns(:refresh)
1758 end
_refresh_get(dataset) click to toggle source

Get the row of column data from the database.

     # File lib/sequel/model/base.rb
1761 def _refresh_get(dataset)
1762   if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock]
1763     sql = sql.dup
1764     ds = use_server(dataset)
1765     ds.literal_append(sql, pk)
1766     ds.with_sql_first(sql)
1767   else
1768     dataset.first
1769   end
1770 end
_refresh_set_values(h) click to toggle source

Set the values to the given hash after refreshing.

     # File lib/sequel/model/base.rb
1773 def _refresh_set_values(h)
1774   @values = h
1775 end
_save(opts) click to toggle source

Internal version of save, split from save to allow running inside it's own transaction.

     # File lib/sequel/model/base.rb
1779 def _save(opts)
1780   pk = nil
1781   called_save = false
1782   called_cu = false
1783   around_save do
1784     called_save = true
1785     before_save
1786 
1787     if new?
1788       around_create do
1789         called_cu = true
1790         before_create
1791         pk = _insert
1792         @this = nil
1793         @new = false
1794         @modified = false
1795         pk ? _save_refresh : _clear_changed_columns(:create)
1796         after_create
1797         true
1798       end
1799       raise_hook_failure(:around_create) unless called_cu
1800     else
1801       around_update do
1802         called_cu = true
1803         before_update
1804         columns = opts[:columns]
1805         if columns.nil?
1806           columns_updated = if opts[:changed]
1807             _save_update_changed_colums_hash
1808           else
1809             _save_update_all_columns_hash
1810           end
1811           _clear_changed_columns(:update)
1812         else # update only the specified columns
1813           columns = Array(columns)
1814           columns_updated = @values.reject{|k, v| !columns.include?(k)}
1815           _changed_columns.reject!{|c| columns.include?(c)}
1816         end
1817         _update_columns(columns_updated)
1818         @this = nil
1819         @modified = false
1820         after_update
1821         true
1822       end
1823       raise_hook_failure(:around_update) unless called_cu
1824     end
1825     after_save
1826     true
1827   end
1828   raise_hook_failure(:around_save) unless called_save
1829   self
1830 end
_save_refresh() click to toggle source

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
1835 def _save_refresh
1836   _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found"))
1837   _clear_changed_columns(:create)
1838 end
_save_set_values(h) click to toggle source

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
1842 def _save_set_values(h)
1843   @values = h
1844 end
_save_update_all_columns_hash() click to toggle source

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
1852 def _save_update_all_columns_hash
1853   v = Hash[@values]
1854   cc = changed_columns
1855   Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)}
1856   v
1857 end
_save_update_changed_colums_hash() click to toggle source

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
1862 def _save_update_changed_colums_hash
1863   cc = changed_columns
1864   @values.reject{|k,v| !cc.include?(k)}
1865 end
_save_valid?(opts) click to toggle source

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
1871 def _save_valid?(opts)
1872   if @skip_validation_on_next_save
1873     @skip_validation_on_next_save = false
1874     return true
1875   end
1876 
1877   checked_save_failure(opts){_valid?(opts)}
1878 end
_update(columns) click to toggle source

Update this instance's dataset with the supplied column hash, checking that only a single row was modified.

     # File lib/sequel/model/base.rb
1889 def _update(columns)
1890   n = _update_without_checking(columns)
1891   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
1892   n
1893 end
_update_columns(columns) click to toggle source

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
1883 def _update_columns(columns)
1884   _update(columns) unless columns.empty?
1885 end
_update_dataset() click to toggle source

The dataset to use when updating an object. The same as the object's dataset by default.

     # File lib/sequel/model/base.rb
1897 def _update_dataset
1898   this
1899 end
_update_without_checking(columns) click to toggle source

Update this instances dataset with the supplied column hash.

     # File lib/sequel/model/base.rb
1902 def _update_without_checking(columns)
1903   _update_dataset.update(columns)
1904 end
_use_insert_select?(ds) click to toggle source

Whether to use insert_select when inserting a new row.

     # File lib/sequel/model/base.rb
1907 def _use_insert_select?(ds)
1908   (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 
1909 end
_valid?(opts) click to toggle source

Internal validation method, running validation hooks.

     # File lib/sequel/model/base.rb
1912 def _valid?(opts)
1913   return errors.empty? if frozen?
1914   errors.clear
1915   called = false
1916   skip_validate = opts[:validate] == false
1917   around_validation do
1918     called = true
1919     before_validation
1920     validate unless skip_validate
1921     after_validation
1922   end
1923 
1924   return true if skip_validate
1925 
1926   if called
1927     errors.empty?
1928   else
1929     raise_hook_failure(:around_validation)
1930   end
1931 end
change_column_value(column, value) click to toggle source

Change the value of the column to given value, recording the change.

     # File lib/sequel/model/base.rb
1953 def change_column_value(column, value)
1954   _add_changed_column(column)
1955   @values[column] = value
1956 end
checked_save_failure(opts) { || ... } click to toggle source

If not raising on failure, check for HookFailed being raised by yielding and swallow it.

     # File lib/sequel/model/base.rb
1935 def checked_save_failure(opts)
1936   if raise_on_failure?(opts)
1937     yield
1938   else
1939     begin
1940       yield
1941     rescue HookFailed 
1942       nil
1943     end
1944   end
1945 end
checked_transaction(opts=OPTS) { || ... } click to toggle source

If transactions should be used, wrap the yield in a transaction block.

     # File lib/sequel/model/base.rb
1948 def checked_transaction(opts=OPTS)
1949   use_transaction?(opts) ? db.transaction({:server=>this_server}.merge!(opts)){yield} : yield
1950 end
errors_class() click to toggle source

Default error class used for errors.

     # File lib/sequel/model/base.rb
1959 def errors_class
1960   Errors
1961 end
hook_failed_error(msg) click to toggle source

A HookFailed exception for the given message tied to the current instance.

     # File lib/sequel/model/base.rb
1964 def hook_failed_error(msg)
1965   HookFailed.new(msg, self)
1966 end
initialize_clone(other) click to toggle source

Clone constructor – freeze internal data structures if the original's are frozen.

Calls superclass method
     # File lib/sequel/model/base.rb
1970 def initialize_clone(other)
1971   super
1972   freeze if other.frozen?
1973   self
1974 end
initialize_copy(other) click to toggle source

Copy constructor – Duplicate internal data structures.

Calls superclass method
     # File lib/sequel/model/base.rb
1977 def initialize_copy(other)
1978   super
1979   @values = Hash[@values]
1980   @changed_columns = @changed_columns.dup if @changed_columns
1981   @errors = @errors.dup if @errors
1982   self
1983 end
initialize_set(h) click to toggle source

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
1988 def initialize_set(h)
1989   set(h) unless h.empty?
1990 end
inspect_values() click to toggle source

Default inspection output for the values hash, overwrite to change what inspect displays.

     # File lib/sequel/model/base.rb
1993 def inspect_values
1994   @values.inspect
1995 end
raise_hook_failure(type=nil) click to toggle source

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
2007 def raise_hook_failure(type=nil)
2008   msg = case type
2009   when String
2010     type
2011   when Symbol
2012     "the #{type} hook failed"
2013   else
2014     "a hook failed"
2015   end
2016 
2017   raise hook_failed_error(msg)
2018 end
raise_on_failure?(opts) click to toggle source

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
2001 def raise_on_failure?(opts)
2002   opts.fetch(:raise_on_failure, raise_on_save_failure)
2003 end
schema_type_class(column) click to toggle source

Get the ruby class or classes related to the given column's type.

     # File lib/sequel/model/base.rb
2021 def schema_type_class(column)
2022   if (sch = db_schema[column]) && (type = sch[:type])
2023     db.schema_type_class(type)
2024   end
2025 end
set_restricted(hash, type) click to toggle source

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
2029 def set_restricted(hash, type)
2030   return self if hash.empty?
2031   meths = setter_methods(type)
2032   strict = strict_param_setting
2033   hash.each do |k,v|
2034     m = "#{k}="
2035     if meths.include?(m)
2036       set_column_value(m, v)
2037     elsif strict
2038       # Avoid using respond_to? or creating symbols from user input
2039       if public_methods.map(&:to_s).include?(m)
2040         if Array(model.primary_key).map(&:to_s).member?(k.to_s) && model.restrict_primary_key?
2041           raise MassAssignmentRestriction, "#{k} is a restricted primary key"
2042         else
2043           raise MassAssignmentRestriction, "#{k} is a restricted column"
2044         end
2045       else
2046         raise MassAssignmentRestriction, "method #{m} doesn't exist"
2047       end
2048     end
2049   end
2050   self
2051 end
setter_methods(type) click to toggle source

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
2059 def setter_methods(type)
2060   if type == :default && !@singleton_setter_added
2061     return model.setter_methods
2062   end
2063 
2064   meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS
2065   meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key?
2066   meths
2067 end
this_server() click to toggle source

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
2071 def this_server
2072   if (s = @server)
2073     s
2074   elsif (t = @this)
2075     t.opts[:server] || :default
2076   else
2077     model.dataset.opts[:server] || :default
2078   end
2079 end
typecast_value(column, value) click to toggle source

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
2084 def typecast_value(column, value)
2085   return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column])
2086   value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type])
2087   raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false)
2088   begin
2089     model.db.typecast_value(col_schema[:type], value)
2090   rescue InvalidValue
2091     raise_on_typecast_failure ? raise : value
2092   end
2093 end
update_restricted(hash, type) click to toggle source

Set the columns, filtered by the only and except arrays.

     # File lib/sequel/model/base.rb
2096 def update_restricted(hash, type)
2097   set_restricted(hash, type)
2098   save_changes
2099 end
use_server(ds) click to toggle source

Set the given dataset to use the current object's shard.

     # File lib/sequel/model/base.rb
2102 def use_server(ds)
2103   @server ? ds.server(@server) : ds
2104 end
use_transaction?(opts = OPTS) click to toggle source

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
2109 def use_transaction?(opts = OPTS)
2110   opts.fetch(:transaction, use_transactions)
2111 end
validation_failed_error() click to toggle source

An ValidationFailed exception instance to raise for this instance.

     # File lib/sequel/model/base.rb
2114 def validation_failed_error
2115   ValidationFailed.new(self)
2116 end