Module | Sequel::Model::InstanceMethods |
In: |
lib/sequel/plugins/prepared_statements.rb
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 argument. 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 | [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.
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 1171 1171: def initialize(values = {}) 1172: @values = {} 1173: @new = true 1174: @modified = true 1175: initialize_set(values) 1176: changed_columns.clear 1177: yield self if block_given? 1178: 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 1218 1218: def ===(obj) 1219: pk.nil? ? false : (obj.class == model) && (obj.pk == pk) 1220: end
Returns value of the column‘s attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb, line 1183 1183: def [](column) 1184: @values[column] 1185: 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 1195 1195: def []=(column, value) 1196: # If it is new, it doesn't have a value yet, so we should 1197: # definitely set the new value. 1198: # If the column isn't in @values, we can't assume it is 1199: # NULL in the database, so assume it has changed. 1200: v = typecast_value(column, value) 1201: vals = @values 1202: if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class 1203: change_column_value(column, v) 1204: end 1205: 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 1241 1241: def cancel_action(msg=nil) 1242: raise_hook_failure(msg) 1243: 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 1252 1252: def changed_columns 1253: @changed_columns ||= [] 1254: 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 1261 1261: def delete 1262: raise Sequel::Error, "can't delete frozen object" if frozen? 1263: _delete 1264: self 1265: end
Like delete but runs hooks before and after delete. If before_destroy returns false, returns false without deleting the object from 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 1276 1276: def destroy(opts = OPTS) 1277: raise Sequel::Error, "can't destroy frozen object" if frozen? 1278: checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 1279: 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 1295 1295: def eql?(obj) 1296: (obj.class == model) && (obj.values == @values) 1297: 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 1315 1315: def exists? 1316: new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil? 1317: 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 1329 1329: def freeze 1330: values.freeze 1331: changed_columns.freeze 1332: unless errors.frozen? 1333: validate 1334: errors.freeze 1335: end 1336: this.freeze if !new? && model.primary_key 1337: super 1338: 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 1347 1347: def hash 1348: case primary_key 1349: when Array 1350: [model, !pk.all? ? @values : pk].hash 1351: when Symbol 1352: [model, pk.nil? ? @values : pk].hash 1353: else 1354: [model, @values].hash 1355: end 1356: end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 1368 1368: def inspect 1369: "#<#{model.name} @values=#{inspect_values}>" 1370: 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(:name=>'A') end
# File lib/sequel/model/base.rb, line 1390 1390: def lock! 1391: _refresh(this.for_update) unless new? 1392: self 1393: 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 1400 1400: def marshallable! 1401: @this = nil 1402: self 1403: 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 1420 1420: def modified!(column=nil) 1421: if column && !changed_columns.include?(column) 1422: changed_columns << column 1423: end 1424: @modified = true 1425: 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 1442 1442: def modified?(column=nil) 1443: if column 1444: changed_columns.include?(column) 1445: else 1446: @modified || !changed_columns.empty? 1447: end 1448: 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 1464 1464: def pk 1465: raise(Error, "No primary key is associated with this model") unless key = primary_key 1466: if key.is_a?(Array) 1467: vals = @values 1468: key.map{|k| vals[k]} 1469: else 1470: @values[key] 1471: end 1472: end
Returns a hash mapping the receivers primary key column(s) to their values.
Artist[1].qualified_pk_hash # => {Sequel.qualify(:artists, :id)=>1} Artist[[1, 2]].qualified_pk_hash # => {Sequel.qualify(:artists, :id1)=>1, Sequel.qualify(:artists, :id2)=>2}
# File lib/sequel/model/base.rb, line 1488 1488: def qualified_pk_hash(qualifier=model.table_name) 1489: model.qualified_primary_key_hash(pk, qualifier) 1490: 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 1500 1500: def refresh 1501: raise Sequel::Error, "can't refresh frozen object" if frozen? 1502: _refresh(this) 1503: self 1504: 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 1539 1539: def save(opts=OPTS) 1540: raise Sequel::Error, "can't save frozen object" if frozen? 1541: set_server(opts[:server]) if opts[:server] 1542: _before_validation 1543: if opts[:validate] != false 1544: unless checked_save_failure(opts){_valid?(true, opts)} 1545: raise(ValidationFailed.new(self)) if raise_on_failure?(opts) 1546: return 1547: end 1548: end 1549: checked_save_failure(opts){checked_transaction(opts){_save(opts)}} 1550: 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 1561 1561: def save_changes(opts=OPTS) 1562: save(opts.merge(:changed=>true)) || false if modified? 1563: 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 1572 1572: def set(hash) 1573: set_restricted(hash, :default) 1574: 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 1582 1582: def set_all(hash) 1583: set_restricted(hash, :all) 1584: 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 1612 1612: def set_fields(hash, fields, opts=nil) 1613: opts = if opts 1614: model.default_set_fields_options.merge(opts) 1615: else 1616: model.default_set_fields_options 1617: end 1618: 1619: case opts[:missing] 1620: when :skip 1621: fields.each do |f| 1622: if hash.has_key?(f) 1623: set_column_value("#{f}=", hash[f]) 1624: elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1625: set_column_value("#{sf}=", hash[sf]) 1626: end 1627: end 1628: when :raise 1629: fields.each do |f| 1630: if hash.has_key?(f) 1631: set_column_value("#{f}=", hash[f]) 1632: elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s) 1633: set_column_value("#{sf}=", hash[sf]) 1634: else 1635: raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}") 1636: end 1637: end 1638: else 1639: fields.each{|f| set_column_value("#{f}=", hash[f])} 1640: end 1641: self 1642: 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 1652 1652: def set_only(hash, *only) 1653: set_restricted(hash, only.flatten) 1654: end
Clear the setter_methods cache when a method is added
# File lib/sequel/model/base.rb, line 1664 1664: def singleton_method_added(meth) 1665: @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP 1666: super 1667: 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 1673 1673: def this 1674: return @this if @this 1675: raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset 1676: 1677: cond = if ds.joined_dataset? 1678: qualified_pk_hash 1679: else 1680: pk_hash 1681: end 1682: 1683: @this = use_server(ds.where(cond)) 1684: 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 1689 1689: def update(hash) 1690: update_restricted(hash, :default) 1691: 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 1698 1698: def update_all(hash) 1699: update_restricted(hash, :all) 1700: 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 1710 1710: def update_fields(hash, fields, opts=nil) 1711: set_fields(hash, fields, opts) 1712: save_changes 1713: 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 1723 1723: def update_only(hash, *only) 1724: update_restricted(hash, only.flatten) 1725: end
Whether prepared statements should be used for the given type of query (:insert, :insert_select, :refresh, :update, or :delete). True by default, can be overridden in other plugins to disallow prepared statements for specific types of queries.
# File lib/sequel/plugins/prepared_statements.rb, line 8 8: def use_prepared_statements_for?(type) 9: true 10: 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 1741 1741: def valid?(opts = OPTS) 1742: _before_validation 1743: _valid?(false, opts) 1744: 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 1733 1733: def validate 1734: end