Module: Sequel::Model::InstanceMethods

Defined in:
lib/sequel/model/base.rb

Overview

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, 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#values ⇒ Object (readonly)

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', ...}



775
776
777
 
# File 'lib/sequel/model/base.rb', line 775

def values
  @values
end

Instance Method Details

#==(obj) ⇒ Object

Alias of eql?



835
836
837
 
# File 'lib/sequel/model/base.rb', line 835

def ==(obj)
  eql?(obj)
end

#===(obj) ⇒ Object

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



845
846
847
 
# File 'lib/sequel/model/base.rb', line 845

def ===(obj)
  pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
end

#[](column) ⇒ Object

Returns value of the column’s attribute.

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



810
811
812
 
# File 'lib/sequel/model/base.rb', line 810

def [](column)
  @values[column]
end

#[]=(column, value) ⇒ Object

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'}



822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/sequel/model/base.rb', line 822

def []=(column, value)
  # If it is new, it doesn't have a value yet, so we should
  # definitely set the new value.
  # If the column isn't in @values, we can't assume it is
  # NULL in the database, so assume it has changed.
  v = typecast_value(column, value)
  if new? || !@values.include?(column) || v != (c = @values[column]) || v.class != c.class
    changed_columns << column unless changed_columns.include?(column)
    @values[column] = v
  end
end

#autoincrementing_primary_key ⇒ Object

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.



860
861
862
 
# File 'lib/sequel/model/base.rb', line 860

def autoincrementing_primary_key
  primary_key
end

#changed_columns ⇒ Object

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]



871
872
873
 
# File 'lib/sequel/model/base.rb', line 871

def changed_columns
  @changed_columns ||= []
end

#delete ⇒ Object

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, ...}>



880
881
882
883
 
# File 'lib/sequel/model/base.rb', line 880

def delete
  _delete
  self
end

#destroy(opts = {}) ⇒ Object

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, ...}>



894
895
896
 
# File 'lib/sequel/model/base.rb', line 894

def destroy(opts = {})
  checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
end

#each(&block) ⇒ Object

Iterates through all of the current values using each.

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



903
904
905
 
# File 'lib/sequel/model/base.rb', line 903

def each(&block)
  @values.each(&block)
end

#eql?(obj) ⇒ Boolean

Compares model instances by values.

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

Returns:

  • (Boolean) 


912
913
914
 
# File 'lib/sequel/model/base.rb', line 912

def eql?(obj)
  (obj.class == model) && (obj.values == @values)
end

#errors ⇒ Object

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



918
919
920
 
# File 'lib/sequel/model/base.rb', line 918

def errors
  @errors ||= Errors.new
end

#exists? ⇒ Boolean

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

Returns:

  • (Boolean) 


932
933
934
 
# File 'lib/sequel/model/base.rb', line 932

def exists?
  new? ? false : !this.get(1).nil?
end

#extend(mod) ⇒ Object

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



938
939
940
941
 
# File 'lib/sequel/model/base.rb', line 938

def extend(mod)
  @singleton_setter_added = true
  super
end

#hash ⇒ Object

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



950
951
952
953
954
955
956
957
958
959
 
# File 'lib/sequel/model/base.rb', line 950

def hash
  case primary_key
  when Array
    [model, !pk.all? ? @values.sort_by{|k,v| k.to_s} : pk].hash
  when Symbol
    [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash
  else
    [model, @values.sort_by{|k,v| k.to_s}].hash
  end
end

#id ⇒ Object

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



965
966
967
 
# File 'lib/sequel/model/base.rb', line 965

def id
  @values[:id]
end

#initialize(values = {}, from_db = false) ⇒ Object

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



792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/sequel/model/base.rb', line 792

def initialize(values = {}, from_db = false)
  if from_db
    @new = false
    set_values(values)
  else
    @values = {}
    @new = true
    @modified = true
    initialize_set(values)
    changed_columns.clear 
    yield self if block_given?
  end
  after_initialize
end

#inspect ⇒ Object

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



971
972
973
 
# File 'lib/sequel/model/base.rb', line 971

def inspect
  "#<#{model.name} @values=#{inspect_values}>"
end

#keys ⇒ Object

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]



980
981
982
 
# File 'lib/sequel/model/base.rb', line 980

def keys
  @values.keys
end

#lock! ⇒ Object

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



993
994
995
 
# File 'lib/sequel/model/base.rb', line 993

def lock!
  new? ? self : _refresh(this.for_update)
end

#marshallable! ⇒ Object

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

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



1002
1003
1004
1005
 
# File 'lib/sequel/model/base.rb', line 1002

def marshallable!
  @this = nil
  self
end

#modified! ⇒ Object

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



1014
1015
1016
 
# File 'lib/sequel/model/base.rb', line 1014

def modified!
  @modified = true
end

#modified? ⇒ Boolean

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

Returns:

  • (Boolean) 


1026
1027
1028
 
# File 'lib/sequel/model/base.rb', line 1026

