Module Sequel::Model::InstanceMethods
In: lib/sequel/plugins/prepared_statements.rb
lib/sequel/model/base.rb

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

  • All of the methods in HOOKS and AROUND_HOOKS create instance methods that are called by Sequel when the appropriate action occurs. For example, when destroying a model object, Sequel will call around_destroy, which will call before_destroy, do the destroy, and then call after_destroy.
  • The following instance_methods all call the class method of the same name: columns, db, primary_key, db_schema.
  • All of the methods in BOOLEAN_SETTINGS create attr_writers allowing you to set values for the attribute. It also creates instance getters returning the value of the setting. If the value has not yet been set, it gets the default value from the class by calling the class method of the same name.

Methods

External Aliases

values -> to_hash
send -> get_column_value
  Get the value of the column. Takes a single symbol or string argument. By default it calls send with the argument to get the value. This can be overridden if you have columns that conflict with existing method names.
send -> set_column_value
  Set the value of the column. Takes two argument. The first is a symbol or string argument for the column name, suffixed with =. The second is the value to set for the column. By default it calls send with the argument to set the value. This can be overridden if you have columns that conflict with existing method names (unlikely for setter methods, but possible).
class -> model
  class is defined in Object, but it is also a keyword, and since a lot of instance methods call class methods, this alias makes it so you can use model instead of self.class.
  Artist.new.model # => Artist
values -> _insert_values
  The values hash to use when inserting a new record.

Attributes

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

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

[Source]

      # File lib/sequel/model/base.rb, line 1292
1292:       def initialize(values = {})
1293:         @values = {}
1294:         @new = true
1295:         @modified = true
1296:         initialize_set(values)
1297:         changed_columns.clear 
1298:         yield self if block_given?
1299:       end

Public Instance methods

Alias of eql?

[Source]

      # File lib/sequel/model/base.rb, line 1329
1329:       def ==(obj)
1330:         eql?(obj)
1331:       end

If pk is not nil, true only if the objects have the same class and pk. If pk is nil, false.

  Artist[1] === Artist[1] # true
  Artist.new === Artist.new # false
  Artist[1].set(:name=>'Bob') == Artist[1] # => true

[Source]

      # File lib/sequel/model/base.rb, line 1339
1339:       def ===(obj)
1340:         pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
1341:       end

Returns value of the column‘s attribute.

  Artist[1][:id] #=> 1

[Source]

      # File lib/sequel/model/base.rb, line 1304
1304:       def [](column)
1305:         @values[column]
1306:       end

Sets the value for the given column. If typecasting is enabled for this object, typecast the value based on the column‘s type. If this is a new record or the typecasted value isn‘t the same as the current value for the column, mark the column as changed.

  a = Artist.new
  a[:name] = 'Bob'
  a.values #=> {:name=>'Bob'}

[Source]

      # File lib/sequel/model/base.rb, line 1316
1316:       def []=(column, value)
1317:         # If it is new, it doesn't have a value yet, so we should
1318:         # definitely set the new value.
1319:         # If the column isn't in @values, we can't assume it is
1320:         # NULL in the database, so assume it has changed.
1321:         v = typecast_value(column, value)
1322:         vals = @values
1323:         if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
1324:           change_column_value(column, v)
1325:         end
1326:       end

The autoincrementing primary key for this model object. Should be overridden if you have a composite primary key with one part of it being autoincrementing.

[Source]

      # File lib/sequel/model/base.rb, line 1354
1354:       def autoincrementing_primary_key
1355:         primary_key
1356:       end

Cancel the current action. Should be called in before hooks to halt the processing of the action. If a msg argument is given and the model instance is configured to raise exceptions on failure, sets the message to use for the raised HookFailed exception.

[Source]

      # File lib/sequel/model/base.rb, line 1362
1362:       def cancel_action(msg=nil)
1363:         raise_hook_failure(msg)
1364:       end

The columns that have been updated. This isn‘t completely accurate, as it could contain columns whose values have not changed.

  a = Artist[1]
  a.changed_columns # => []
  a.name = 'Bob'
  a.changed_columns # => [:name]

[Source]

      # File lib/sequel/model/base.rb, line 1373
