Module | Sequel::Model::InstanceMethods |
In: |
lib/sequel/model/base.rb
lib/sequel/model/deprecated.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. |
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:
# File lib/sequel/model/base.rb, line 503 503: def initialize(values = {}, from_db = false) 504: if from_db 505: @new = false 506: @values = values 507: else 508: @values = {} 509: @new = true 510: set(values) 511: changed_columns.clear 512: yield self if block_given? 513: end 514: after_initialize 515: end
Compares model instances by values.
# File lib/sequel/model/base.rb, line 541 541: def ==(obj) 542: (obj.class == model) && (obj.values == @values) 543: end
Returns value of the column‘s attribute.
# File lib/sequel/model/base.rb, line 518 518: def [](column) 519: @values[column] 520: end
Sets value of the column‘s attribute and marks the column as changed. If the column already has the same value, this is a no-op. Note that changing a columns value and then changing it back will cause the column to appear in changed_columns. Similarly, providing a value that is different from the column‘s current value but is the same after typecasting will also cause changed_columns to include the column.
# File lib/sequel/model/base.rb, line 529 529: def []=(column, value) 530: # If it is new, it doesn't have a value yet, so we should 531: # definitely set the new value. 532: # If the column isn't in @values, we can't assume it is 533: # NULL in the database, so assume it has changed. 534: if new? || !@values.include?(column) || value != @values[column] 535: changed_columns << column unless changed_columns.include?(column) 536: @values[column] = typecast_value(column, value) 537: end 538: end
The current cached associations. A hash with the keys being the association name symbols and the values being the associated object or nil (many_to_one), or the array of associated objects (*_to_many).
# File lib/sequel/model/base.rb, line 561 561: def associations 562: @associations ||= {} 563: end
# File lib/sequel/model/deprecated.rb, line 131 131: def dataset 132: Deprecation.deprecate('Sequel::Model#dataset', 'Use model_object.model.dataset') 133: model.dataset 134: 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.
# File lib/sequel/model/base.rb, line 583 583: def destroy 584: use_transactions ? db.transaction{_destroy} : _destroy 585: end
Returns a string representation of the model instance including the class name and values.
# File lib/sequel/model/base.rb, line 621 621: def inspect 622: "#<#{model.name} @values=#{inspect_values}>" 623: 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 638 638: def pk 639: raise(Error, "No primary key is associated with this model") unless key = primary_key 640: case key 641: when Array 642: key.collect{|k| @values[k]} 643: else 644: @values[key] 645: end 646: 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 658 658: def refresh 659: @values = this.first || raise(Error, "Record not found") 660: changed_columns.clear 661: associations.clear 662: self 663: 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:
# File lib/sequel/model/base.rb, line 683 683: def save(*columns) 684: opts = columns.last.is_a?(Hash) ? columns.pop : {} 685: return save_failure(:invalid) if opts[:validate] != false and !valid? 686: use_transaction = opts.include?(:transaction) ? opts[:transaction] : use_transactions 687: use_transaction ? db.transaction(opts){_save(columns, opts)} : _save(columns, opts) 688: end
# File lib/sequel/model/deprecated.rb, line 136 136: def save!(*args) 137: Deprecation.deprecate('Sequel::Model#save!', 'Use model_object.save(..., :validate=>false)') 138: opts = args.last.is_a?(Hash) ? args.pop : {} 139: args.push(opts.merge(:validate=>false)) 140: save(*args) 141: end
Saves only changed columns or does nothing if no columns are marked as chanaged. If no columns have been changed, returns nil. If unable to save, returns false unless raise_on_save_failure is true.
# File lib/sequel/model/base.rb, line 693 693: def save_changes 694: save(:changed=>true) || false unless changed_columns.empty? 695: 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 701 701: def set(hash) 702: set_restricted(hash, nil, nil) 703: end
# File lib/sequel/model/deprecated.rb, line 158 158: def set_values(values) 159: Deprecation.deprecate('Sequel::Model#set_values', 'Use Sequel::Model#set') 160: s = str_columns 161: vals = values.inject({}) do |m, kv| 162: k, v = kv 163: k = case k 164: when Symbol 165: k 166: when String 167: raise(Error, "all string keys must be a valid columns") unless s.include?(k) 168: k.to_sym 169: else 170: raise(Error, "Only symbols and strings allows as keys") 171: end 172: m[k] = v 173: m 174: end 175: vals.each {|k, v| @values[k] = v} 176: vals 177: end
# File lib/sequel/model/deprecated.rb, line 148 148: def set_with_params(hash) 149: Deprecation.deprecate('Sequel::Model#set_with_params', 'Use Sequel::Model#set') 150: set_restricted(hash, nil, nil) 151: end
# File lib/sequel/model/deprecated.rb, line 143 143: def str_columns 144: Deprecation.deprecate('Sequel::Model#str_columns', 'Use model_object.columns.map{|x| x.to_s}') 145: model.str_columns 146: end
Runs set with the passed hash and runs save_changes (which runs any callback methods).
# File lib/sequel/model/base.rb, line 729 729: def update(hash) 730: update_restricted(hash, nil, nil) 731: end
# File lib/sequel/model/deprecated.rb, line 179 179: def update_values(values) 180: Deprecation.deprecate('Sequel::Model#update_values', 'Use Sequel::Model#update or model_object.this.update') 181: this.update(set_values(values)) 182: end
# File lib/sequel/model/deprecated.rb, line 153 153: def update_with_params(hash) 154: Deprecation.deprecate('Sequel::Model#update_with_params', 'Use Sequel::Model#update') 155: update_restricted(hash, nil, nil) 156: end
Validates the object and returns true if no errors are reported.
# File lib/sequel/model/base.rb, line 758 758: def valid? 759: errors.clear 760: if before_validation == false 761: save_failure(:validation) 762: return false 763: end 764: validate 765: after_validation 766: errors.empty? 767: end