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
1090 def initialize(values = OPTS)
1091   @values = {}
1092   @new = true
1093   @modified = true
1094   initialize_set(values)
1095   _clear_changed_columns(:initialize)
1096   yield self if block_given?
1097 end

Public Instance Methods

==(obj) click to toggle source

Alias of eql?

     # File lib/sequel/model/base.rb
1127 def ==(obj)
1128   eql?(obj)
1129 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
1137 def ===(obj)
1138   case pkv = pk
1139   when nil
1140     return false
1141   when Array
1142     return false if pkv.any?(&:nil?)
1143   end
1144 
1145   (obj.class == model) && (obj.pk == pkv)
1146 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
1102 def [](column)
1103   @values[column]
1104 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
1114 def []=(column, value)
1115   # If it is new, it doesn't have a value yet, so we should
1116   # definitely set the new value.
1117   # If the column isn't in @values, we can't assume it is
1118   # NULL in the database, so assume it has changed.
1119   v = typecast_value(column, value)
1120   vals = @values
1121   if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
1122     change_column_value(column, v)
1123   end
1124 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
1169 def autoincrementing_primary_key
1170   primary_key
1171 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
1177 def cancel_action(msg=nil)
1178   raise_hook_failure(msg)
1179 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
1188 def changed_columns
1189   _changed_columns
1190 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
1197 def delete
1198   raise Sequel::Error, "can't delete frozen object" if frozen?
1199   _delete
1200   self
1201 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
1209 def destroy(opts = OPTS)
1210   raise Sequel::Error, "can't destroy frozen object" if frozen?
1211   checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
1212 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
1219 def each(&block)
1220   @values.each(&block)
1221 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
1228 def eql?(obj)
1229   (obj.class == model) && (obj.values == @values)
1230 end
errors() click to toggle source

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

     # File lib/sequel/model/base.rb
1234 def errors
1235   @errors ||= errors_class.new
1236 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
1248 def exists?
1249   new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
1250 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
1254 def extend(mod)
1255   @singleton_setter_added = true
1256   super
1257 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
1262 def freeze
1263   values.freeze
1264   _changed_columns.freeze
1265   unless errors.frozen?
1266     validate
1267     errors.freeze
1268   end
1269   this if !new? && model.primary_key
1270   super
1271 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
1280 def hash
1281   case primary_key
1282   when Array
1283     [model, !pk.all? ? @values : pk].hash
1284   when Symbol
1285     [model, pk.nil? ? @values : pk].hash
1286   else
1287     [model, @values].hash
1288   end
1289 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
1295 def id
1296   @values[:id]
1297 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
1301 def inspect
1302   "#<#{model.name} @values=#{inspect_values}>"
1303 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
1310 def keys
1311   @values.keys
1312 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
1337 def lock!(style=:update)
1338   _refresh(this.lock_style(style)) unless new?
1339   self
1340 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
1347 def marshallable!
1348   @this = nil
1349   self
1350 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
1367 def modified!(column=nil)
1368   _add_changed_column(column) if column
1369   @modified = true
1370 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
1387 def modified?(column=nil)
1388   if column
1389     changed_columns.include?(column)
1390   else
1391     @modified || !changed_columns.empty?
1392   end
1393 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
1399 def new?
1400   defined?(@new) ? @new : (@new = false)
1401 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
1409 def pk
1410   raise(Error, "No primary key is associated with this model") unless key = primary_key
1411   if key.is_a?(Array)
1412     vals = @values
1413     key.map{|k| vals[k]}
1414   else
1415     @values[key]
1416   end
1417 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
1423 def pk_hash
1424   model.primary_key_hash(pk)
1425 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
1433 def qualified_pk_hash(qualifier=model.table_name)
1434   model.qualified_primary_key_hash(pk, qualifier)
1435 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
1445 def refresh
1446   raise Sequel::Error, "can't refresh frozen object" if frozen?
1447   _refresh(this)
1448   self
1449 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
1452 def reload
1453   refresh
1454 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
1481 def save(opts=OPTS)
1482   raise Sequel::Error, "can't save frozen object" if frozen?
1483   set_server(opts[:server]) if opts[:server] 
1484   unless _save_valid?(opts)
1485     raise(validation_failed_error) if raise_on_failure?(opts)
1486     return
1487   end
1488   checked_save_failure(opts){checked_transaction(opts){_save(opts)}}
1489 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
1500 def save_changes(opts=OPTS)
1501   save(Hash[opts].merge!(:changed=>true)) || false if modified? 
1502 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
1511 def set(hash)
1512   set_restricted(hash, :default)
1513 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
1541 def set_fields(hash, fields, opts=nil)
1542   opts = if opts
1543     model.default_set_fields_options.merge(opts)
1544   else
1545     model.default_set_fields_options
1546   end
1547 
1548   case missing = opts[:missing]
1549   when :skip, :raise
1550     do_raise = true if missing == :raise
1551     fields.each do |f|
1552       if hash.has_key?(f) 
1553         set_column_value("#{f}=", hash[f])
1554       elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1555         set_column_value("#{sf}=", hash[sf])
1556       elsif do_raise
1557         raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
1558       end
1559     end
1560   else
1561     fields.each{|f| set_column_value("#{f}=", hash[f])}
1562   end
1563   self
1564 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
1567 def set_server(s)
1568   @server = s
1569   @this = @this.server(s) if @this
1570   self
1571 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
1574 def singleton_method_added(meth)
1575   @singleton_setter_added = true if meth.to_s.end_with?('=')
1576   super
1577 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
1584 def skip_validation_on_next_save!
1585   @skip_validation_on_next_save = true
1586 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
1592 def this
1593   return @this if @this
1594   raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset
1595   @this = use_server(ds.where(pk_hash))
1596 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
1601 def update(hash)
1602   update_restricted(hash, :default)
1603 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
1613 def update_fields(hash, fields, opts=nil)
1614   set_fields(hash, fields, opts)
1615   save_changes
1616 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
1632 def valid?(opts = OPTS)
1633   begin
1634     _valid?(opts)
1635   rescue HookFailed
1636     false
1637   end
1638 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
1624 def validate
1625 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
1643 def _add_changed_column(column)
1644   cc = _changed_columns
1645   cc << column unless cc.include?(column)
1646 end
_changed_columns() click to toggle source