1373:       def changed_columns
1374:         @changed_columns ||= []
1375:       end

Deletes and returns self. Does not run destroy hooks. Look into using destroy instead.

  Artist[1].delete # DELETE FROM artists WHERE (id = 1)
  # => #<Artist {:id=>1, ...}>

[Source]

      # File lib/sequel/model/base.rb, line 1382
1382:       def delete
1383:         raise Sequel::Error, "can't delete frozen object" if frozen?
1384:         _delete
1385:         self
1386:       end

Like delete but runs hooks before and after delete. If before_destroy returns false, returns false without deleting the object from the database. Otherwise, deletes the item from the database and returns self. 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, ...}>

[Source]

      # File lib/sequel/model/base.rb, line 1397
1397:       def destroy(opts = OPTS)
1398:         raise Sequel::Error, "can't destroy frozen object" if frozen?
1399:         checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
1400:       end

Iterates through all of the current values using each.

 Album[1].each{|k, v| puts "#{k} => #{v}"}
 # id => 1
 # name => 'Bob'

[Source]

      # File lib/sequel/model/base.rb, line 1407
1407:       def each(&block)
1408:         @values.each(&block)
1409:       end

Compares model instances by values.

  Artist[1] == Artist[1] # => true
  Artist.new == Artist.new # => true
  Artist[1].set(:name=>'Bob') == Artist[1] # => false

[Source]

      # File lib/sequel/model/base.rb, line 1416
1416:       def eql?(obj)
1417:         (obj.class == model) && (obj.values == @values)
1418:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1422
1422:       def errors
1423:         @errors ||= errors_class.new
1424:       end

Returns true when current instance exists, false otherwise. Generally an object that isn‘t new will exist unless it has been deleted. Uses a database query to check for existence, unless the model object is new, in which case this is always false.

  Artist[1].exists? # SELECT 1 FROM artists WHERE (id = 1)
  # => true
  Artist.new.exists?
  # => false

[Source]

      # File lib/sequel/model/base.rb, line 1436
1436:       def exists?
1437:         new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
1438:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1442
1442:       def extend(mod)
1443:         @singleton_setter_added = true
1444:         super
1445:       end

Freeze the object in such a way that it is still usable but not modifiable. Once an object is frozen, you cannot modify it‘s values, changed_columns, errors, or dataset.

[Source]

      # File lib/sequel/model/base.rb, line 1450
1450:       def freeze
1451:         values.freeze
1452:         changed_columns.freeze
1453:         unless errors.frozen?
1454:           validate
1455:           errors.freeze
1456:         end
1457:         this.freeze if !new? && model.primary_key
1458:         super
1459:       end

Value that should be unique for objects with the same class and pk (if pk is not nil), or the same class and values (if pk is nil).

  Artist[1].hash == Artist[1].hash # true
  Artist[1].set(:name=>'Bob').hash == Artist[1].hash # true
  Artist.new.hash == Artist.new.hash # true
  Artist.new(:name=>'Bob').hash == Artist.new.hash # false

[Source]

      # File lib/sequel/model/base.rb, line 1468
1468:       def hash
1469:         case primary_key
1470:         when Array
1471:           [model, !pk.all? ? @values : pk].hash
1472:         when Symbol
1473:           [model, pk.nil? ? @values : pk].hash
1474:         else
1475:           [model, @values].hash
1476:         end
1477:       end

Returns value for the :id attribute, even if the primary key is not id. To get the primary key value, use pk.

  Artist[1].id # => 1

[Source]

      # File lib/sequel/model/base.rb, line 1483
1483:       def id
1484:         @values[:id]
1485:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1489
1489:       def inspect
1490:         "#<#{model.name} @values=#{inspect_values}>"
1491:       end

Returns the keys in values. May not include all column names.

  Artist.new.keys # => []
  Artist.new(:name=>'Bob').keys # => [:name]
  Artist[1].keys # => [:id, :name]

[Source]

      # File lib/sequel/model/base.rb, line 1498
1498:       def keys
1499:         @values.keys
1500:       end

Refresh this record using for_update (by default, or the specified style when given) unless this is a new record. Returns self. This can be used to make sure no other process is updating the record at the same time.

