Module: Sequel::Model::InstanceMethods

External Aliases

values	->	to_hash
send	->	get_column_value
	Get the value of the column. Takes a single symbol or string argument. By default it calls send with the argument to get the value. This can be overridden if you have columns that conflict with existing method names.
send	->	set_column_value
	Set the value of the column. Takes two arguments. The first is a symbol or string argument for the column name, suffixed with =. The second is the value to set for the column. By default it calls send with the argument to set the value. This can be overridden if you have columns that conflict with existing method names (unlikely for setter methods, but possible).
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
values	->	_insert_values
	The values hash to use when inserting a new record.

Attributes

values

[R]

The hash of attribute values. Keys are symbols with the names of the underlying database columns. The returned hash is a reference to the receiver‘s values hash, and modifying it will also modify the receiver‘s values.

  Artist.new(name: 'Bob').values # => {:name=>'Bob'}
  Artist[1].values # => {:id=>1, :name=>'Jim', ...}

Public Class methods

new(values = OPTS) {|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.

Arguments:

values :

should be a hash to pass to set.

  Artist.new(name: 'Bob')

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

[Source]

      # File lib/sequel/model/base.rb, line 1065
1065:       def initialize(values = OPTS)
1066:         @values = {}
1067:         @new = true
1068:         @modified = true
1069:         initialize_set(values)
1070:         _changed_columns.clear
1071:         yield self if block_given?
1072:       end

Public Instance methods

==(obj)

Alias of eql?

[Source]

      # File lib/sequel/model/base.rb, line 1102
1102:       def ==(obj)
1103:         eql?(obj)
1104:       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 1112
1112:       def ===(obj)
1113:         pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
1114:       end

[](column)

Returns value of the column‘s attribute.

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

[Source]

      # File lib/sequel/model/base.rb, line 1077
1077:       def [](column)
1078:         @values[column]
1079:       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 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 1089
1089:       def []=(column, value)
1090:         # If it is new, it doesn't have a value yet, so we should
1091:         # definitely set the new value.
1092:         # If the column isn't in @values, we can't assume it is
1093:         # NULL in the database, so assume it has changed.
1094:         v = typecast_value(column, value)
1095:         vals = @values
1096:         if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
1097:           change_column_value(column, v)
1098:         end
1099:       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 1127
1127:       def autoincrementing_primary_key
1128:         primary_key
1129:       end

cancel_action(msg=nil)

Cancel the current action. Should be called in before hooks to halt the processing of the action. If a msg argument is given and the model instance is configured to raise exceptions on failure, sets the message to use for the raised HookFailed exception.

[Source]

      # File lib/sequel/model/base.rb, line 1135
1135:       def cancel_action(msg=nil)
1136:         raise_hook_failure(msg)
1137:       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 1146
1146:       def changed_columns
1147:         _changed_columns
1148:       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 1155
1155:       def delete
1156:         raise Sequel::Error, "can't delete frozen object" if frozen?
1157:         _delete
1158:         self
1159:       end

destroy(opts = OPTS)

Like delete but runs hooks before and after delete. 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 1167
1167:       def destroy(opts = OPTS)
1168:         raise Sequel::Error, "can't destroy frozen object" if frozen?
1169:         checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
1170:       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 1177
1177:       def each(&block)
1178:         @values.each(&block)
1179:       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 1186
1186:       def eql?(obj)
1187:         (obj.class == model) && (obj.values == @values)
1188:       end

errors()

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

[Source]

      # File lib/sequel/model/base.rb, line 1192
1192:       def errors
1193:         @errors ||= errors_class.new
1194:       end

exists?()

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 1206
1206:       def exists?
1207:         new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
1208:       end

extend(mod)

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 1212
1212:       def extend(mod)
1213:         @singleton_setter_added = true
1214:         super
1215:       end

freeze()

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 1220
1220:       def freeze
1221:         values.freeze
1222:         _changed_columns.freeze
1223:         unless errors.frozen?
1224:           validate
1225:           errors.freeze
1226:         end
1227:         this if !new? && model.primary_key
1228:         super
1229:       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 1238
1238:       def hash
1239:         case primary_key
1240:         when Array
1241:           [model, !pk.all? ? @values : pk].hash
1242:         when Symbol
1243:           [model, pk.nil? ? @values : pk].hash
1244:         else
1245:           [model, @values].hash
1246:         end
1247:       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 1253
1253:       def id
1254:         @values[:id]
1255:       end

inspect()

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

[Source]

      # File lib/sequel/model/base.rb, line 1259
1259:       def inspect
1260:         "#<#{model.name} @values=#{inspect_values}>"
1261:       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 1268
1268:       def keys
1269:         @values.keys
1270:       end

lock!(style=:update)

Refresh this record using for_update (by default, or the specified style when given) 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.

If style is a string, it will be used directly. You should never pass a string to this method that is derived from user input, as that can lead to SQL injection.

A symbol may be used for database independent locking behavior, but all supported symbols have separate methods (e.g. for_update).

  a = Artist[1]
  Artist.db.transaction do
    a.lock!
    a.update(:name=>'A')
  end

 a = Artist[2]
 Artist.db.transaction do
   a.lock!('FOR NO KEY UPDATE')
   a.update(:name=>'B')
 end

[Source]

      # File lib/sequel/model/base.rb, line 1295
1295:       def lock!(style=:update)
1296:         _refresh(this.lock_style(style)) unless new?
1297:         self
1298:       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 1305
1305:       def marshallable!
1306:         @this = nil
1307:         self
1308:       end

modified!(column=nil)

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 1325
1325:       def modified!(column=nil)
1326:         _add_changed_column(column) if column
1327:         @modified = true
1328:       end

modified?(column=nil)

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 1345
1345:       def modified?(column=nil)
1346:         if column
1347:           changed_columns.include?(column)
1348:         else
1349:           @modified || !changed_columns.empty?
1350:         end
1351:       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 1357
1357:       def new?
1358:         defined?(@new) ? @new : (@new = false)
1359:       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 1367
1367:       def pk
1368:         raise(Error, "No primary key is associated with this model") unless key = primary_key
1369:         if key.is_a?(Array)
1370:           vals = @values
1371:           key.map{|k| vals[k]}
1372:         else
1373:           @values[key]
1374:         end
1375:       end

pk_hash()

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 1381
1381:       def pk_hash
1382:         model.primary_key_hash(pk)
1383:       end

qualified_pk_hash(qualifier=model.table_name)

Returns a hash mapping the receivers qualified primary key column(s) to their values.

  Artist[1].qualified_pk_hash
  # => {Sequel[:artists][:id]=>1}
  Artist[[1, 2]].qualified_pk_hash
  # => {Sequel[:artists][:id1]=>1, Sequel[:artists][:id2]=>2}

[Source]

      # File lib/sequel/model/base.rb, line 1391
1391:       def qualified_pk_hash(qualifier=model.table_name)
1392:         model.qualified_primary_key_hash(pk, qualifier)
1393:       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 1403
1403:       def refresh
1404:         raise Sequel::Error, "can't refresh frozen object" if frozen?
1405:         _refresh(this)
1406:         self
1407:       end

reload()

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

[Source]

      # File lib/sequel/model/base.rb, line 1410
1410:       def reload
1411:         refresh
1412:       end

save(opts=OPTS)

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.

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 1439
1439:       def save(opts=OPTS)
1440:         raise Sequel::Error, "can't save frozen object" if frozen?
1441:         set_server(opts[:server]) if opts[:server] 
1442:         unless checked_save_failure(opts){_valid?(opts)}
1443:           raise(ValidationFailed.new(self)) if raise_on_failure?(opts)
1444:           return
1445:         end
1446:         checked_save_failure(opts){checked_transaction(opts){_save(opts)}}
1447:       end

save_changes(opts=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 1458
1458:       def save_changes(opts=OPTS)
1459:         save(Hash[opts].merge!(:changed=>true)) || false if modified? 
1460:       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 1469
1469:       def set(hash)
1470:         set_restricted(hash, :default)
1471:       end

set_fields(hash, fields, opts=nil)

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 1499
1499:       def set_fields(hash, fields, opts=nil)
1500:         opts = if opts
1501:           Hash[model.default_set_fields_options].merge!(opts)
1502:         else
1503:           model.default_set_fields_options
1504:         end
1505: 
1506:         case missing = opts[:missing]
1507:         when :skip, :raise
1508:           do_raise = true if missing == :raise
1509:           fields.each do |f|
1510:             if hash.has_key?(f) 
1511:               set_column_value("#{f}=", hash[f])
1512:             elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1513:               set_column_value("#{sf}=", hash[sf])
1514:             elsif do_raise
1515:               raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
1516:             end
1517:           end
1518:         else
1519:           fields.each{|f| set_column_value("#{f}=", hash[f])}
1520:         end
1521:         self
1522:       end

set_server(s)

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

[Source]

      # File lib/sequel/model/base.rb, line 1525
1525:       def set_server(s)
1526:         @server = s
1527:         @this = @this.server(s) if @this
1528:         self
1529:       end

singleton_method_added(meth)

Clear the setter_methods cache when a method is added

[Source]

      # File lib/sequel/model/base.rb, line 1532
1532:       def singleton_method_added(meth)
1533:         @singleton_setter_added = true if meth.to_s.end_with?('=')
1534:         super
1535:       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 1541
1541:       def this
1542:         return @this if @this
1543:         raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset
1544:         @this = use_server(ds.where(pk_hash))
1545:       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 1550
1550:       def update(hash)
1551:         update_restricted(hash, :default)
1552:       end

update_fields(hash, fields, opts=nil)

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 1562
1562:       def update_fields(hash, fields, opts=nil)
1563:         set_fields(hash, fields, opts)
1564:         save_changes
1565:       end

valid?(opts = OPTS)

Validates the object and returns true if no errors are reported.

  artist.set(name: 'Valid').valid? # => true
  artist.set(name: 'Invalid').valid? # => false
  artist.errors.full_messages # => ['name cannot be Invalid']

[Source]

      # File lib/sequel/model/base.rb, line 1581
1581:       def valid?(opts = OPTS)
1582:         begin
1583:           _valid?(opts)
1584:         rescue HookFailed
1585:           false
1586:         end
1587:       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 1573
1573:       def validate
1574:       end