Sequel::Model instance methods that implement basic model functionality.
All of the methods in HOOKS create instance methods that are called by Sequel when the appropriate action occurs. For example, when destroying a model object, Sequel will call before_destroy, do the destroy, and then call after_destroy.
The following instance_methods all call the class method of the same name: columns, dataset, db, primary_key, db_schema.
The following instance methods allow boolean flags to be set on a per-object basis: raise_on_save_failure, raise_on_typecast_failure, require_modification, strict_param_setting, typecast_empty_string_to_nil, typecast_on_assignment, use_transactions. If they are not used, the object will default to whatever the model setting is.
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.
# File lib/sequel/model/base.rb, line 555 def initialize(values = {}, from_db = false) if from_db @new = false set_values(values) else @values = {} @new = true @modified = true set(values) changed_columns.clear yield self if block_given? end after_initialize end
Alias of eql?
# File lib/sequel/model/base.rb, line 592 def ==(obj) eql?(obj) end
If pk is not nil, true only if the objects have the same class and pk. If pk is nil, false.
# File lib/sequel/model/base.rb, line 598 def ===(obj) pk.nil? ? false : (obj.class == model) && (obj.pk == pk) end
Returns value of the column’s attribute.
# File lib/sequel/model/base.rb, line 571 def [](column) @values[column] 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.
# File lib/sequel/model/base.rb, line 579 def []=(column, value) # If it is new, it doesn't have a value yet, so we should # definitely set the new value. # If the column isn't in @values, we can't assume it is # NULL in the database, so assume it has changed. v = typecast_value(column, value) if new? || !@values.include?(column) || v != @values[column] changed_columns << column unless changed_columns.include?(column) @values[column] = v end end
The autoincrementing primary key for this model object. Should be overridden if you have a composite primary key with one part of it being autoincrementing.
# File lib/sequel/model/base.rb, line 611 def autoincrementing_primary_key primary_key end
The columns that have been updated. This isn’t completely accurate, see Model#[]=.
# File lib/sequel/model/base.rb, line 617 def changed_columns @changed_columns ||= [] end
Deletes and returns self. Does not run destroy hooks. Look into using destroy instead.
# File lib/sequel/model/base.rb, line 623 def delete _delete self 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.
# File lib/sequel/model/base.rb, line 634 def destroy(opts = {}) checked_save_failure{checked_transaction(opts){_destroy(opts)}} end
Iterates through all of the current values using each.
Example:
Ticket.find(7).each { |k, v| puts "#{k} => #{v}" }
# File lib/sequel/model/base.rb, line 642 def each(&block) @values.each(&block) end
Compares model instances by values.
# File lib/sequel/model/base.rb, line 647 def eql?(obj) (obj.class == model) && (obj.values == @values) end
Returns the validation errors associated with this object.
# File lib/sequel/model/base.rb, line 652 def errors @errors ||= Errors.new end
Returns true when current instance exists, false otherwise. Generally an object that isn’t new will exist unless it has been deleted.
# File lib/sequel/model/base.rb, line 659 def exists? this.count > 0 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).
# File lib/sequel/model/base.rb, line 665 def hash [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash end
Returns value for the :id attribute, even if the primary key is not id. To get the primary key value, use pk.
# File lib/sequel/model/base.rb, line 671 def id @values[:id] end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 677 def inspect "#<#{model.name} @values=#{inspect_values}>" end
Returns the keys in values. May not include all column names.
# File lib/sequel/model/base.rb, line 682 def keys @values.keys end
Refresh this record using for_update unless this is a new record. Returns self.
# File lib/sequel/model/base.rb, line 687 def lock! new? ? self : _refresh(this.for_update) end
Remove elements of the model object that make marshalling fail. Returns self.
# File lib/sequel/model/base.rb, line 692 def marshallable! @this = nil self end
Explicitly mark the object as modified, so save_changes/update will run callbacks even if no columns have changed.
# File lib/sequel/model/base.rb, line 699 def modified! @modified = true 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.
# File lib/sequel/model/base.rb, line 706 def modified? @modified || !changed_columns.empty? end
Returns true if the current instance represents a new record.
# File lib/sequel/model/base.rb, line 711 def new? @new 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.
# File lib/sequel/model/base.rb, line 718 def pk raise(Error, "No primary key is associated with this model") unless key = primary_key key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key] end
Returns a hash identifying the model instance. It should be true that:
Model[model_instance.pk_hash] === model_instance
# File lib/sequel/model/base.rb, line 726 def pk_hash model.primary_key_hash(pk) end
Reloads attributes from database and returns self. Also clears all cached association and changed_columns information. Raises an Error if the record no longer exists in the database.
# File lib/sequel/model/base.rb, line 733 def refresh _refresh(this) end
Alias of refresh, but not aliased directly to make overriding in a plugin easier.
# File lib/sequel/model/base.rb, line 738 def reload refresh end
Creates or updates the record, after making sure the record is valid. If the record is not valid, or before_save, before_create (if new?), or before_update (if !new?) return false, returns nil unless raise_on_save_failure is true (if it is true, it raises an error). Otherwise, returns self. You can provide an optional list of columns to update, in which case it only updates those columns.
Takes the following options:
:changed - save all changed columns, instead of all columns or the columns given
:transaction - set to false not to use a transaction
:validate - set to false not to validate the model before saving
# File lib/sequel/model/base.rb, line 755 def save(*columns) opts = columns.last.is_a?(Hash) ? columns.pop : {} if opts[:validate] != false and !valid? raise(ValidationFailed.new(errors)) if raise_on_save_failure return end checked_save_failure{checked_transaction(opts){_save(columns, opts)}} 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.
# File lib/sequel/model/base.rb, line 767 def save_changes(opts={}) save(opts.merge(:changed=>true)) || false if modified? 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.
# File lib/sequel/model/base.rb, line 775 def set(hash) set_restricted(hash, nil, nil) end
Set all values using the entries in the hash, ignoring any setting of allowed_columns or restricted columns in the model.
# File lib/sequel/model/base.rb, line 781 def set_all(hash) set_restricted(hash, false, false) end
Set all values using the entries in the hash, except for the keys given in except.
# File lib/sequel/model/base.rb, line 787 def set_except(hash, *except) set_restricted(hash, false, except.flatten) 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.
# File lib/sequel/model/base.rb, line 793 def set_fields(hash, fields) fields.each{|f| send("#{f}=", hash[f])} self end
Set the values using the entries in the hash, only if the key is included in only.
# File lib/sequel/model/base.rb, line 800 def set_only(hash, *only) set_restricted(hash, only.flatten, false) end
Returns (naked) dataset that should return only this instance.
# File lib/sequel/model/base.rb, line 805 def this @this ||= model.dataset.filter(pk_hash).limit(1).naked end
Runs set with the passed hash and then runs save_changes.
# File lib/sequel/model/base.rb, line 810 def update(hash) update_restricted(hash, nil, nil) end
Update all values using the entries in the hash, ignoring any setting of allowed_columns or restricted columns in the model.
# File lib/sequel/model/base.rb, line 816 def update_all(hash) update_restricted(hash, false, false) end
Update all values using the entries in the hash, except for the keys given in except.
# File lib/sequel/model/base.rb, line 822 def update_except(hash, *except) update_restricted(hash, false, except.flatten) end
Update the instances values by calling set_fields with the hash and fields, then save any changes to the record. Returns self.
# File lib/sequel/model/base.rb, line 828 def update_fields(hash, fields) set_fields(hash, fields) save_changes end
Update the values using the entries in the hash, only if the key is included in only.
# File lib/sequel/model/base.rb, line 835 def update_only(hash, *only) update_restricted(hash, only.flatten, false) end
Validates the object and returns true if no errors are reported.
# File lib/sequel/model/base.rb, line 847 def valid? errors.clear if before_validation == false save_failure(:validation) if raise_on_save_failure return false end validate after_validation errors.empty? 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.
# File lib/sequel/model/base.rb, line 843 def validate end
Generated with the Darkfish Rdoc Generator 2.