If style is a string, it will be used directly. You should never pass a string to this method that is derived from user input, as that can lead to SQL injection.

A symbol may be used for database independent locking behavior, but all supported symbols have separate methods (e.g. for_update).

  a = Artist[1]
  Artist.db.transaction do
    a.lock!
    a.update(:name=>'A')
  end

 a = Artist[2]
 Artist.db.transaction do
   a.lock!('FOR NO KEY UPDATE')
   a.update(:name=>'B')
 end

[Source]

      # File lib/sequel/model/base.rb, line 1525
1525:       def lock!(style=:update)
1526:         _refresh(this.lock_style(style)) unless new?
1527:         self
1528:       end

Remove elements of the model object that make marshalling fail. Returns self.

  a = Artist[1]
  a.marshallable!
  Marshal.dump(a)

[Source]

      # File lib/sequel/model/base.rb, line 1535
1535:       def marshallable!
1536:         @this = nil
1537:         self
1538:       end

Explicitly mark the object as modified, so save_changes/update will run callbacks even if no columns have changed.

  a = Artist[1]
  a.save_changes # No callbacks run, as no changes
  a.modified!
  a.save_changes # Callbacks run, even though no changes made

If a column is given, specifically marked that column as modified, so that save_changes/update will include that column in the update. This should be used if you plan on mutating the column value instead of assigning a new column value:

  a.modified!(:name)
  a.name.gsub!(/[aeou]/, 'i')

[Source]

      # File lib/sequel/model/base.rb, line 1555
1555:       def modified!(column=nil)
1556:         if column && !changed_columns.include?(column)
1557:           changed_columns << column
1558:         end
1559:         @modified = true
1560:       end

Whether this object has been modified since last saved, used by save_changes to determine whether changes should be saved. New values are always considered modified.

  a = Artist[1]
  a.modified? # => false
  a.set(:name=>'Jim')
  a.modified? # => true

If a column is given, specifically check if the given column has been modified:

  a.modified?(:num_albums) # => false
  a.num_albums = 10
  a.modified?(:num_albums) # => true

[Source]

      # File lib/sequel/model/base.rb, line 1577
1577:       def modified?(column=nil)
1578:         if column
1579:           changed_columns.include?(column)
1580:         else
1581:           @modified || !changed_columns.empty?
1582:         end
1583:       end

Returns true if the current instance represents a new record.

  Artist.new.new? # => true
  Artist[1].new? # => false

[Source]

      # File lib/sequel/model/base.rb, line 1589
1589:       def new?
1590:         defined?(@new) ? @new : (@new = false)
1591:       end

Returns the primary key value identifying the model instance. Raises an Error if this model does not have a primary key. If the model has a composite primary key, returns an array of values.

  Artist[1].pk # => 1
  Artist[[1, 2]].pk # => [1, 2]

[Source]

      # File lib/sequel/model/base.rb, line 1599
1599:       def pk
1600:         raise(Error, "No primary key is associated with this model") unless key = primary_key
1601:         if key.is_a?(Array)
1602:           vals = @values
1603:           key.map{|k| vals[k]}
1604:         else
1605:           @values[key]
1606:         end
1607:       end

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}

[Source]

      # File lib/sequel/model/base.rb, line 1613
1613:       def pk_hash
1614:         model.primary_key_hash(pk)
1615:       end

Returns a hash mapping the receivers primary key column(s) to their values.

  Artist[1].qualified_pk_hash
  # => {Sequel.qualify(:artists, :id)=>1}
  Artist[[1, 2]].qualified_pk_hash
  # => {Sequel.qualify(:artists, :id1)=>1, Sequel.qualify(:artists, :id2)=>2}

[Source]

      # File lib/sequel/model/base.rb, line 1623
1623:       def qualified_pk_hash(qualifier=model.table_name)
1624:         model.qualified_primary_key_hash(pk, qualifier)
1625:       end

Reloads attributes from database and returns self. Also clears all changed_columns information. Raises an Error if the record no longer exists in the database.

  a = Artist[1]
  a.name = 'Jim'
  a.refresh
  a.name # => 'Bob'

