Module Sequel::Model::InstanceMethods
In: 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_destory, 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, dataset, 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 instnace 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

==   ===   []   []=   autoincrementing_primary_key   changed_columns   delete   destroy   each   eql?   errors   exists?   hash   id   inspect   keys   lock!   marshallable!   modified!   modified?   new   new?   pk   pk_hash   refresh   reload   save   save_changes   set   set_all   set_except   set_fields   set_only   singleton_method_added   this   update   update_all   update_except   update_fields   update_only   valid?   validate  

External Aliases

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

Attributes

values  [R]  The hash of attribute values. Keys are symbols with the names of the underlying database columns. 
  Artist.new(:name=>'Bob').values # => {:name=>'Bob'}
  Artist[1].values # => {:id=>1, :name=>'Jim', ...}

Public Class methods

new(values = {}, from_db = false) {|self if block_given?| ...}

Creates new instance and passes the given values to set. If a block is given, yield the instance to the block unless from_db is true. This method runs the after_initialize hook after it has optionally yielded itself to the block.

Arguments:

values :should be a hash to pass to set.
from_db :should only be set by Model.load, forget it exists. 
  Artist.new(:name=>'Bob')

  Artist.new do |a|
    a.name = 'Bob'
  end

[Source]

     # File lib/sequel/model/base.rb, line 747
747:       def initialize(values = {}, from_db = false)
748:         if from_db
749:           @new = false
750:           set_values(values)
751:         else
752:           @values = {}
753:           @new = true
754:           @modified = true
755:           initialize_set(values)
756:           changed_columns.clear 
757:           yield self if block_given?
758:         end
759:         after_initialize
760:       end

Public Instance methods

==(obj)

Alias of eql?

[Source]

     # File lib/sequel/model/base.rb, line 790
790:       def ==(obj)
791:         eql?(obj)
792:       end
===(obj)

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 800
800:       def ===(obj)
801:         pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
802:       end
[](column)

Returns value of the column‘s attribute. 

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

[Source]

     # File lib/sequel/model/base.rb, line 765
765:       def [](column)
766:         @values[column]
767:       end
[]=(column, value)

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 a 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 777
777:       def []=(column, value)
778:         # If it is new, it doesn't have a value yet, so we should
779:         # definitely set the new value.
780:         # If the column isn't in @values, we can't assume it is
781:         # NULL in the database, so assume it has changed.
782:         v = typecast_value(column, value)
783:         if new? || !@values.include?(column) || v != (c = @values[column]) || v.class != c.class
784:           changed_columns << column unless changed_columns.include?(column)
785:           @values[column] = v
786:         end
787:       end
autoincrementing_primary_key()

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 815
815:       def autoincrementing_primary_key
816:         primary_key
817:       end
changed_columns()

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 826
826:       def changed_columns
827:         @changed_columns ||= []
828:       end
delete()

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 835
835:       def delete
836:         _delete
837:         self
838:       end
destroy(opts = {})

Like delete but runs hooks before and after delete. If before_destroy returns false, returns false without deleting the object the 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 849
849:       def destroy(opts = {})
850:         checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
851:       end
each(&block)

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 858
858:       def each(&block)
859:         @values.each(&block)
860:       end
eql?(obj)

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 867
867:       def eql?(obj)
868:         (obj.class == model) && (obj.values == @values)
869:       end
errors()

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

[Source]

     # File lib/sequel/model/base.rb, line 873
873:       def errors
874:         @errors ||= Errors.new
875:       end
exists?()

Returns true when current instance exists, false otherwise. Generally an object that isn‘t new will exist unless it has been deleted. 

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

[Source]

     # File lib/sequel/model/base.rb, line 883
883:       def exists?
884:         !this.get(1).nil?
885:       end
hash()

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 894
894:       def hash
895:         [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash
896:       end
id()

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 902
902:       def id
903:         @values[:id]
904:       end
inspect()

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

[Source]

     # File lib/sequel/model/base.rb, line 908
908:       def inspect
909:         "#<#{model.name} @values=#{inspect_values}>"
910:       end
keys()

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 917
917:       def keys
918:         @values.keys
919:       end
lock!()

Refresh this record using for_update 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. 

  a = Artist[1]
  Artist.db.transaction do
    a.lock!
    a.update(...)
  end

[Source]

     # File lib/sequel/model/base.rb, line 930
930:       def lock!
931:         new? ? self : _refresh(this.for_update)
932:       end
marshallable!()

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 939
939:       def marshallable!
940:         @this = nil
941:         self
942:       end
modified!()

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

[Source]

     # File lib/sequel/model/base.rb, line 951
951:       def modified!
952:         @modified = true
953:       end
modified?()

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

[Source]

     # File lib/sequel/model/base.rb, line 963
963:       def modified?
964:         @modified || !changed_columns.empty?
965:       end
new?()

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 971
971:       def new?
972:         @new
973:       end
pk()

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 981
981:       def pk
982:         raise(Error, "No primary key is associated with this model") unless key = primary_key
983:         key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key]
984:       end
pk_hash()