Internal changed_columns method that just returns stored array.

     # File lib/sequel/model/base.rb
1649 def _changed_columns
1650   @changed_columns ||= []
1651 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
1656 def _clear_changed_columns(_reason)
1657   _changed_columns.clear
1658 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
1662 def _delete
1663   n = _delete_without_checking
1664   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
1665   n
1666 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
1670 def _delete_dataset
1671   this
1672 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
1676 def _delete_without_checking
1677   if sql = (m = model).fast_instance_delete_sql
1678     sql = sql.dup
1679     ds = use_server(m.dataset)
1680     ds.literal_append(sql, pk)
1681     ds.with_sql_delete(sql)
1682   else
1683     _delete_dataset.delete 
1684   end
1685 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
1689 def _destroy(opts)
1690   called = false
1691   around_destroy do
1692     called = true
1693     before_destroy
1694     _destroy_delete
1695     after_destroy
1696   end
1697   raise_hook_failure(:around_destroy) unless called
1698   self
1699 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
1704 def _destroy_delete
1705   delete
1706 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
1710 def _insert
1711   ds = _insert_dataset
1712   if _use_insert_select?(ds) && !(h = _insert_select_raw(ds)).nil?
1713     _save_set_values(h) if h
1714     nil
1715   else
1716     iid = _insert_raw(ds)
1717     # if we have a regular primary key and it's not set in @values,
1718     # we assume it's the last inserted id
1719     if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !(vals = @values)[pk]
1720       vals[pk] = iid
1721     end
1722     pk
1723   end
1724 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
1728 def _insert_dataset
1729   use_server(model.instance_dataset)
1730 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
1733 def _insert_raw(ds)
1734   ds.insert(_insert_values)
1735 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
1738 def _insert_select_raw(ds)
1739   ds.insert_select(_insert_values)
1740 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
1748 def _refresh(dataset)
1749   _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found"))
1750   _clear_changed_columns(:refresh)
1751 end
_refresh_get(dataset) click to toggle source

Get the row of column data from the database.

     # File lib/sequel/model/base.rb