[Source]

      # File lib/sequel/model/base.rb, line 1635
1635:       def refresh
1636:         raise Sequel::Error, "can't refresh frozen object" if frozen?
1637:         _refresh(this)
1638:         self
1639:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1642
1642:       def reload
1643:         refresh
1644:       end

Creates or updates the record, after making sure the record is valid and before hooks execute successfully. Fails if:

  • the record is not valid, or
  • before_save returns false, or
  • the record is new and before_create returns false, or
  • the record is not new and before_update returns false.

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.

You can provide an optional list of columns to update, in which case it only updates those columns, or a options hash.

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

[Source]

      # File lib/sequel/model/base.rb, line 1674
1674:       def save(opts=OPTS)
1675:         raise Sequel::Error, "can't save frozen object" if frozen?
1676:         set_server(opts[:server]) if opts[:server] 
1677:         _before_validation
1678:         if opts[:validate] != false
1679:           unless checked_save_failure(opts){_valid?(true, opts)}
1680:             raise(ValidationFailed.new(self)) if raise_on_failure?(opts)
1681:             return
1682:           end
1683:         end
1684:         checked_save_failure(opts){checked_transaction(opts){_save(opts)}}
1685:       end

Saves only changed columns if the object has been modified. If the object has not been modified, returns nil. If unable to save, returns false unless raise_on_save_failure is true.

  a = Artist[1]
  a.save_changes # => nil
  a.name = 'Jim'
  a.save_changes # UPDATE artists SET name = 'Bob' WHERE (id = 1)
  # => #<Artist {:id=>1, :name=>'Jim', ...}

[Source]

      # File lib/sequel/model/base.rb, line 1696
1696:       def save_changes(opts=OPTS)
1697:         save(Hash[opts].merge!(:changed=>true)) || false if modified? 
1698:       end

Updates the instance with the supplied values with support for virtual attributes, raising an exception if a value is used that doesn‘t have a setter method (or ignoring it if strict_param_setting = false). Does not save the record.

  artist.set(:name=>'Jim')
  artist.name # => 'Jim'

[Source]

      # File lib/sequel/model/base.rb, line 1707
1707:       def set(hash)
1708:         set_restricted(hash, :default)
1709:       end

Set all values using the entries in the hash, ignoring any setting of allowed_columns in the model.

  Artist.set_allowed_columns(:num_albums)
  artist.set_all(:name=>'Jim')
  artist.name # => 'Jim'

[Source]

      # File lib/sequel/model/base.rb, line 1717
1717:       def set_all(hash)
1718:         set_restricted(hash, :all)
1719:       end

For each of the fields in the given array fields, call the setter method with the value of that hash entry for the field. Returns self.

You can provide an options hash, with the following options currently respected:

:missing :Can be set to :skip to skip missing entries or :raise to raise an Error for missing entries. The default behavior is not to check for missing entries, in which case the default value is used. To be friendly with most web frameworks, the missing check will also check for the string version of the argument in the hash if given a symbol.

Examples:

  artist.set_fields({:name=>'Jim'}, [:name])
  artist.name # => 'Jim'

  artist.set_fields({:hometown=>'LA'}, [:name])
  artist.name # => nil
  artist.hometown # => 'Sac'

  artist.name # => 'Jim'
  artist.set_fields({}, [:name], :missing=>:skip)
  artist.name # => 'Jim'

  artist.name # => 'Jim'
  artist.set_fields({}, [:name], :missing=>:raise)
  # Sequel::Error raised

[Source]

      # File lib/sequel/model/base.rb, line 1747
1747:       def set_fields(hash, fields, opts=nil)
1748:         opts = if opts
1749:           Hash[model.default_set_fields_options].merge!(opts)
1750:         else
1751:           model.default_set_fields_options
1752:         end
1753: 
1754:         case opts[:missing]
1755:         when :skip
1756:           fields.each do |f|
1757:             if hash.has_key?(f) 
1758:               set_column_value("#{f}=", hash[f])
1759:             elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1760:               set_column_value("#{sf}=", hash[sf])
1761:             end
1762:           end
1763:         when :raise
1764:           fields.each do |f|
1765:             if hash.has_key?(f)
1766:               set_column_value("#{f}=", hash[f])
1767:             elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1768:               set_column_value("#{sf}=", hash[sf])
1769:             else
1770:               raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
1771:             end
1772:           end
1773:         else
1774:           fields.each{|f| set_column_value("#{f}=", hash[f])}
1775:         end
1776:         self
1777:       end