Returns a hash identifying 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 990
990:       def pk_hash
991:         model.primary_key_hash(pk)
992:       end
refresh()

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 1002
1002:       def refresh
1003:         _refresh(this)
1004:       end
reload()

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

[Source]

      # File lib/sequel/model/base.rb, line 1007
1007:       def reload
1008:         refresh
1009:       end
save(*columns)

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.

Takes the following options:

  • :changed - save all changed columns, instead of all columns or the columns given
  • :transaction - set to true or false to override the current use_transactions setting
  • :validate - set to false to skip validation
  • :raise_on_failure - set to true or false to override the current raise_on_save_failure setting

[Source]

      # File lib/sequel/model/base.rb, line 1036
1036:       def save(*columns)
1037:         opts = columns.last.is_a?(Hash) ? columns.pop : {}
1038:         if opts[:validate] != false
1039:           unless checked_save_failure(opts){_valid?(true, opts)}
1040:             raise(ValidationFailed.new(errors)) if raise_on_failure?(opts)
1041:             return
1042:           end
1043:         end
1044:         checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}}
1045:       end
save_changes(opts={})

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 1056
1056:       def save_changes(opts={})
1057:         save(opts.merge(:changed=>true)) || false if modified? 
1058:       end
set(hash)

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 1067
1067:       def set(hash)
1068:         set_restricted(hash, nil, nil)
1069:       end
set_all(hash)

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

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

[Source]

      # File lib/sequel/model/base.rb, line 1077
1077:       def set_all(hash)
1078:         set_restricted(hash, false, false)
1079:       end
set_except(hash, *except)

Set all values using the entries in the hash, except for the keys given in except. 

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

[Source]

      # File lib/sequel/model/base.rb, line 1086
1086:       def set_except(hash, *except)
1087:         set_restricted(hash, false, except.flatten)
1088:       end
set_fields(hash, fields)

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. 

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

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

[Source]

      # File lib/sequel/model/base.rb, line 1099
1099:       def set_fields(hash, fields)
1100:         fields.each{|f| send("#{f}=", hash[f])}
1101:         self
1102:       end
set_only(hash, *only)

Set the values using the entries in the hash, only if the key is included in only. 

  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 1111
1111:       def set_only(hash, *only)
1112:         set_restricted(hash, only.flatten, false)
1113:       end
singleton_method_added(meth)

Clear the setter_methods cache when a method is added

[Source]

      # File lib/sequel/model/base.rb, line 1116
1116:       def singleton_method_added(meth)
1117:         @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP
1118:         super
1119:       end
this()

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 1125
1125:       def this
1126:         @this ||= model.dataset.filter(pk_hash).limit(1).naked
1127:       end
update(hash)

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 1132
1132:       def update(hash)
1133:         update_restricted(hash, nil, nil)
1134:       end
update_all(hash)

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

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

[Source]

      # File lib/sequel/model/base.rb, line 1141
1141:       def update_all(hash)
1142:         update_restricted(hash, false, false)
1143:       end
update_except(hash, *except)

Update all values using the entries in the hash, except for the keys given in except. 

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

[Source]

      # File lib/sequel/model/base.rb, line 1149
1149:       def update_except(hash, *except)
1150:         update_restricted(hash, false, except.flatten)
1151:       end
update_fields(hash, fields)

Update the instances values by calling set_fields with the hash and fields, then save 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 1161
1161:       def update_fields(hash, fields)
1162:         set_fields(hash, fields)
1163:         save_changes
1164:       end
update_only(hash, *only)

Update the values using the entries in the hash, only if the key is included in only. 

  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 1173
1173:       def update_only(hash, *only)
1174:         update_restricted(hash, only.flatten, false)
1175:       end
valid?(opts = {})

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 1191
1191:       def valid?(opts = {})
1192:         _valid?(false, opts)
1193:       end
validate()

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 1183
1183:       def validate
1184:       end

[Validate]