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

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



876
877
878
 
# File 'lib/sequel/model/base.rb', line 876

def values
  @values
end

Instance Method Details

#==(obj) ⇒ Object

Alias of eql?



935
936
937
 
# File 'lib/sequel/model/base.rb', line 935

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



945
946
947
 
# File 'lib/sequel/model/base.rb', line 945

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



910
911
912
 
# File 'lib/sequel/model/base.rb', line 910

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



922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/sequel/model/base.rb', line 922

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)
  vals = @values
  if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
    change_column_value(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.



960
961
962
 
# File 'lib/sequel/model/base.rb', line 960

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]



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

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

Raises:



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

def delete
  raise Sequel::Error, "can't delete frozen object" if frozen?
  _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, ...}>

Raises:



995
996
997
998
 
# File 'lib/sequel/model/base.rb', line 995

def destroy(opts = {})
  raise Sequel::Error, "can't destroy frozen object" if frozen?
  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'



1005
1006
1007
 
# File 'lib/sequel/model/base.rb', line 1005

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) 


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

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

#errors ⇒ Object

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



1020
1021
1022
 
# File 'lib/sequel/model/base.rb', line 1020

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) 


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

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.



1040
1041
1042
1043
 
# File 'lib/sequel/model/base.rb', line 1040

def extend(mod)
  @singleton_setter_added = true
  super
end

#freeze ⇒ Object

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.



1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/sequel/model/base.rb', line 1048

def freeze
  values.freeze
  changed_columns.freeze
  errors
  validate
  errors.freeze
  this.freeze unless new?
  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



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/sequel/model/base.rb', line 1065

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



1080
1081
1082
 
# File 'lib/sequel/model/base.rb', line 1080

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

only for backwards compatibility, forget it exists.

Artist.new(:name=>'Bob')

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



893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/sequel/model/base.rb', line 893

def initialize(values = {}, from_db = false)
  if from_db
    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.



1086
1087
1088
 
# File 'lib/sequel/model/base.rb', line 1086

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]



1095
1096
1097
 
# File 'lib/sequel/model/base.rb', line 1095

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



1108
1109
1110
 
# File 'lib/sequel/model/base.rb', line 1108

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)



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

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



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

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) 


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

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) 


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

def new?
  defined?(@new) ? @new : (@new = false)
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:



1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/sequel/model/base.rb', line 1159

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



1173
1174
1175
 
# File 'lib/sequel/model/base.rb', line 1173

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'

Raises:



1185
1186
1187
1188
 
# File 'lib/sequel/model/base.rb', line 1185

def refresh
  raise Sequel::Error, "can't refresh frozen object" if frozen?
  _refresh(this)
end

#reload ⇒ Object

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



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

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

: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

Raises:



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/sequel/model/base.rb', line 1222

def save(*columns)
  raise Sequel::Error, "can't save frozen object" if frozen?
  opts = columns.last.is_a?(Hash) ? columns.pop : {}
  set_server(opts[:server]) if opts[:server] 
  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', ...}



1244
1245
1246
 
# File 'lib/sequel/model/base.rb', line 1244

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'



1255
1256
1257
 
# File 'lib/sequel/model/base.rb', line 1255

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'



1265
1266
1267
 
# File 'lib/sequel/model/base.rb', line 1265

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'



1275
1276
1277
 
# File 'lib/sequel/model/base.rb', line 1275

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

#set_fields(hash, fields, opts = nil) ⇒ 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.

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



1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
 
# File 'lib/sequel/model/base.rb', line 1305

def set_fields(hash, fields, opts=nil)
  if opts
    case opts[:missing]
    when :skip
      fields.each do |f|
        if hash.has_key?(f) 
          send("#{f}=", hash[f])
        elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
          send("#{sf}=", hash[sf])
        end
      end
    when :raise
      fields.each do |f|
        if hash.has_key?(f)
          send("#{f}=", hash[f])
        elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
          send("#{sf}=", hash[sf])
        else
          raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
        end
      end
    else
      fields.each{|f| send("#{f}=", hash[f])}
    end
  else
    fields.each{|f| send("#{f}=", hash[f])}
  end
  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



1343
1344
1345
 
# File 'lib/sequel/model/base.rb', line 1343

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

#set_server(s) ⇒ Object

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



1348
1349
1350
1351
1352
 
# File 'lib/sequel/model/base.rb', line 1348

def set_server(s)
  @server = s
  @this.opts[:server] = s if @this
  self
end

#set_values(hash) ⇒ Object

Replace the current values with hash. Should definitely not be used with untrusted input, and should probably not be called directly by user code.



1357
1358
1359
 
# File 'lib/sequel/model/base.rb', line 1357

def set_values(hash)
  @values = hash
end

#singleton_method_added(meth) ⇒ Object

Clear the setter_methods cache when a method is added



1362
1363
1364
1365
 
# File 'lib/sequel/model/base.rb', line 1362

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



1371
1372
1373
 
# File 'lib/sequel/model/base.rb', line 1371

def this
  @this ||= use_server(model.instance_dataset.filter(pk_hash))
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)



1378
1379
1380
 
# File 'lib/sequel/model/base.rb', line 1378

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)



1387
1388
1389
 
# File 'lib/sequel/model/base.rb', line 1387

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)



1396
1397
1398
 
# File 'lib/sequel/model/base.rb', line 1396

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

#update_fields(hash, fields, opts = nil) ⇒ Object

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)



1408
1409
1410
1411
 
# File 'lib/sequel/model/base.rb', line 1408

def update_fields(hash, fields, opts=nil)
  set_fields(hash, fields, opts)
  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



1421
1422
1423
 
# File 'lib/sequel/model/base.rb', line 1421

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) 


1439
1440
1441
 
# File 'lib/sequel/model/base.rb', line 1439

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.



1431
1432
 
# File 'lib/sequel/model/base.rb', line 1431

def validate
end