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
1067 def initialize(values = OPTS)
1068   @values = {}
1069   @new = true
1070   @modified = true
1071   initialize_set(values)
1072   _clear_changed_columns(:initialize)
1073   yield self if block_given?
1074 end

Public Instance Methods

==(obj) click to toggle source

Alias of eql?

     # File lib/sequel/model/base.rb
1104 def ==(obj)
1105   eql?(obj)
1106 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
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
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
1079 def [](column)
1080   @values[column]
1081 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
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
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
1146 def autoincrementing_primary_key
1147   primary_key
1148 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
1154 def cancel_action(msg=nil)
1155   raise_hook_failure(msg)
1156 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
1165 def changed_columns
1166   _changed_columns
1167 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
1174 def delete
1175   raise Sequel::Error, "can't delete frozen object" if frozen?
1176   _delete
1177   self
1178 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
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
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
1196 def each(&block)
1197   @values.each(&block)
1198 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
1205 def eql?(obj)
1206   (obj.class == model) && (obj.values == @values)
1207 end
errors() click to toggle source

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
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
1225 def exists?
1226   new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
1227 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
1231 def extend(mod)
1232   @singleton_setter_added = true
1233   super
1234 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
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
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
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
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
1272 def id
1273   @values[:id]
1274 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
1278 def inspect
1279   "#<#{model.name} @values=#{inspect_values}>"
1280 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
1287 def keys
1288   @values.keys
1289 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
1314 def lock!(style=:update)
1315   _refresh(this.lock_style(style)) unless new?
1316   self
1317 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
1324 def marshallable!
1325   @this = nil
1326   self
1327 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
1344 def modified!(column=nil)
1345   _add_changed_column(column) if column
1346   @modified = true
1347 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
1364 def modified?(column=nil)
1365   if column
1366     changed_columns.include?(column)
1367   else
1368     @modified || !changed_columns.empty?
1369   end
1370 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
1376 def new?
1377   defined?(@new) ? @new : (@new = false)
1378 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
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
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
1400 def pk_hash
1401   model.primary_key_hash(pk)
1402 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
1410 def qualified_pk_hash(qualifier=model.table_name)
1411   model.qualified_primary_key_hash(pk, qualifier)
1412 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
1422 def refresh
1423   raise Sequel::Error, "can't refresh frozen object" if frozen?
1424   _refresh(this)
1425   self
1426 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
1429 def reload
1430   refresh
1431 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
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
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
1477 def save_changes(opts=OPTS)
1478   save(Hash[opts].merge!(:changed=>true)) || false if modified? 
1479 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
1488 def set(hash)
1489   set_restricted(hash, :default)
1490 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
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_server(s) click to toggle source

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
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
1551 def singleton_method_added(meth)
1552   @singleton_setter_added = true if meth.to_s.end_with?('=')
1553   super
1554 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
1561 def skip_validation_on_next_save!
1562   @skip_validation_on_next_save = true
1563 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
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
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
1578 def update(hash)
1579   update_restricted(hash, :default)
1580 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
1590 def update_fields(hash, fields, opts=nil)
1591   set_fields(hash, fields, opts)
1592   save_changes
1593 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
1609 def valid?(opts = OPTS)
1610   begin
1611     _valid?(opts)
1612   rescue HookFailed
1613     false
1614   end
1615 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
1601 def validate
1602 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
1620 def _add_changed_column(column)
1621   cc = _changed_columns
1622   cc << column unless cc.include?(column)
1623 end
_changed_columns() click to toggle source

Internal changed_columns method that just returns stored array.

     # File lib/sequel/model/base.rb
