Module Sequel::Model::InstanceMethods
In: lib/sequel/model/base.rb

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, 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.

Methods

==   ===   []   []=   associations   changed_columns   delete   destroy   each   eql?   errors   exists?   hash   id   inspect   keys   new   new?   pk   pk_hash   refresh   reload   save   save_changes   set   set_all   set_except   set_only   this   update   update_all   update_except   update_only   valid?   validate  

External Aliases

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.

Attributes

values  [R]  The hash of attribute values. Keys are symbols with the names of the underlying database columns.

Public Class methods

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.

[Source]

     # File lib/sequel/model/base.rb, line 500
500:       def initialize(values = {}, from_db = false)
501:         if from_db
502:           @new = false
503:           @values = values
504:         else
505:           @values = {}
506:           @new = true
507:           set(values)
508:           changed_columns.clear 
509:           yield self if block_given?
510:         end
511:         after_initialize
512:       end

Public Instance methods

Compares model instances by values.

[Source]

     # File lib/sequel/model/base.rb, line 538
538:       def ==(obj)
539:         (obj.class == model) && (obj.values == @values)
540:       end

If pk is not nil, true only if the objects have the same class and pk. If pk is nil, false.

[Source]

     # File lib/sequel/model/base.rb, line 545
545:       def ===(obj)
546:         pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
547:       end

Returns value of the column‘s attribute.

[Source]

     # File lib/sequel/model/base.rb, line 515
515:       def [](column)
516:         @values[column]
517:       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.

[Source]

     # File lib/sequel/model/base.rb, line 526
526:       def []=(column, value)
527:         # If it is new, it doesn't have a value yet, so we should
528:         # definitely set the new value.
529:         # If the column isn't in @values, we can't assume it is
530:         # NULL in the database, so assume it has changed.
531:         if new? || !@values.include?(column) || value != @values[column]
532:           changed_columns << column unless changed_columns.include?(column)
533:           @values[column] = typecast_value(column, value)
534:         end
535:       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).

[Source]

     # File lib/sequel/model/base.rb, line 558
558:       def associations
559:         @associations ||= {}
560:       end

The columns that have been updated. This isn‘t completely accurate, see Model#[]=.

[Source]

     # File lib/sequel/model/base.rb, line 564
564:       def changed_columns
565:         @changed_columns ||= []
566:       end

Deletes and returns self. Does not run destroy hooks. Look into using destroy instead.

[Source]

     # File lib/sequel/model/base.rb, line 570
570:       def delete
571:         this.delete
572:         self
573:       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.

[Source]

     # File lib/sequel/model/base.rb, line 580
580:       def destroy
581:         use_transactions ? db.transaction{_destroy} : _destroy
582:       end

Iterates through all of the current values using each.

Example:

  Ticket.find(7).each { |k, v| puts "#{k} => #{v}" }

[Source]

     # File lib/sequel/model/base.rb, line 588
588:       def each(&block)
589:         @values.each(&block)
590:       end
eql?(obj)

Alias for #==

Returns the validation errors associated with this object.

[Source]

     # File lib/sequel/model/base.rb, line 593
593:       def errors
594:         @errors ||= Errors.new
595:       end

Returns true when current instance exists, false otherwise. Generally an object that isn‘t new will exist unless it has been deleted.

[Source]

     # File lib/sequel/model/base.rb, line 600
600:       def exists?
601:         this.count > 0
602:       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).

[Source]

     # File lib/sequel/model/base.rb, line 606
