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   autoincrementing_primary_key   changed_columns   delete   destroy   each   eql?   errors   exists?   hash   id   inspect   keys   modified?   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 523
523:       def initialize(values = {}, from_db = false)
524:         if from_db
525:           @new = false
526:           @values = values
527:         else
528:           @values = {}
529:           @new = true
530:           set(values)
531:           changed_columns.clear 
532:           yield self if block_given?
533:         end
534:         after_initialize
535:       end

Public Instance methods

Compares model instances by values.

[Source]

     # File lib/sequel/model/base.rb, line 561
561:       def ==(obj)
562:         (obj.class == model) && (obj.values == @values)
563:       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 568
568:       def ===(obj)
569:         pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
570:       end

Returns value of the column‘s attribute.

[Source]

     # File lib/sequel/model/base.rb, line 538
538:       def [](column)
539:         @values[column]
540:       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 549
549:       def []=(column, value)
550:         # If it is new, it doesn't have a value yet, so we should
551:         # definitely set the new value.
552:         # If the column isn't in @values, we can't assume it is
553:         # NULL in the database, so assume it has changed.
554:         if new? || !@values.include?(column) || value != @values[column]
555:           changed_columns << column unless changed_columns.include?(column)
556:           @values[column] = typecast_value(column, value)
557:         end
558:       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 581
581:       def associations
582:         @associations ||= {}
583:       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.

[Source]

     # File lib/sequel/model/base.rb, line 588
588:       def autoincrementing_primary_key
589:         primary_key
590:       end

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

[Source]

     # File lib/sequel/model/base.rb, line 594
594:       def changed_columns
595:         @changed_columns ||= []
596:       end

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

[Source]

     # File lib/sequel/model/base.rb, line 600
600:       def delete
601:         this.delete
602:         self
603:       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 610
610:       def destroy
611:         use_transactions ? db.transaction{_destroy} : _destroy
612:       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 618
618:       def each(&block)
619:         @values.each(&block)
620:       end
eql?(obj)

Alias for #==

Returns the validation errors associated with this object.

[Source]

     # File lib/sequel/model/base.rb, line 623
623:       def errors
624:         @errors ||= Errors.new
625:       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 630
630:       def exists?
631:         this.count > 0
632:       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 636
636:       def hash
637:         [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash
638:       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 642
642:       def id
643:         @values[:id]
644:       end

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

[Source]

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

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

[Source]

     # File lib/sequel/model/base.rb, line 653
653:       def keys
654:         @values.keys
655:       end

Whether this object has been modified since last saved, used by save_changes to determine whether changes should be saved

[Source]

     # File lib/sequel/model/base.rb, line 659
659:       def modified?
660:         !changed_columns.empty?
661:       end

Returns true if the current instance represents a new record.

[Source]

     # File lib/sequel/model/base.rb, line 664
664:       def new?
665:         @new
666:       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 671
671:       def pk
672:         raise(Error, "No primary key is associated with this model") unless key = primary_key
673:         key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key]
674:       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 679
679:       def pk_hash
680:         model.primary_key_hash(pk)
681:       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 686
686:       def refresh
687:         _refresh(this)
688:       end

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

[Source]

     # File lib/sequel/model/base.rb, line 691
691:       def reload
692:         refresh
693:       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 708
708:       def save(*columns)
709:         opts = columns.last.is_a?(Hash) ? columns.pop : {}
710:         return save_failure(:invalid) if opts[:validate] != false and !valid?
711:         use_transaction = opts.include?(:transaction) ? opts[:transaction] : use_transactions
712:         use_transaction ? db.transaction(opts){_save(columns, opts)} : _save(columns, opts)
713:       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.

[Source]

     # File lib/sequel/model/base.rb, line 718
718:       def save_changes
719:         save(:changed=>true) || false if modified? 
720:       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 726
726:       def set(hash)
727:         set_restricted(hash, nil, nil)
728:       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 732
732:       def set_all(hash)
733:         set_restricted(hash, false, false)
734:       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 738
738:       def set_except(hash, *except)
739:         set_restricted(hash, false, except.flatten)
740:       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 744
744:       def set_only(hash, *only)
745:         set_restricted(hash, only.flatten, false)
746:       end

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

[Source]

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

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

[Source]

     # File lib/sequel/model/base.rb, line 754
754:       def update(hash)
755:         update_restricted(hash, nil, nil)
756:       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 760
760:       def update_all(hash)
761:         update_restricted(hash, false, false)
762:       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 766
766:       def update_except(hash, *except)
767:         update_restricted(hash, false, except.flatten)
768:       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 772
772:       def update_only(hash, *only)
773:         update_restricted(hash, only.flatten, false)
774:       end

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

[Source]

     # File lib/sequel/model/base.rb, line 783
783:       def valid?
784:         errors.clear
785:         if before_validation == false
786:           save_failure(:validation)
787:           return false
788:         end
789:         validate
790:         after_validation
791:         errors.empty?
792:       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 779
779:       def validate
780:       end

[Validate]