Set the values using the entries in the hash, only if the key is included in only. It may be a better idea to use set_fields instead of this method.

  artist.set_only({:name=>'Jim'}, :name)
  artist.name # => 'Jim'

  artist.set_only({:hometown=>'LA'}, :name) # Raise Error

[Source]

      # File lib/sequel/model/base.rb, line 1787
1787:       def set_only(hash, *only)
1788:         set_restricted(hash, only.flatten)
1789:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1792
1792:       def set_server(s)
1793:         @server = s
1794:         @this.opts[:server] = s if @this
1795:         self
1796:       end

Clear the setter_methods cache when a method is added

[Source]

      # File lib/sequel/model/base.rb, line 1799
1799:       def singleton_method_added(meth)
1800:         @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP
1801:         super
1802:       end

Returns (naked) dataset that should return only this instance.

  Artist[1].this
  # SELECT * FROM artists WHERE (id = 1) LIMIT 1

[Source]

      # File lib/sequel/model/base.rb, line 1808
1808:       def this
1809:         return @this if @this
1810:         raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset
1811: 
1812:         cond = if ds.joined_dataset?
1813:           qualified_pk_hash
1814:         else
1815:           pk_hash
1816:         end
1817: 
1818:         @this = use_server(ds.where(cond))
1819:       end

Runs set with the passed hash and then runs save_changes.

  artist.update(:name=>'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)

[Source]

      # File lib/sequel/model/base.rb, line 1824
1824:       def update(hash)
1825:         update_restricted(hash, :default)
1826:       end

Update all values using the entries in the hash, ignoring any setting of allowed_columns in the model.

  Artist.set_allowed_columns(:num_albums)
  artist.update_all(:name=>'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)

[Source]

      # File lib/sequel/model/base.rb, line 1833
1833:       def update_all(hash)
1834:         update_restricted(hash, :all)
1835:       end

Update the instances values by calling set_fields with the arguments, then saves any changes to the record. Returns self.

  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)

[Source]

      # File lib/sequel/model/base.rb, line 1845
1845:       def update_fields(hash, fields, opts=nil)
1846:         set_fields(hash, fields, opts)
1847:         save_changes
1848:       end

Update the values using the entries in the hash, only if the key is included in only. It may be a better idea to use update_fields instead of this method.

  artist.update_only({:name=>'Jim'}, :name)
  # UPDATE artists SET name = 'Jim' WHERE (id = 1)

  artist.update_only({:hometown=>'LA'}, :name) # Raise Error

[Source]

      # File lib/sequel/model/base.rb, line 1858
1858:       def update_only(hash, *only)
1859:         update_restricted(hash, only.flatten)
1860:       end

Whether prepared statements should be used for the given type of query (:insert, :insert_select, :refresh, :update, or :delete). True by default, can be overridden in other plugins to disallow prepared statements for specific types of queries.

[Source]

    # File lib/sequel/plugins/prepared_statements.rb, line 10
10:       def use_prepared_statements_for?(type)
11:         true
12:       end

Validates the object and returns true if no errors are reported.

  artist(:name=>'Valid').valid? # => true
  artist(:name=>'Invalid').valid? # => false
  artist.errors.full_messages # => ['name cannot be Invalid']

[Source]

      # File lib/sequel/model/base.rb, line 1876
1876:       def valid?(opts = OPTS)
1877:         _before_validation
1878:         _valid?(false, opts)
1879:       end

Validates the object. If the object is invalid, errors should be added to the errors attribute. By default, does nothing, as all models are valid by default. See the "Model Validations" guide. for details about validation. Should not be called directly by user code, call valid? instead to check if an object is valid.

[Source]

      # File lib/sequel/model/base.rb, line 1868
1868:       def validate
1869:       end

[Validate]