Module | Sequel::Model::InstanceMethods |
In: |
lib/sequel/model/base.rb
|
Sequel::Model instance methods that implement basic model functionality.
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. |
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', ...} |
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
# File lib/sequel/model/base.rb, line 1058 1058: def initialize(values = {}) 1059: @values = {} 1060: @new = true 1061: @modified = true 1062: initialize_set(values) 1063: changed_columns.clear 1064: yield self if block_given? 1065: 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 1105 1105: def ===(obj) 1106: pk.nil? ? false : (obj.class == model) && (obj.pk == pk) 1107: end
Returns value of the column‘s attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb, line 1070 1070: def [](column) 1071: @values[column] 1072: 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 1082 1082: def []=(column, value) 1083: # If it is new, it doesn't have a value yet, so we should 1084: # definitely set the new value. 1085: # If the column isn't in @values, we can't assume it is 1086: # NULL in the database, so assume it has changed. 1087: v = typecast_value(column, value) 1088: vals = @values 1089: if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class 1090: change_column_value(column, v) 1091: end 1092: end
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.
# File lib/sequel/model/base.rb, line 1128 1128: def cancel_action(msg=nil) 1129: raise_hook_failure(msg) 1130: 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 1139 1139: def changed_columns 1140: @changed_columns ||= [] 1141: 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 1148 1148: def delete 1149: raise Sequel::Error, "can't delete frozen object" if frozen? 1150: _delete 1151: self 1152: end
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, ...}>
# File lib/sequel/model/base.rb, line 1160 1160: def destroy(opts = OPTS) 1161: raise Sequel::Error, "can't destroy frozen object" if frozen? 1162: checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 1163: 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 1179 1179: def eql?(obj) 1180: (obj.class == model) && (obj.values == @values) 1181: 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 1199 1199: def exists? 1200: new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil? 1201: 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 1213 1213: def freeze 1214: values.freeze 1215: changed_columns.freeze 1216: unless errors.frozen? 1217: validate 1218: errors.freeze 1219: end 1220: this if !new? && model.primary_key 1221: super 1222: 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 1231 1231: def hash 1232: case primary_key 1233: when Array 1234: [model, !pk.all? ? @values : pk].hash 1235: when Symbol 1236: [model, pk.nil? ? @values : pk].hash 1237: else 1238: [model, @values].hash 1239: end 1240: end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 1252 1252: def inspect 1253: "#<#{model.name} @values=#{inspect_values}>" 1254: end
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
# File lib/sequel/model/base.rb, line 1288 1288: def lock!(style=:update) 1289: _refresh(this.lock_style(style)) unless new? 1290: self 1291: 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 1298 1298: def marshallable! 1299: @this = nil 1300: self 1301: 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 1318 1318: def modified!(column=nil) 1319: if column && !changed_columns.include?(column) 1320: changed_columns << column 1321: end 1322: @modified = true 1323: 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 1340 1340: def modified?(column=nil) 1341: if column 1342: changed_columns.include?(column) 1343: else 1344: @modified || !changed_columns.empty? 1345: end 1346: 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 1362 1362: def pk 1363: raise(Error, "No primary key is associated with this model") unless key = primary_key 1364: if key.is_a?(Array) 1365: vals = @values 1366: key.map{|k| vals[k]} 1367: else 1368: @values[key] 1369: end 1370: end
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}
# File lib/sequel/model/base.rb, line 1386 1386: def qualified_pk_hash(qualifier=model.table_name) 1387: model.qualified_primary_key_hash(pk, qualifier) 1388: 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 1398 1398: def refresh 1399: raise Sequel::Error, "can't refresh frozen object" if frozen? 1400: _refresh(this) 1401: self 1402: 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.
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 1434 1434: def save(opts=OPTS) 1435: raise Sequel::Error, "can't save frozen object" if frozen? 1436: set_server(opts[:server]) if opts[:server] 1437: unless checked_save_failure(opts){_valid?(opts)} 1438: raise(ValidationFailed.new(self)) if raise_on_failure?(opts) 1439: return 1440: end 1441: checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 1442: 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 1453 1453: def save_changes(opts=OPTS) 1454: save(Hash[opts].merge!(:changed=>true)) || false if modified? 1455: 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 1464 1464: def set(hash) 1465: set_restricted(hash, :default) 1466: 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 1494 1494: def set_fields(hash, fields, opts=nil) 1495: opts = if opts 1496: Hash[model.default_set_fields_options].merge!(opts) 1497: else 1498: model.default_set_fields_options 1499: end 1500: 1501: case opts[:missing] 1502: when :skip 1503: fields.each do |f| 1504: if hash.has_key?(f) 1505: set_column_value("#{f}=", hash[f]) 1506: elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1507: set_column_value("#{sf}=", hash[sf]) 1508: end 1509: end 1510: when :raise 1511: fields.each do |f| 1512: if hash.has_key?(f) 1513: set_column_value("#{f}=", hash[f]) 1514: elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1515: set_column_value("#{sf}=", hash[sf]) 1516: else 1517: raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1518: end 1519: end 1520: else 1521: fields.each{|f| set_column_value("#{f}=", hash[f])} 1522: end 1523: self 1524: end
Clear the setter_methods cache when a method is added
# File lib/sequel/model/base.rb, line 1534 1534: def singleton_method_added(meth) 1535: @singleton_setter_added = true if meth.to_s.end_with?('=') 1536: super 1537: end
Returns (naked) dataset that should return only this instance.
Artist[1].this # SELECT * FROM artists WHERE (id = 1) LIMIT 1
# File lib/sequel/model/base.rb, line 1543 1543: def this 1544: return @this if @this 1545: raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1546: @this = use_server(ds.where(pk_hash)) 1547: 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 1552 1552: def update(hash) 1553: update_restricted(hash, :default) 1554: 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 1564 1564: def update_fields(hash, fields, opts=nil) 1565: set_fields(hash, fields, opts) 1566: save_changes 1567: end
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']
# File lib/sequel/model/base.rb, line 1583 1583: def valid?(opts = OPTS) 1584: begin 1585: _valid?(opts) 1586: rescue HookFailed 1587: false 1588: end 1589: 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 1575 1575: def validate 1576: end