606:       def hash
607:         [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash
608:       end

Returns value for the :id attribute, even if the primary key is not id. To get the primary key value, use pk.

[Source]

     # File lib/sequel/model/base.rb, line 612
612:       def id
613:         @values[:id]
614:       end

Returns a string representation of the model instance including the class name and values.

[Source]

     # File lib/sequel/model/base.rb, line 618
618:       def inspect
619:         "#<#{model.name} @values=#{inspect_values}>"
620:       end

Returns the keys in values. May not include all column names.

[Source]

     # File lib/sequel/model/base.rb, line 623
623:       def keys
624:         @values.keys
625:       end

Returns true if the current instance represents a new record.

[Source]

     # File lib/sequel/model/base.rb, line 628
628:       def new?
629:         @new
630:       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.

[Source]

     # File lib/sequel/model/base.rb, line 635
635:       def pk
636:         raise(Error, "No primary key is associated with this model") unless key = primary_key
637:         case key
638:         when Array
639:           key.collect{|k| @values[k]}
640:         else
641:           @values[key]
642:         end
643:       end

Returns a hash identifying the model instance. It should be true that:

 Model[model_instance.pk_hash] === model_instance

[Source]

     # File lib/sequel/model/base.rb, line 648
648:       def pk_hash
649:         model.primary_key_hash(pk)
650:       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.

[Source]

     # File lib/sequel/model/base.rb, line 655
655:       def refresh
656:         _refresh(this)
657:       end

Alias of refresh, but not aliased directly to make overriding in a plugin easier.

[Source]

     # File lib/sequel/model/base.rb, line 660
660:       def reload
661:         refresh
662:       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

[Source]

     # File lib/sequel/model/base.rb, line 677
677:       def save(*columns)
678:         opts = columns.last.is_a?(Hash) ? columns.pop : {}
679:         return save_failure(:invalid) if opts[:validate] != false and !valid?
680:         use_transaction = opts.include?(:transaction) ? opts[:transaction] : use_transactions
681:         use_transaction ? db.transaction(opts){_save(columns, opts)} : _save(columns, opts)
682:       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.

[Source]

     # File lib/sequel/model/base.rb, line 687
687:       def save_changes
688:         save(:changed=>true) || false unless changed_columns.empty?
689:       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.

[Source]

     # File lib/sequel/model/base.rb, line 695
695:       def set(hash)
696:         set_restricted(hash, nil, nil)
697:       end

Set all values using the entries in the hash, ignoring any setting of allowed_columns or restricted columns in the model.

[Source]

     # File lib/sequel/model/base.rb, line 701
701:       def set_all(hash)
702:         set_restricted(hash, false, false)
703:       end

Set all values using the entries in the hash, except for the keys given in except.

[Source]

     # File lib/sequel/model/base.rb, line 707
707:       def set_except(hash, *except)
708:         set_restricted(hash, false, except.flatten)
709:       end

Set the values using the entries in the hash, only if the key is included in only.

[Source]

     # File lib/sequel/model/base.rb, line 713
713:       def set_only(hash, *only)
714:         set_restricted(hash, only.flatten, false)
715:       end

Returns (naked) dataset that should return only this instance.

[Source]

     # File lib/sequel/model/base.rb, line 718
718:       def this
719:         @this ||= model.dataset.filter(pk_hash).limit(1).naked
720:       end

Runs set with the passed hash and runs save_changes (which runs any callback methods).

[Source]

     # File lib/sequel/model/base.rb, line 723
723:       def update(hash)
724:         update_restricted(hash, nil, nil)
725:       end

Update all values using the entries in the hash, ignoring any setting of allowed_columns or restricted columns in the model.

[Source]

     # File lib/sequel/model/base.rb, line 729
729:       def update_all(hash)
730:         update_restricted(hash, false, false)
731:       end

Update all values using the entries in the hash, except for the keys given in except.

[Source]

     # File lib/sequel/model/base.rb, line 735
735:       def update_except(hash, *except)
736:         update_restricted(hash, false, except.flatten)
737:       end

Update the values using the entries in the hash, only if the key is included in only.

[Source]

     # File lib/sequel/model/base.rb, line 741
741:       def update_only(hash, *only)
742:         update_restricted(hash, only.flatten, false)
743:       end

Validates the object and returns true if no errors are reported.

[Source]

     # File lib/sequel/model/base.rb, line 752
752:       def valid?
753:         errors.clear
754:         if before_validation == false
755:           save_failure(:validation)
756:           return false
757:         end
758:         validate
759:         after_validation
760:         errors.empty?
761:       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.

[Source]

     # File lib/sequel/model/base.rb, line 748
748:       def validate
749:       end

[Validate]