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 853 853: def initialize(values = {}, from_db = false) 854: if from_db 855: set_values(values) 856: else 857: @values = {} 858: @new = true 859: @modified = true 860: initialize_set(values) 861: changed_columns.clear 862: yield self if block_given? 863: end 864: after_initialize 865: 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 905 905: def ===(obj) 906: pk.nil? ? false : (obj.class == model) && (obj.pk == pk) 907: end
Returns value of the column‘s attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb, line 870 870: def [](column) 871: @values[column] 872: 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 882 882: def []=(column, value) 883: # If it is new, it doesn't have a value yet, so we should 884: # definitely set the new value. 885: # If the column isn't in @values, we can't assume it is 886: # NULL in the database, so assume it has changed. 887: v = typecast_value(column, value) 888: if new? || !@values.include?(column) || v != (c = @values[column]) || v.class != c.class 889: changed_columns << column unless changed_columns.include?(column) 890: @values[column] = v 891: end 892: 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 931 931: def changed_columns 932: @changed_columns ||= [] 933: 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 954 954: def destroy(opts = {}) 955: checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 956: 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 972 972: def eql?(obj) 973: (obj.class == model) && (obj.values == @values) 974: 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 992 992: def exists? 993: new? ? false : !this.get(1).nil? 994: 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 1010 1010: def hash 1011: case primary_key 1012: when Array 1013: [model, !pk.all? ? @values.sort_by{|k,v| k.to_s} : pk].hash 1014: when Symbol 1015: [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash 1016: else 1017: [model, @values.sort_by{|k,v| k.to_s}].hash 1018: end 1019: end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 1031 1031: def inspect 1032: "#<#{model.name} @values=#{inspect_values}>" 1033: 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 1053 1053: def lock! 1054: new? ? self : _refresh(this.for_update) 1055: 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 1062 1062: def marshallable! 1063: @this = nil 1064: self 1065: 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 1074 1074: def modified! 1075: @modified = true 1076: 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 1086 1086: def modified? 1087: @modified || !changed_columns.empty? 1088: 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 1104 1104: def pk 1105: raise(Error, "No primary key is associated with this model") unless key = primary_key 1106: key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key] 1107: 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 1125 1125: def refresh 1126: _refresh(this) 1127: 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 1161 1161: def save(*columns) 1162: opts = columns.last.is_a?(Hash) ? columns.pop : {} 1163: set_server(opts[:server]) if opts[:server] 1164: if opts[:validate] != false 1165: unless checked_save_failure(opts){_valid?(true, opts)} 1166: raise(ValidationFailed.new(errors)) if raise_on_failure?(opts) 1167: return 1168: end 1169: end 1170: checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}} 1171: 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 1182 1182: def save_changes(opts={}) 1183: save(opts.merge(:changed=>true)) || false if modified? 1184: 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 1193 1193: def set(hash) 1194: set_restricted(hash, nil, nil) 1195: 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 1203 1203: def set_all(hash) 1204: set_restricted(hash, false, false) 1205: 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 1213 1213: def set_except(hash, *except) 1214: set_restricted(hash, false, except.flatten) 1215: 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 1226 1226: def set_fields(hash, fields) 1227: fields.each{|f| send("#{f}=", hash[f])} 1228: self 1229: 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 1239 1239: def set_only(hash, *only) 1240: set_restricted(hash, only.flatten, false) 1241: end
Clear the setter_methods cache when a method is added
# File lib/sequel/model/base.rb, line 1258 1258: def singleton_method_added(meth) 1259: @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP 1260: super 1261: 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 1274 1274: def update(hash) 1275: update_restricted(hash, nil, nil) 1276: 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 1283 1283: def update_all(hash) 1284: update_restricted(hash, false, false) 1285: 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 1292 1292: def update_except(hash, *except) 1293: update_restricted(hash, false, except.flatten) 1294: 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 1304 1304: def update_fields(hash, fields) 1305: set_fields(hash, fields) 1306: save_changes 1307: 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 1317 1317: def update_only(hash, *only) 1318: update_restricted(hash, only.flatten, false) 1319: 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 1335 1335: def valid?(opts = {}) 1336: _valid?(false, opts) 1337: 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 1327 1327: def validate 1328: end