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 : | only for backwards compatibility, forget it exists. |
Artist.new(:name=>'Bob') Artist.new do |a| a.name = 'Bob' end
# File lib/sequel/model/base.rb, line 858 858: def initialize(values = {}, from_db = false) 859: if from_db 860: set_values(values) 861: else 862: @values = {} 863: @new = true 864: @modified = true 865: initialize_set(values) 866: changed_columns.clear 867: yield self if block_given? 868: end 869: after_initialize 870: 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 910 910: def ===(obj) 911: pk.nil? ? false : (obj.class == model) && (obj.pk == pk) 912: end
Returns value of the column‘s attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb, line 875 875: def [](column) 876: @values[column] 877: 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'}
# File lib/sequel/model/base.rb, line 887 887: def []=(column, value) 888: # If it is new, it doesn't have a value yet, so we should 889: # definitely set the new value. 890: # If the column isn't in @values, we can't assume it is 891: # NULL in the database, so assume it has changed. 892: v = typecast_value(column, value) 893: if new? || !@values.include?(column) || v != (c = @values[column]) || v.class != c.class 894: changed_columns << column unless changed_columns.include?(column) 895: @values[column] = v 896: end 897: 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 936 936: def changed_columns 937: @changed_columns ||= [] 938: 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 959 959: def destroy(opts = {}) 960: checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 961: 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 977 977: def eql?(obj) 978: (obj.class == model) && (obj.values == @values) 979: 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
# File lib/sequel/model/base.rb, line 997 997: def exists? 998: new? ? false : !this.get(1).nil? 999: 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 1015 1015: def hash 1016: case primary_key 1017: when Array 1018: [model, !pk.all? ? @values.sort_by{|k,v| k.to_s} : pk].hash 1019: when Symbol 1020: [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash 1021: else 1022: [model, @values.sort_by{|k,v| k.to_s}].hash 1023: end 1024: end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 1036 1036: def inspect 1037: "#<#{model.name} @values=#{inspect_values}>" 1038: 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 1058 1058: def lock! 1059: new? ? self : _refresh(this.for_update) 1060: 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 1067 1067: def marshallable! 1068: @this = nil 1069: self 1070: 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 1079 1079: def modified! 1080: @modified = true 1081: 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 1091 1091: def modified? 1092: @modified || !changed_columns.empty? 1093: 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 1109 1109: def pk 1110: raise(Error, "No primary key is associated with this model") unless key = primary_key 1111: key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key] 1112: 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 1130 1130: def refresh 1131: _refresh(this) 1132: 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 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 |
# File lib/sequel/model/base.rb, line 1166 1166: def save(*columns) 1167: opts = columns.last.is_a?(Hash) ? columns.pop : {} 1168: set_server(opts[:server]) if opts[:server] 1169: if opts[:validate] != false 1170: unless checked_save_failure(opts){_valid?(true, opts)} 1171: raise(ValidationFailed.new(errors)) if raise_on_failure?(opts) 1172: return 1173: end 1174: end 1175: checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}} 1176: 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 1187 1187: def save_changes(opts={}) 1188: save(opts.merge(:changed=>true)) || false if modified? 1189: 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 1198 1198: def set(hash) 1199: set_restricted(hash, nil, nil) 1200: 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 1208 1208: def set_all(hash) 1209: set_restricted(hash, false, false) 1210: 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'
# File lib/sequel/model/base.rb, line 1218 1218: def set_except(hash, *except) 1219: set_restricted(hash, false, except.flatten) 1220: 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 1231 1231: def set_fields(hash, fields) 1232: fields.each{|f| send("#{f}=", hash[f])} 1233: self 1234: 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
# File lib/sequel/model/base.rb, line 1244 1244: def set_only(hash, *only) 1245: set_restricted(hash, only.flatten, false) 1246: end
Clear the setter_methods cache when a method is added
# File lib/sequel/model/base.rb, line 1263 1263: def singleton_method_added(meth) 1264: @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP 1265: super 1266: 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 1279 1279: def update(hash) 1280: update_restricted(hash, nil, nil) 1281: 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 1288 1288: def update_all(hash) 1289: update_restricted(hash, false, false) 1290: 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)
# File lib/sequel/model/base.rb, line 1297 1297: def update_except(hash, *except) 1298: update_restricted(hash, false, except.flatten) 1299: 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 1309 1309: def update_fields(hash, fields) 1310: set_fields(hash, fields) 1311: save_changes 1312: 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
# File lib/sequel/model/base.rb, line 1322 1322: def update_only(hash, *only) 1323: update_restricted(hash, only.flatten, false) 1324: 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 1340 1340: def valid?(opts = {}) 1341: _valid?(false, opts) 1342: 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 1332 1332: def validate 1333: end