1754 def _refresh_get(dataset)
1755   if (sql = model.fast_pk_lookup_sql) && !dataset.opts[:lock]
1756     sql = sql.dup
1757     ds = use_server(dataset)
1758     ds.literal_append(sql, pk)
1759     ds.with_sql_first(sql)
1760   else
1761     dataset.first
1762   end
1763 end
_refresh_set_values(h) click to toggle source

Set the values to the given hash after refreshing.

     # File lib/sequel/model/base.rb
1766 def _refresh_set_values(h)
1767   @values = h
1768 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
1772 def _save(opts)
1773   pk = nil
1774   called_save = false
1775   called_cu = false
1776   around_save do
1777     called_save = true
1778     before_save
1779 
1780     if new?
1781       around_create do
1782         called_cu = true
1783         before_create
1784         pk = _insert
1785         @this = nil
1786         @new = false
1787         @modified = false
1788         pk ? _save_refresh : _clear_changed_columns(:create)
1789         after_create
1790         true
1791       end
1792       raise_hook_failure(:around_create) unless called_cu
1793     else
1794       around_update do
1795         called_cu = true
1796         before_update
1797         columns = opts[:columns]
1798         if columns.nil?
1799           columns_updated = if opts[:changed]
1800             _save_update_changed_colums_hash
1801           else
1802             _save_update_all_columns_hash
1803           end
1804           _clear_changed_columns(:update)
1805         else # update only the specified columns
1806           columns = Array(columns)
1807           columns_updated = @values.reject{|k, v| !columns.include?(k)}
1808           _changed_columns.reject!{|c| columns.include?(c)}
1809         end
1810         _update_columns(columns_updated)
1811         @this = nil
1812         @modified = false
1813         after_update
1814         true
1815       end
1816       raise_hook_failure(:around_update) unless called_cu
1817     end
1818     after_save
1819     true
1820   end
1821   raise_hook_failure(:around_save) unless called_save
1822   self
1823 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
1828 def _save_refresh
1829   _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found"))
1830   _clear_changed_columns(:create)
1831 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
1835 def _save_set_values(h)
1836   @values = h
1837 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
1845 def _save_update_all_columns_hash
1846   v = Hash[@values]
1847   cc = changed_columns
1848   Array(primary_key).each{|x| v.delete(x) unless cc.include?(x)}
1849   v
1850 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
1855 def _save_update_changed_colums_hash
1856   cc = changed_columns
1857   @values.reject{|k,v| !cc.include?(k)}
1858 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
1864 def _save_valid?(opts)
1865   if @skip_validation_on_next_save
1866     @skip_validation_on_next_save = false
1867     return true
1868   end
1869 
1870   checked_save_failure(opts){_valid?(opts)}
1871 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
1882 def _update(columns)
1883   n = _update_without_checking(columns)
1884   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
1885   n
1886 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
1876 def _update_columns(columns)
1877   _update(columns) unless columns.empty?
1878 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
1890 def _update_dataset
1891   this
1892 end
_update_without_checking(columns) click to toggle source

Update this instances dataset with the supplied column hash.

     # File lib/sequel/model/base.rb