1626 def _changed_columns
1627   @changed_columns ||= []
1628 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
1633 def _clear_changed_columns(_reason)
1634   _changed_columns.clear
1635 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
1639 def _delete
1640   n = _delete_without_checking
1641   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
1642   n
1643 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
1647 def _delete_dataset
1648   this
1649 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
1653 def _delete_without_checking
1654   if sql = (m = model).fast_instance_delete_sql
1655     sql = sql.dup
1656     ds = use_server(m.dataset)
1657     ds.literal_append(sql, pk)
1658     ds.with_sql_delete(sql)
1659   else
1660     _delete_dataset.delete 
1661   end
1662 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
1666 def _destroy(opts)
1667   called = false
1668   around_destroy do
1669     called = true
1670     before_destroy
1671     _destroy_delete
1672     after_destroy
1673   end
1674   raise_hook_failure(:around_destroy) unless called
1675   self
1676 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
1681 def _destroy_delete
1682   delete
1683 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
1687 def _insert
1688   ds = _insert_dataset
1689   if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil?
1690     _save_set_values(h) if h
1691     nil
1692   else
1693     iid = _insert_raw(ds)
1694     # if we have a regular primary key and it's not set in @values,
1695     # we assume it's the last inserted id
1696     if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk]
1697       vals[pk] = iid
1698     end
1699     pk
1700   end
1701 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
1705 def _insert_dataset
1706   use_server(model.instance_dataset)
1707 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
1710 def _insert_raw(ds)
1711   ds.insert(_insert_values)
1712 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
1715 def _insert_select_raw(ds)
1716   ds.insert_select(_insert_values)
1717 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
1724 def _refresh(dataset)
1725   _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found"))
1726   _clear_changed_columns(:refresh)
1727 end
_refresh_get(dataset) click to toggle source

Get the row of column data from the database.

     # File lib/sequel/model/base.rb
1730 def _refresh_get(dataset)
1731   if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock]
1732     sql = sql.dup
1733     ds = use_server(dataset)
1734     ds.literal_append(sql, pk)
1735     ds.with_sql_first(sql)
1736   else
1737     dataset.first
1738   end
1739 end
_refresh_set_values(h) click to toggle source

Set the values to the given hash after refreshing.

     # File lib/sequel/model/base.rb
1742 def _refresh_set_values(h)
1743   @values = h
1744 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
1748 def _save(opts)
1749   pk = nil
1750   called_save = false
1751   called_cu = false
1752   around_save do
1753     called_save = true
1754     before_save
1755 
1756     if new?
1757       around_create do
1758         called_cu = true
1759         before_create
1760         pk = _insert
1761         @this = nil
1762         @new = false
1763         @modified = false
1764         pk ? _save_refresh : _clear_changed_columns(:create)
1765         after_create
1766         true
1767       end
1768       raise_hook_failure(:around_create) unless called_cu
1769     else
1770       around_update do
1771         called_cu = true
1772         before_update
1773         columns = opts[:columns]
1774         if columns.nil?
1775           columns_updated = if opts[:changed]
1776             _save_update_changed_colums_hash
1777           else
1778             _save_update_all_columns_hash
1779           end
1780           _clear_changed_columns(:update)
1781         else # update only the specified columns
1782           columns = Array(columns)
1783           columns_updated = @values.reject{|k, v| !columns.include?(k)}
1784           _changed_columns.reject!{|c| columns.include?(c)}
1785         end
1786         _update_columns(columns_updated)
1787         @this = nil
1788         @modified = false
1789         after_update
1790         true
1791       end
1792       raise_hook_failure(:around_update) unless called_cu
1793     end
1794     after_save
1795     true
1796   end
1797   raise_hook_failure(:around_save) unless called_save
1798   self
1799 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
1804 def _save_refresh
1805   _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found"))
1806   _clear_changed_columns(:create)
1807 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
1811 def _save_set_values(h)
1812   @values = h
1813 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
1821 def _save_update_all_columns_hash
1822   v = Hash[@values]
1823   cc = changed_columns
1824   Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)}
1825   v
1826 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
1831 def _save_update_changed_colums_hash
1832   cc = changed_columns
1833   @values.reject{|k,v| !cc.include?(k)}
1834 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
1840 def _save_valid?(opts)
1841   if @skip_validation_on_next_save
1842     @skip_validation_on_next_save = false
1843     return true
1844   end
1845 
1846   checked_save_failure(opts){_valid?(opts)}
1847 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
1858 def _update(columns)
1859   n = _update_without_checking(columns)
1860   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
1861   n
1862 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
1852 def _update_columns(columns)
1853   _update(columns) unless columns.empty?
1854 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
1866 def _update_dataset
1867   this
1868 end
_update_without_checking(columns) click to toggle source

Update this instances dataset with the supplied column hash.

     # File lib/sequel/model/base.rb