def modified?
  @modified || !changed_columns.empty?
end

#new? ⇒ Boolean

Returns true if the current instance represents a new record.

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

Returns:

  • (Boolean) 


1034
1035
1036
 
# File 'lib/sequel/model/base.rb', line 1034

def new?
  @new
end

#pk ⇒ Object

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]

Raises:



1044
1045
1046
1047
 
# File 'lib/sequel/model/base.rb', line 1044

def pk
  raise(Error, "No primary key is associated with this model") unless key = primary_key
  key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key]
end

#pk_hash ⇒ Object

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}



1053
1054
1055
 
# File 'lib/sequel/model/base.rb', line 1053

def pk_hash
  model.primary_key_hash(pk)
end

#refresh ⇒ Object

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'



1065
1066
1067
 
# File 'lib/sequel/model/base.rb', line 1065

def refresh
  _refresh(this)
end

#reload ⇒ Object

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



1070
1071
1072
 
# File 'lib/sequel/model/base.rb', line 1070

def reload
  refresh
end

#save(*columns) ⇒ Object

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

: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



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/sequel/model/base.rb', line 1099

def save(*columns)
  opts = columns.last.is_a?(Hash) ? columns.pop : {}
  if opts[:validate] != false
    unless checked_save_failure(opts){_valid?(true, opts)}
      raise(ValidationFailed.new(errors)) if raise_on_failure?(opts)
      return
    end
  end
  checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}}
end

#save_changes(opts = {}) ⇒ Object

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', ...}



1119
1120
1121
 
# File 'lib/sequel/model/base.rb', line 1119

def save_changes(opts={})
  save(opts.merge(:changed=>true)) || false if modified? 
end

#set(hash) ⇒ Object

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'



1130
1131
1132
 
# File 'lib/sequel/model/base.rb', line 1130

def set(hash)
  set_restricted(hash, nil, nil)
end

#set_all(hash) ⇒ Object

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'



1140
1141
1142
 
# File 'lib/sequel/model/base.rb', line 1140

def set_all(hash)
  set_restricted(hash, false, false)
end

#set_except(hash, *except) ⇒ Object

Set all values using the entries in the hash, except for the keys given in except. You should probably use set_fields or set_only instead of this method, as blacklist approaches to security are a bad idea.

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



1150
1151
1152
 
# File 'lib/sequel/model/base.rb', line 1150

def set_except(hash, *except)
  set_restricted(hash, false, except.flatten)
end

#set_fields(hash, fields) ⇒ Object

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'



1163
1164
1165
1166
 
# File 'lib/sequel/model/base.rb', line 1163

def set_fields(hash, fields)
  fields.each{|f| send("#{f}=", hash[f])}
  self
end

#set_only(hash, *only) ⇒ Object

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



1176
1177
1178
 
# File 'lib/sequel/model/base.rb', line 1176

def set_only(hash, *only)
  set_restricted(hash, only.flatten, false)
end

#singleton_method_added(meth) ⇒ Object

Clear the setter_methods cache when a method is added



1181
1182
1183
1184
 
# File 'lib/sequel/model/base.rb', line 1181

def singleton_method_added(meth)
  @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP
  super
end

#this ⇒ Object

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

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



1190
1191
1192
 
# File 'lib/sequel/model/base.rb', line 1190

def this
  @this ||= model.dataset.filter(pk_hash).limit(1).naked
end

#update(hash) ⇒ Object

Runs #set with the passed hash and then runs save_changes.

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



1197
1198
1199
 
# File 'lib/sequel/model/base.rb', line 1197

def update(hash)
  update_restricted(hash, nil, nil)
end

#update_all(hash) ⇒ Object

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)



1206
1207
1208
 
# File 'lib/sequel/model/base.rb', line 1206

def update_all(hash)
  update_restricted(hash, false, false)
end

#update_except(hash, *except) ⇒ Object

Update all values using the entries in the hash, except for the keys given in except. You should probably use update_fields or update_only instead of this method, as blacklist approaches to security are a bad idea.

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



1215
1216
1217
 
# File 'lib/sequel/model/base.rb', line 1215

def update_except(hash, *except)
  update_restricted(hash, false, except.flatten)
end

#update_fields(hash, fields) ⇒ Object

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)



1227
1228
1229
1230
 
# File 'lib/sequel/model/base.rb', line 1227

def update_fields(hash, fields)
  set_fields(hash, fields)
  save_changes
end

#update_only(hash, *only) ⇒ Object

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



1240
1241
1242
 
# File 'lib/sequel/model/base.rb', line 1240

def update_only(hash, *only)
  update_restricted(hash, only.flatten, false)
end

#valid?(opts = {}) ⇒ Boolean

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']

Returns:

  • (Boolean) 


1258
1259
1260
 
# File 'lib/sequel/model/base.rb', line 1258

def valid?(opts = {})
  _valid?(false, opts)
end

#validate ⇒ Object

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.



1250
1251
 
# File 'lib/sequel/model/base.rb', line 1250

def validate
end