Module | Sequel::Model::InstanceMethods |
In: |
lib/sequel/model/base.rb
|
Sequel::Model instance methods that implement basic model functionality.
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', ...} |
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
# File lib/sequel/model/base.rb, line 696 696: def initialize(values = {}, from_db = false) 697: if from_db 698: @new = false 699: set_values(values) 700: else 701: @values = {} 702: @new = true 703: @modified = true 704: set(values) 705: changed_columns.clear 706: yield self if block_given? 707: end 708: after_initialize 709: 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
# File lib/sequel/model/base.rb, line 749 749: def ===(obj) 750: pk.nil? ? false : (obj.class == model) && (obj.pk == pk) 751: end
Returns value of the column‘s attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb, line 714 714: def [](column) 715: @values[column] 716: 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 a 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'}
# File lib/sequel/model/base.rb, line 726 726: def []=(column, value) 727: # If it is new, it doesn't have a value yet, so we should 728: # definitely set the new value. 729: # If the column isn't in @values, we can't assume it is 730: # NULL in the database, so assume it has changed. 731: v = typecast_value(column, value) 732: if new? || !@values.include?(column) || v != (c = @values[column]) || v.class != c.class 733: changed_columns << column unless changed_columns.include?(column) 734: @values[column] = v 735: end 736: 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]
# File lib/sequel/model/base.rb, line 775 775: def changed_columns 776: @changed_columns ||= [] 777: 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, ...}>
# File lib/sequel/model/base.rb, line 798 798: def destroy(opts = {}) 799: checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 800: end
Compares model instances by values.
Artist[1] == Artist[1] # => true Artist.new == Artist.new # => true Artist[1].set(:name=>'Bob') == Artist[1] # => false
# File lib/sequel/model/base.rb, line 816 816: def eql?(obj) 817: (obj.class == model) && (obj.values == @values) 818: end
Returns true when current instance exists, false otherwise. Generally an object that isn‘t new will exist unless it has been deleted.
Artist[1].exists? # SELECT 1 FROM artists WHERE (id = 1) # => true
# File lib/sequel/model/base.rb, line 832 832: def exists? 833: !this.get(1).nil? 834: 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
# File lib/sequel/model/base.rb, line 843 843: def hash 844: [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash 845: end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 857 857: def inspect 858: "#<#{model.name} @values=#{inspect_values}>" 859: 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
# File lib/sequel/model/base.rb, line 879 879: def lock! 880: new? ? self : _refresh(this.for_update) 881: end
Remove elements of the model object that make marshalling fail. Returns self.
a = Artist[1] a.marshallable! Marshal.dump(a)
# File lib/sequel/model/base.rb, line 888 888: def marshallable! 889: @this = nil 890: self 891: 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
# File lib/sequel/model/base.rb, line 900 900: def modified! 901: @modified = true 902: 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
# File lib/sequel/model/base.rb, line 912 912: def modified? 913: @modified || !changed_columns.empty? 914: 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]
# File lib/sequel/model/base.rb, line 930 930: def pk 931: raise(Error, "No primary key is associated with this model") unless key = primary_key 932: key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key] 933: 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'
# File lib/sequel/model/base.rb, line 951 951: def refresh 952: _refresh(this) 953: end
Creates or updates the record, after making sure the record is valid and before hooks execute successfully. Fails if:
If save fails and either raise_on_save_failure or the :raise_on_failure option is true, it raises ValidationFailed or BeforeHookFailed. 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.
Takes the following options:
# File lib/sequel/model/base.rb, line 985 985: def save(*columns) 986: opts = columns.last.is_a?(Hash) ? columns.pop : {} 987: if opts[:validate] != false and !valid?(opts) 988: raise(ValidationFailed.new(errors)) if raise_on_failure?(opts) 989: return 990: end 991: checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}} 992: 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', ...}
# File lib/sequel/model/base.rb, line 1003 1003: def save_changes(opts={}) 1004: save(opts.merge(:changed=>true)) || false if modified? 1005: 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'
# File lib/sequel/model/base.rb, line 1014 1014: def set(hash) 1015: set_restricted(hash, nil, nil) 1016: 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'
# File lib/sequel/model/base.rb, line 1024 1024: def set_all(hash) 1025: set_restricted(hash, false, false) 1026: 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.
artist.set_fields({:name=>'Jim'}, :name) artist.name # => 'Jim' artist.set_fields({:hometown=>'LA'}, :name) artist.name # => nil artist.hometown # => 'Sac'
# File lib/sequel/model/base.rb, line 1046 1046: def set_fields(hash, fields) 1047: fields.each{|f| send("#{f}=", hash[f])} 1048: self 1049: end
Set the values using the entries in the hash, only if the key is included in only.
artist.set_only({:name=>'Jim'}, :name) artist.name # => 'Jim' artist.set_only({:hometown=>'LA'}, :name) # Raise error
# File lib/sequel/model/base.rb, line 1058 1058: def set_only(hash, *only) 1059: set_restricted(hash, only.flatten, false) 1060: end
Clear the setter_methods cache when a method is added
# File lib/sequel/model/base.rb, line 1063 1063: def singleton_method_added(meth) 1064: @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP 1065: super 1066: end
Runs set with the passed hash and then runs save_changes.
artist.update(:name=>'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)
# File lib/sequel/model/base.rb, line 1079 1079: def update(hash) 1080: update_restricted(hash, nil, nil) 1081: 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)
# File lib/sequel/model/base.rb, line 1088 1088: def update_all(hash) 1089: update_restricted(hash, false, false) 1090: end
Update all values using the entries in the hash, except for the keys given in except.
artist.update_except({:name=>'Jim'}, :hometown) # UPDATE artists SET name = 'Jim' WHERE (id = 1)
# File lib/sequel/model/base.rb, line 1096 1096: def update_except(hash, *except) 1097: update_restricted(hash, false, except.flatten) 1098: end
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)
# File lib/sequel/model/base.rb, line 1108 1108: def update_fields(hash, fields) 1109: set_fields(hash, fields) 1110: save_changes 1111: end
Update the values using the entries in the hash, only if the key is included in only.
artist.update_only({:name=>'Jim'}, :name) # UPDATE artists SET name = 'Jim' WHERE (id = 1) artist.update_only({:hometown=>'LA'}, :name) # Raise Error
# File lib/sequel/model/base.rb, line 1120 1120: def update_only(hash, *only) 1121: update_restricted(hash, only.flatten, false) 1122: 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']
# File lib/sequel/model/base.rb, line 1138 1138: def valid?(opts = {}) 1139: errors.clear 1140: if before_validation == false 1141: raise_hook_failure(:validation) if raise_on_failure?(opts) 1142: return false 1143: end 1144: validate 1145: after_validation 1146: errors.empty? 1147: 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.
# File lib/sequel/model/base.rb, line 1130 1130: def validate 1131: end