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

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

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

[Source]

     # File lib/sequel/model/base.rb, line 891
891:       def initialize(values = {}, from_db = false)
892:         if from_db
893:           set_values(values)
894:         else
895:           @values = {}
896:           @new = true
897:           @modified = true
898:           initialize_set(values)
899:           changed_columns.clear 
900:           yield self if block_given?
901:         end
902:         after_initialize
903:       end

Public Instance methods

Alias of eql?

[Source]

     # File lib/sequel/model/base.rb, line 933
933:       def ==(obj)
934:         eql?(obj)
935:       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 943
943:       def ===(obj)
944:         pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
945:       end

Returns value of the column‘s attribute.

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

[Source]

     # File lib/sequel/model/base.rb, line 908
908:       def [](column)
909:         @values[column]
910:       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 920
920:       def []=(column, value)
921:         # If it is new, it doesn't have a value yet, so we should
922:         # definitely set the new value.
923:         # If the column isn't in @values, we can't assume it is
924:         # NULL in the database, so assume it has changed.
925:         v = typecast_value(column, value)
926:         vals = @values
927:         if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
928:           change_column_value(column, v)
929:         end
930:       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 958
958:       def autoincrementing_primary_key
959:         primary_key
960:       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 969
969:       def changed_columns
970:         @changed_columns ||= []
971:       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 978
978:       def delete
979:         raise Sequel::Error, "can't delete frozen object" if frozen?
980:         _delete
981:         self
982:       end

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 993
993:       def destroy(opts = {})
994:         raise Sequel::Error, "can't destroy frozen object" if frozen?
995:         checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
996:       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 1003
1003:       def each(&block)
1004:         @values.each(&block)
1005:       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 1012
1012:       def eql?(obj)
1013:         (obj.class == model) && (obj.values == @values)
1014:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1018
1018:       def errors
1019:         @errors ||= Errors.new
1020:       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 1032
1032:       def exists?
1033:         new? ? false : !this.get(1).nil?
1034:       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 1038
1038:       def extend(mod)
1039:         @singleton_setter_added = true
1040:         super
1041:       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 1046
1046:       def freeze
1047:         values.freeze
1048:         changed_columns.freeze
1049:         errors
1050:         validate
1051:         errors.freeze
1052:         this.freeze unless new?
1053:         super
1054:       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 1063
1063:       def hash
1064:         case primary_key
1065:         when Array
1066:           [model, !pk.all? ? @values.sort_by{|k,v| k.to_s} : pk].hash
1067:         when Symbol
1068:           [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash
1069:         else
1070:           [model, @values.sort_by{|k,v| k.to_s}].hash
1071:         end
1072:       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 1078
1078:       def id
1079:         @values[:id]
1080:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1084
1084:       def inspect
1085:         "#<#{model.name} @values=#{inspect_values}>"
1086:       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 1093
1093:       def keys
1094:         @values.keys
1095:       end

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 1106
1106:       def lock!
1107:         _refresh(this.for_update) unless new?
1108:         self
1109:       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 1116
1116:       def marshallable!
1117:         @this = nil
1118:         self
1119:       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

[Source]

      # File lib/sequel/model/base.rb, line 1128
1128:       def modified!
1129:         @modified = true
1130:       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

[Source]

      # File lib/sequel/model/base.rb, line 1140
1140:       def modified?
1141:         @modified || !changed_columns.empty?
1142:       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 1148
1148:       def new?
1149:         defined?(@new) ? @new : (@new = false)
1150:       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 1158
1158:       def pk
1159:         raise(Error, "No primary key is associated with this model") unless key = primary_key
1160:         if key.is_a?(Array)
1161:           vals = @values
1162:           key.map{|k| vals[k]}
1163:         else
1164:           @values[key]
1165:         end
1166:       end

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 1172
1172:       def pk_hash
1173:         model.primary_key_hash(pk)
1174:       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 1184
1184:       def refresh
1185:         raise Sequel::Error, "can't refresh frozen object" if frozen?
1186:         _refresh(this)
1187:         self
1188:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1191
1191:       def reload
1192:         refresh
1193:       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
: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 1222
1222:       def save(*columns)
1223:         raise Sequel::Error, "can't save frozen object" if frozen?
1224:         opts = columns.last.is_a?(Hash) ? columns.pop : {}
1225:         set_server(opts[:server]) if opts[:server] 
1226:         if opts[:validate] != false
1227:           unless checked_save_failure(opts){_valid?(true, opts)}
1228:             raise(ValidationFailed.new(errors)) if raise_on_failure?(opts)
1229:             return
1230:           end
1231:         end
1232:         checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}}
1233:       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 1244
1244:       def save_changes(opts={})
1245:         save(opts.merge(:changed=>true)) || false if modified? 
1246:       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 1255
1255:       def set(hash)
1256:         set_restricted(hash, nil, nil)
1257:       end

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 1265
1265:       def set_all(hash)
1266:         set_restricted(hash, false, false)
1267:       end

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'

[Source]

      # File lib/sequel/model/base.rb, line 1275
1275:       def set_except(hash, *except)
1276:         set_restricted(hash, false, except.flatten)
1277:       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 1305
1305:       def set_fields(hash, fields, opts=nil)
1306:         if opts
1307:           case opts[:missing]
1308:           when :skip
1309:             fields.each do |f|
1310:               if hash.has_key?(f) 
1311:                 send("#{f}=", hash[f])
1312:               elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1313:                 send("#{sf}=", hash[sf])
1314:               end
1315:             end
1316:           when :raise
1317:             fields.each do |f|
1318:               if hash.has_key?(f)
1319:                 send("#{f}=", hash[f])
1320:               elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1321:                 send("#{sf}=", hash[sf])
1322:               else
1323:                 raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
1324:               end
1325:             end
1326:           else
1327:             fields.each{|f| send("#{f}=", hash[f])}
1328:           end
1329:         else
1330:           fields.each{|f| send("#{f}=", hash[f])}
1331:         end
1332:         self
1333:       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 1343
1343:       def set_only(hash, *only)
1344:         set_restricted(hash, only.flatten, false)
1345:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1348
1348:       def set_server(s)
1349:         @server = s
1350:         @this.opts[:server] = s if @this
1351:         self
1352:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1357
1357:       def set_values(hash)
1358:         @values = hash
1359:       end

Clear the setter_methods cache when a method is added

[Source]

      # File lib/sequel/model/base.rb, line 1362
1362:       def singleton_method_added(meth)
1363:         @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP
1364:         super
1365:       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 1371
1371:       def this
1372:         @this ||= use_server(model.instance_dataset.filter(pk_hash))
1373:       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 1378
1378:       def update(hash)
1379:         update_restricted(hash, nil, nil)
1380:       end

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 1387
1387:       def update_all(hash)
1388:         update_restricted(hash, false, false)
1389:       end

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)

[Source]

      # File lib/sequel/model/base.rb, line 1396
1396:       def update_except(hash, *except)
1397:         update_restricted(hash, false, except.flatten)
1398:       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 1408
1408:       def update_fields(hash, fields, opts=nil)
1409:         set_fields(hash, fields, opts)
1410:         save_changes
1411:       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 1421
1421:       def update_only(hash, *only)
1422:         update_restricted(hash, only.flatten, false)
1423:       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 1439
1439:       def valid?(opts = {})
1440:         _valid?(false, opts)
1441:       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 1431
1431:       def validate
1432:       end

[Validate]