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 : | should only be set by Model.load, forget it exists. |
Artist.new(:name=>'Bob') Artist.new do |a| a.name = 'Bob' end
# File lib/sequel/model/base.rb, line 747 747: def initialize(values = {}, from_db = false) 748: if from_db 749: @new = false 750: set_values(values) 751: else 752: @values = {} 753: @new = true 754: @modified = true 755: initialize_set(values) 756: changed_columns.clear 757: yield self if block_given? 758: end 759: after_initialize 760: 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 800 800: def ===(obj) 801: pk.nil? ? false : (obj.class == model) && (obj.pk == pk) 802: end
Returns value of the column‘s attribute.
Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb, line 765 765: def [](column) 766: @values[column] 767: 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 a 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 777 777: def []=(column, value) 778: # If it is new, it doesn't have a value yet, so we should 779: # definitely set the new value. 780: # If the column isn't in @values, we can't assume it is 781: # NULL in the database, so assume it has changed. 782: v = typecast_value(column, value) 783: if new? || !@values.include?(column) || v != (c = @values[column]) || v.class != c.class 784: changed_columns << column unless changed_columns.include?(column) 785: @values[column] = v 786: end 787: 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 826 826: def changed_columns 827: @changed_columns ||= [] 828: 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 849 849: def destroy(opts = {}) 850: checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}} 851: 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 867 867: def eql?(obj) 868: (obj.class == model) && (obj.values == @values) 869: end
Returns true when current instance exists, false otherwise. Generally an object that isn‘t new will exist unless it has been deleted.
Artist[1].exists? # SELECT 1 FROM artists WHERE (id = 1) # => true
# File lib/sequel/model/base.rb, line 883 883: def exists? 884: !this.get(1).nil? 885: 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 894 894: def hash 895: [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash 896: end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 908 908: def inspect 909: "#<#{model.name} @values=#{inspect_values}>" 910: 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 930 930: def lock! 931: new? ? self : _refresh(this.for_update) 932: 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 939 939: def marshallable! 940: @this = nil 941: self 942: 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 951 951: def modified! 952: @modified = true 953: 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 963 963: def modified? 964: @modified || !changed_columns.empty? 965: 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 981 981: def pk 982: raise(Error, "No primary key is associated with this model") unless key = primary_key 983: key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key] 984: 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 1002 1002: def refresh 1003: _refresh(this) 1004: 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.
Takes the following options:
# File lib/sequel/model/base.rb, line 1036 1036: def save(*columns) 1037: opts = columns.last.is_a?(Hash) ? columns.pop : {} 1038: if opts[:validate] != false 1039: unless checked_save_failure(opts){_valid?(true, opts)} 1040: raise(ValidationFailed.new(errors)) if raise_on_failure?(opts) 1041: return 1042: end 1043: end 1044: checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}} 1045: 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 1056 1056: def save_changes(opts={}) 1057: save(opts.merge(:changed=>true)) || false if modified? 1058: 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 1067 1067: def set(hash) 1068: set_restricted(hash, nil, nil) 1069: 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 1077 1077: def set_all(hash) 1078: set_restricted(hash, false, false) 1079: 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 1099 1099: def set_fields(hash, fields) 1100: fields.each{|f| send("#{f}=", hash[f])} 1101: self 1102: end
Set the values using the entries in the hash, only if the key is included in only.
artist.set_only({:name=>'Jim'}, :name) artist.name # => 'Jim' artist.set_only({:hometown=>'LA'}, :name) # Raise error
# File lib/sequel/model/base.rb, line 1111 1111: def set_only(hash, *only) 1112: set_restricted(hash, only.flatten, false) 1113: end
Clear the setter_methods cache when a method is added
# File lib/sequel/model/base.rb, line 1116 1116: def singleton_method_added(meth) 1117: @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP 1118: super 1119: 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 1132 1132: def update(hash) 1133: update_restricted(hash, nil, nil) 1134: 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 1141 1141: def update_all(hash) 1142: update_restricted(hash, false, false) 1143: end
Update all values using the entries in the hash, except for the keys given in except.
artist.update_except({:name=>'Jim'}, :hometown) # UPDATE artists SET name = 'Jim' WHERE (id = 1)
# File lib/sequel/model/base.rb, line 1149 1149: def update_except(hash, *except) 1150: update_restricted(hash, false, except.flatten) 1151: 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 1161 1161: def update_fields(hash, fields) 1162: set_fields(hash, fields) 1163: save_changes 1164: end
Update the values using the entries in the hash, only if the key is included in only.
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 1173 1173: def update_only(hash, *only) 1174: update_restricted(hash, only.flatten, false) 1175: 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 1191 1191: def valid?(opts = {}) 1192: _valid?(false, opts) 1193: 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 1183 1183: def validate 1184: end