1871 def _update_without_checking(columns)
1872   _update_dataset.update(columns)
1873 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
1876 def _use_insert_select?(ds)
1877   (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 
1878 end
_valid?(opts) click to toggle source

Internal validation method, running validation hooks.

     # File lib/sequel/model/base.rb
1881 def _valid?(opts)
1882   return errors.empty? if frozen?
1883   errors.clear
1884   called = false
1885   skip_validate = opts[:validate] == false
1886   around_validation do
1887     called = true
1888     before_validation
1889     validate unless skip_validate
1890     after_validation
1891   end
1892 
1893   return true if skip_validate
1894 
1895   if called
1896     errors.empty?
1897   else
1898     raise_hook_failure(:around_validation)
1899   end
1900 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
1922 def change_column_value(column, value)
1923   _add_changed_column(column)
1924   @values[column] = value
1925 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
1904 def checked_save_failure(opts)
1905   if raise_on_failure?(opts)
1906     yield
1907   else
1908     begin
1909       yield
1910     rescue HookFailed 
1911       nil
1912     end
1913   end
1914 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
1917 def checked_transaction(opts=OPTS)
1918   use_transaction?(opts) ? db.transaction({:server=>this_server}.merge!(opts)){yield} : yield
1919 end
errors_class() click to toggle source

Default error class used for errors.

     # File lib/sequel/model/base.rb
1928 def errors_class
1929   Errors
1930 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
1933 def hook_failed_error(msg)
1934   HookFailed.new(msg, self)
1935 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
1939 def initialize_clone(other)
1940   super
1941   freeze if other.frozen?
1942   self
1943 end
initialize_copy(other) click to toggle source

Copy constructor – Duplicate internal data structures.

Calls superclass method
     # File lib/sequel/model/base.rb
1946 def initialize_copy(other)
1947   super
1948   @values = Hash[@values]
1949   @changed_columns = @changed_columns.dup if @changed_columns
1950   @errors = @errors.dup if @errors
1951   self
1952 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
1957 def initialize_set(h)
1958   set(h) unless h.empty?
1959 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
1962 def inspect_values
1963   @values.inspect
1964 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
1976 def raise_hook_failure(type=nil)
1977   msg = case type
1978   when String
1979     type
1980   when Symbol
1981     "the #{type} hook failed"
1982   else
1983     "a hook failed"
1984   end
1985 
1986   raise hook_failed_error(msg)
1987 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
1970 def raise_on_failure?(opts)
1971   opts.fetch(:raise_on_failure, raise_on_save_failure)
1972 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
1990 def schema_type_class(column)
1991   if (sch = db_schema[column]) && (type = sch[:type])
1992     db.schema_type_class(type)
1993   end
1994 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
1998 def set_restricted(hash, type)
1999   return self if hash.empty?
2000   meths = setter_methods(type)
2001   strict = strict_param_setting
2002   hash.each do |k,v|
2003     m = "#{k}="
2004     if meths.include?(m)
2005       set_column_value(m, v)
2006     elsif strict
2007       # Avoid using respond_to? or creating symbols from user input
2008       if public_methods.map(&:to_s).include?(m)
2009         if Array(model.primary_key).map(&:to_s).member?(k.to_s) && model.restrict_primary_key?
2010           raise MassAssignmentRestriction, "#{k} is a restricted primary key"
2011         else
2012           raise MassAssignmentRestriction, "#{k} is a restricted column"
2013         end
2014       else
2015         raise MassAssignmentRestriction, "method #{m} doesn't exist"
2016       end
2017     end
2018   end
2019   self
2020 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
2028 def setter_methods(type)
2029   if type == :default && !@singleton_setter_added
2030     return model.setter_methods
2031   end
2032 
2033   meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS
2034   meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key?
2035   meths
2036 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
2040 def this_server
2041   if (s = @server)
2042     s
2043   elsif (t = @this)
2044     t.opts[:server] || :default
2045   else
2046     model.dataset.opts[:server] || :default
2047   end
2048 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
2053 def typecast_value(column, value)
2054   return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column])
2055   value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type])
2056   raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false)
2057   begin
2058     model.db.typecast_value(col_schema[:type], value)
2059   rescue InvalidValue
2060     raise_on_typecast_failure ? raise : value
2061   end
2062 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
2065 def update_restricted(hash, type)
2066   set_restricted(hash, type)
2067   save_changes
2068 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
2071 def use_server(ds)
2072   @server ? ds.server(@server) : ds
2073 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
2078 def use_transaction?(opts = OPTS)
2079   opts.fetch(:transaction, use_transactions)
2080 end
validation_failed_error() click to toggle source

An ValidationFailed exception instance to raise for this instance.

     # File lib/sequel/model/base.rb
2083 def validation_failed_error
2084   ValidationFailed.new(self)
2085 end