Module Sequel::Model::InstanceMethods
In: lib/sequel/model/base.rb
lib/sequel/plugins/prepared_statements.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
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.

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 927
927:       def initialize(values = {})
928:         @values = {}
929:         @new = true
930:         @modified = true
931:         initialize_set(values)
932:         changed_columns.clear 
933:         yield self if block_given?
934:       end

Public Instance methods

Alias of eql?

[Source]

     # File lib/sequel/model/base.rb, line 964
964:       def ==(obj)
965:         eql?(obj)
966:       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 974
974:       def ===(obj)
975:         pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
976:       end

Returns value of the column‘s attribute.

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

[Source]

     # File lib/sequel/model/base.rb, line 939
939:       def [](column)
940:         @values[column]
941:       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 951
951:       def []=(column, value)
952:         # If it is new, it doesn't have a value yet, so we should
953:         # definitely set the new value.
954:         # If the column isn't in @values, we can't assume it is
955:         # NULL in the database, so assume it has changed.
956:         v = typecast_value(column, value)
957:         vals = @values
958:         if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
959:           change_column_value(column, v)
960:         end
961:       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 989
989:       def autoincrementing_primary_key
990:         primary_key
991:       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 1000
1000:       def changed_columns
1001:         @changed_columns ||= []
1002:       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 1009
1009:       def delete
1010:         raise Sequel::Error, "can't delete frozen object" if frozen?
1011:         _delete
1012:         self
1013:       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 1024
1024:       def destroy(opts = OPTS)
1025:         raise Sequel::Error, "can't destroy frozen object" if frozen?
1026:         checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
1027:       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 1034
1034:       def each(&block)
1035:         @values.each(&block)
1036:       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 1043
1043:       def eql?(obj)
1044:         (obj.class == model) && (obj.values == @values)
1045:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1049
1049:       def errors
1050:         @errors ||= errors_class.new
1051:       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 1063
1063:       def exists?
1064:         new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
1065:       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 1069
1069:       def extend(mod)
1070:         @singleton_setter_added = true
1071:         super
1072:       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 1077
1077:       def freeze
1078:         values.freeze
1079:         changed_columns.freeze
1080:         errors
1081:         validate
1082:         errors.freeze
1083:         this.freeze if !new? && model.primary_key
1084:         super
1085:       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 1094
1094:       def hash
1095:         case primary_key
1096:         when Array
1097:           [model, !pk.all? ? @values : pk].hash
1098:         when Symbol
1099:           [model, pk.nil? ? @values : pk].hash
1100:         else
1101:           [model, @values].hash
1102:         end
1103:       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 1109
1109:       def id
1110:         @values[:id]
1111:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1115
1115:       def inspect
1116:         "#<#{model.name} @values=#{inspect_values}>"
1117:       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 1124
1124:       def keys
1125:         @values.keys
1126:       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 1137
1137:       def lock!
1138:         _refresh(this.for_update) unless new?
1139:         self
1140:       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 1147
1147:       def marshallable!
1148:         @this = nil
1149:         self
1150:       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 1167
1167:       def modified!(column=nil)
1168:         if column && !changed_columns.include?(column)
1169:           changed_columns << column
1170:         end
1171:         @modified = true
1172:       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 1189
1189:       def modified?(column=nil)
1190:         if column
1191:           changed_columns.include?(column)
1192:         else
1193:           @modified || !changed_columns.empty?
1194:         end
1195:       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 1201
1201:       def new?
1202:         defined?(@new) ? @new : (@new = false)
1203:       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 1211
1211:       def pk
1212:         raise(Error, "No primary key is associated with this model") unless key = primary_key
1213:         if key.is_a?(Array)
1214:           vals = @values
1215:           key.map{|k| vals[k]}
1216:         else
1217:           @values[key]
1218:         end
1219:       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 1225
1225:       def pk_hash
1226:         model.primary_key_hash(pk)
1227:       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 1237
1237:       def refresh
1238:         raise Sequel::Error, "can't refresh frozen object" if frozen?
1239:         _refresh(this)
1240:         self
1241:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1244
1244:       def reload
1245:         refresh
1246:       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 1276
1276:       def save(opts=OPTS)
1277:         raise Sequel::Error, "can't save frozen object" if frozen?
1278:         set_server(opts[:server]) if opts[:server] 
1279:         if opts[:validate] != false
1280:           unless checked_save_failure(opts){_valid?(true, opts)}
1281:             raise(ValidationFailed.new(self)) if raise_on_failure?(opts)
1282:             return
1283:           end
1284:         end
1285:         checked_save_failure(opts){checked_transaction(opts){_save(opts)}}
1286:       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 1297
1297:       def save_changes(opts=OPTS)
1298:         save(opts.merge(:changed=>true)) || false if modified? 
1299:       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 1308
1308:       def set(hash)
1309:         set_restricted(hash, :default)
1310:       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 1318
1318:       def set_all(hash)
1319:         set_restricted(hash, :all)
1320:       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 1348
1348:       def set_fields(hash, fields, opts=nil)
1349:         opts = if opts
1350:           model.default_set_fields_options.merge(opts)
1351:         else
1352:           model.default_set_fields_options
1353:         end
1354: 
1355:         case opts[:missing]
1356:         when :skip
1357:           fields.each do |f|
1358:             if hash.has_key?(f) 
1359:               send("#{f}=", hash[f])
1360:             elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1361:               send("#{sf}=", hash[sf])
1362:             end
1363:           end
1364:         when :raise
1365:           fields.each do |f|
1366:             if hash.has_key?(f)
1367:               send("#{f}=", hash[f])
1368:             elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1369:               send("#{sf}=", hash[sf])
1370:             else
1371:               raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
1372:             end
1373:           end
1374:         else
1375:           fields.each{|f| send("#{f}=", hash[f])}
1376:         end
1377:         self
1378:       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 1388
1388:       def set_only(hash, *only)
1389:         set_restricted(hash, only.flatten)
1390:       end

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

[Source]

      # File lib/sequel/model/base.rb, line 1393
1393:       def set_server(s)
1394:         @server = s
1395:         @this.opts[:server] = s if @this
1396:         self
1397:       end

REMOVE41

[Source]

      # File lib/sequel/model/base.rb, line 1400
1400:       def set_values(hash)
1401:         Sequel::Deprecation.deprecate('Model#set_values is deprecreated and will be removed in Sequel 4.1.  Please use _refresh_set_values or _save_set_values or set the values directly.')
1402:         @values = hash
1403:       end

Clear the setter_methods cache when a method is added

[Source]

      # File lib/sequel/model/base.rb, line 1406
1406:       def singleton_method_added(meth)
1407:         @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP
1408:         super
1409:       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 1415
1415:       def this
1416:         @this ||= use_server(model.instance_dataset.filter(pk_hash))
1417:       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 1422
1422:       def update(hash)
1423:         update_restricted(hash, :default)
1424:       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 1431
1431:       def update_all(hash)
1432:         update_restricted(hash, :all)
1433:       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 1443
1443:       def update_fields(hash, fields, opts=nil)
1444:         set_fields(hash, fields, opts)
1445:         save_changes
1446:       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 1456
1456:       def update_only(hash, *only)
1457:         update_restricted(hash, only.flatten)
1458:       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 8
 8:       def use_prepared_statements_for?(type)
 9:         true
10:       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 1474
1474:       def valid?(opts = OPTS)
1475:         _valid?(false, opts)
1476:       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 1466
1466:       def validate
1467:       end

[Validate]