1895 def _update_without_checking(columns)
1896   _update_dataset.update(columns)
1897 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
1900 def _use_insert_select?(ds)
1901   (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 
1902 end
_valid?(opts) click to toggle source

Internal validation method, running validation hooks.

     # File lib/sequel/model/base.rb
1905 def _valid?(opts)
1906   return errors.empty? if frozen?
1907   errors.clear
1908   called = false
1909   skip_validate = opts[:validate] == false
1910   around_validation do
1911     called = true
1912     before_validation
1913     validate unless skip_validate
1914     after_validation
1915   end
1916 
1917   return true if skip_validate
1918 
1919   if called
1920     errors.empty?
1921   else
1922     raise_hook_failure(:around_validation)
1923   end
1924 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
1946 def change_column_value(column, value)
1947   _add_changed_column(column)
1948   @values[column] = value
1949 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
1928 def checked_save_failure(opts)
1929   if raise_on_failure?(opts)
1930     yield
1931   else
1932     begin
1933       yield
1934     rescue HookFailed 
1935       nil
1936     end
1937   end
1938 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
1941 def checked_transaction(opts=OPTS)
1942   use_transaction?(opts) ? db.transaction({:server=>this_server}.merge!(opts)){yield} : yield
1943 end
errors_class() click to toggle source

Default error class used for errors.

     # File lib/sequel/model/base.rb
1952 def errors_class
1953   Errors
1954 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
1957 def hook_failed_error(msg)
1958   HookFailed.new(msg, self)
1959 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
1963 def initialize_clone(other)
1964   super
1965   freeze if other.frozen?
1966   self
1967 end
initialize_copy(other) click to toggle source

Copy constructor – Duplicate internal data structures.

Calls superclass method
     # File lib/sequel/model/base.rb
1970 def initialize_copy(other)
1971   super
1972   @values = Hash[@values]
1973   @changed_columns = @changed_columns.dup if @changed_columns
1974   @errors = @errors.dup if @errors
1975   self
1976 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
1981 def initialize_set(h)
1982   set(h) unless h.empty?
1983 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
1986 def inspect_values
1987   @values.inspect
1988 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
2000 def raise_hook_failure(type=nil)
2001   msg = case type
2002   when String
2003     type
2004   when Symbol
2005     "the #{type} hook failed"
2006   else
2007     "a hook failed"
2008   end
2009 
2010   raise hook_failed_error(msg)
2011 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
1994 def raise_on_failure?(opts)
1995   opts.fetch(:raise_on_failure, raise_on_save_failure)
1996 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
2014 def schema_type_class(column)
2015   if (sch = db_schema[column]) && (type = sch[:type])
2016     db.schema_type_class(type)
2017   end
2018 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
2022 def set_restricted(hash, type)
2023   return self if hash.empty?
2024   meths = setter_methods(type)
2025   strict = strict_param_setting
2026   hash.each do |k,v|
2027     m = "#{k}="
2028     if meths.include?(m)
2029       set_column_value(m, v)
2030     elsif strict
2031       # Avoid using respond_to? or creating symbols from user input
2032       if public_methods.map(&:to_s).include?(m)
2033         if Array(model.primary_key).map(&:to_s).member?(k.to_s) && model.restrict_primary_key?
2034           raise MassAssignmentRestriction, "#{k} is a restricted primary key"
2035         else
2036           raise MassAssignmentRestriction, "#{k} is a restricted column"
2037         end
2038       else
2039         raise MassAssignmentRestriction, "method #{m} doesn't exist"
2040       end
2041     end
2042   end
2043   self
2044 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
2052 def setter_methods(type)
2053   if type == :default && !@singleton_setter_added
2054     return model.setter_methods
2055   end
2056 
2057   meths = methods.map(&:to_s).select{|l| l.end_with?('=')} - RESTRICTED_SETTER_METHODS
2058   meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && model.restrict_primary_key?
2059   meths
2060 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
2064 def this_server
2065   if (s = @server)
2066     s
2067   elsif (t = @this)
2068     t.opts[:server] || :default
2069   else
2070     model.dataset.opts[:server] || :default
2071   end
2072 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
2077 def typecast_value(column, value)
2078   return value unless typecast_on_assignment && db_schema && (col_schema = db_schema[column])
2079   value = nil if '' == value and typecast_empty_string_to_nil and col_schema[:type] and ![:string, :blob].include?(col_schema[:type])
2080   raise(InvalidValue, "nil/NULL is not allowed for the #{column} column") if raise_on_typecast_failure && value.nil? && (col_schema[:allow_null] == false)
2081   begin
2082     model.db.typecast_value(col_schema[:type], value)
2083   rescue InvalidValue
2084     raise_on_typecast_failure ? raise : value
2085   end
2086 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
2089 def update_restricted(hash, type)
2090   set_restricted(hash, type)
2091   save_changes
2092 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
2095 def use_server(ds)
2096   @server ? ds.server(@server) : ds
2097 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
2102 def use_transaction?(opts = OPTS)
2103   opts.fetch(:transaction, use_transactions)
2104 end
validation_failed_error() click to toggle source

An ValidationFailed exception instance to raise for this instance.

     # File lib/sequel/model/base.rb
2107 def validation_failed_error
2108   ValidationFailed.new(self)
2109 end