| 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 1023
1023: def initialize(values = {}, from_db = false)
1024: if from_db
1025: Sequel::Deprecation.deprecate('Passing two arguments to Model.new', 'Please use Model.call instead')
1026: set_values(values)
1027: else
1028: @values = {}
1029: @new = true
1030: @modified = true
1031: initialize_set(values)
1032: changed_columns.clear
1033: yield self if block_given?
1034: end
1035: after_initialize
1036: 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 1076
1076: def ===(obj)
1077: pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
1078: end
Returns value of the column‘s attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb, line 1041
1041: def [](column)
1042: @values[column]
1043: 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 1053
1053: def []=(column, value)
1054: # If it is new, it doesn't have a value yet, so we should
1055: # definitely set the new value.
1056: # If the column isn't in @values, we can't assume it is
1057: # NULL in the database, so assume it has changed.
1058: v = typecast_value(column, value)
1059: vals = @values
1060: if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
1061: change_column_value(column, v)
1062: end
1063: 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 1102
1102: def changed_columns
1103: @changed_columns ||= []
1104: 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, ...}>
# File lib/sequel/model/base.rb, line 1111
1111: def delete
1112: raise Sequel::Error, "can't delete frozen object" if frozen?
1113: _delete
1114: self
1115: 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 1126
1126: def destroy(opts = {})
1127: raise Sequel::Error, "can't destroy frozen object" if frozen?
1128: checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
1129: 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 1145
1145: def eql?(obj)
1146: (obj.class == model) && (obj.values == @values)
1147: 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 1165
1165: def exists?
1166: new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
1167: 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.
# File lib/sequel/model/base.rb, line 1179
1179: def freeze
1180: values.freeze
1181: changed_columns.freeze
1182: errors
1183: validate
1184: errors.freeze
1185: this.freeze if !new? && model.primary_key
1186: super
1187: 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 1196
1196: def hash
1197: case primary_key
1198: when Array
1199: [model, !pk.all? ? @values : pk].hash
1200: when Symbol
1201: [model, pk.nil? ? @values : pk].hash
1202: else
1203: [model, @values].hash
1204: end
1205: end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 1217
1217: def inspect
1218: "#<#{model.name} @values=#{inspect_values}>"
1219: 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 1239
1239: def lock!
1240: _refresh(this.for_update) unless new?
1241: self
1242: 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 1249
1249: def marshallable!
1250: @this = nil
1251: self
1252: 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')
# File lib/sequel/model/base.rb, line 1269
1269: def modified!(column=nil)
1270: if column && !changed_columns.include?(column)
1271: changed_columns << column
1272: end
1273: @modified = true
1274: 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
# File lib/sequel/model/base.rb, line 1291
1291: def modified?(column=nil)
1292: if column
1293: changed_columns.include?(column)
1294: else
1295: @modified || !changed_columns.empty?
1296: end
1297: 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 1313
1313: def pk
1314: raise(Error, "No primary key is associated with this model") unless key = primary_key
1315: if key.is_a?(Array)
1316: vals = @values
1317: key.map{|k| vals[k]}
1318: else
1319: @values[key]
1320: end
1321: 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 1339
1339: def refresh
1340: raise Sequel::Error, "can't refresh frozen object" if frozen?
1341: _refresh(this)
1342: self
1343: 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 |
| :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 |
# File lib/sequel/model/base.rb, line 1378
1378: def save(*columns)
1379: raise Sequel::Error, "can't save frozen object" if frozen?
1380: opts = columns.last.is_a?(Hash) ? columns.pop : {}
1381:
1382: Sequel::Deprecation.deprecate('Passing columns as separate arguments to Model#save', 'Instead, provide a :columns option with the array of columns to save.') unless columns.empty?
1383: columns.concat(Array(opts[:columns])) if opts[:columns]
1384:
1385: set_server(opts[:server]) if opts[:server]
1386: if opts[:validate] != false
1387: unless checked_save_failure(opts){_valid?(true, opts)}
1388: raise(ValidationFailed.new(self)) if raise_on_failure?(opts)
1389: return
1390: end
1391: end
1392: checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}}
1393: 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 1404
1404: def save_changes(opts={})
1405: save(opts.merge(:changed=>true)) || false if modified?
1406: 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 1415
1415: def set(hash)
1416: set_restricted(hash, nil, nil)
1417: 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'
# File lib/sequel/model/base.rb, line 1425
1425: def set_all(hash)
1426: set_restricted(hash, false, false)
1427: 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 1435
1435: def set_except(hash, *except)
1436: Sequel::Deprecation.deprecate('Model#set_except', 'Please switch to Model#set_only or use the blacklist_security plugin')
1437: set_restricted(hash, false, except.flatten)
1438: 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
# File lib/sequel/model/base.rb, line 1466
1466: def set_fields(hash, fields, opts=nil)
1467: opts = if opts
1468: model.default_set_fields_options.merge(opts)
1469: else
1470: model.default_set_fields_options
1471: end
1472:
1473: case opts[:missing]
1474: when :skip
1475: fields.each do |f|
1476: if hash.has_key?(f)
1477: send("#{f}=", hash[f])
1478: elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1479: send("#{sf}=", hash[sf])
1480: end
1481: end
1482: when :raise
1483: fields.each do |f|
1484: if hash.has_key?(f)
1485: send("#{f}=", hash[f])
1486: elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
1487: send("#{sf}=", hash[sf])
1488: else
1489: raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
1490: end
1491: end
1492: else
1493: fields.each{|f| send("#{f}=", hash[f])}
1494: end
1495: self
1496: 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 1506
1506: def set_only(hash, *only)
1507: set_restricted(hash, only.flatten, false)
1508: end
Clear the setter_methods cache when a method is added
# File lib/sequel/model/base.rb, line 1525
1525: def singleton_method_added(meth)
1526: @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP
1527: super
1528: 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 1541
1541: def update(hash)
1542: update_restricted(hash, nil, nil)
1543: 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)
# File lib/sequel/model/base.rb, line 1550
1550: def update_all(hash)
1551: update_restricted(hash, false, false)
1552: 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 1559
1559: def update_except(hash, *except)
1560: Sequel::Deprecation.deprecate('Model#update_except', 'Please switch to Model#update_only or use the blacklist_security plugin')
1561: update_restricted(hash, false, except.flatten)
1562: 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)
# File lib/sequel/model/base.rb, line 1572
1572: def update_fields(hash, fields, opts=nil)
1573: set_fields(hash, fields, opts)
1574: save_changes
1575: 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 1585
1585: def update_only(hash, *only)
1586: update_restricted(hash, only.flatten, false)
1587: 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 1603
1603: def valid?(opts = {})
1604: _valid?(false, opts)
1605: 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 1595
1595: def validate
1596: end