Class/Module Index [+]

Quicksearch

Sequel::Model::InstanceMethods

Sequel::Model instance methods that implement basic model functionality.

Attributes

to_hash[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', ...}
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', ...}

Public Class Methods

new(values = {}, from_db = false) click to toggle source

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

only for backwards compatibility, forget it exists.

Artist.new(:name=>'Bob')

Artist.new do |a|
  a.name = 'Bob'
end
# File lib/sequel/model/base.rb, line 1021
def initialize(values = {}, from_db = false)
  if from_db
    Sequel::Deprecation.deprecate('Passing two arguments to Model.new', 'Please use Model.call instead')
    set_values(values)
  else
    @values = {}
    @new = true
    @modified = true
    initialize_set(values)
    changed_columns.clear 
    yield self if block_given?
  end
  after_initialize
end

Public Instance Methods

==(obj) click to toggle source

Alias of eql?

# File lib/sequel/model/base.rb, line 1064
def ==(obj)
  eql?(obj)
end
===(obj) click to toggle source

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 1074
def ===(obj)
  pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
end
[](column) click to toggle source

Returns value of the column's attribute.

Artist[1][:id] #=> 1
# File lib/sequel/model/base.rb, line 1039
def [](column)
  @values[column]
end
[]=(column, value) click to toggle source

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 is 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 1051
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)
  vals = @values
  if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
    change_column_value(column, v)
  end
end
autoincrementing_primary_key() click to toggle source

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 1089
def autoincrementing_primary_key
  primary_key
end
changed_columns() click to toggle source

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 1100
def changed_columns
  @changed_columns ||= []
end
delete() click to toggle source

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

Artist[1].delete # DELETE FROM artists WHERE (id = 1)
# => #<Artist {:id=>1, ...}>
# File lib/sequel/model/base.rb, line 1109
def delete
  raise Sequel::Error, "can't delete frozen object" if frozen?
  _delete
  self
end
destroy(opts = {}) click to toggle source

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 1124
def destroy(opts = {})
  raise Sequel::Error, "can't destroy frozen object" if frozen?
  checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
end
each(&block) click to toggle source

Iterates through all of the current values using each.

Album[1].each{|k, v| puts "#{k} => #{v}"}
# id => 1
# name => 'Bob'
# File lib/sequel/model/base.rb, line 1134
def each(&block)
  @values.each(&block)
end
eql?(obj) click to toggle source

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 1143
def eql?(obj)
  (obj.class == model) && (obj.values == @values)
end
errors() click to toggle source

Returns the validation errors associated with this object. See Errors.

# File lib/sequel/model/base.rb, line 1149
def errors
  @errors ||= errors_class.new
end
exists?() click to toggle source

Returns true when current instance exists, false otherwise. Generally an object that isn't new will exist unless it has been deleted. Uses a database query to check for existence, unless the model object is new, in which case this is always false.

Artist[1].exists? # SELECT 1 FROM artists WHERE (id = 1)
# => true
Artist.new.exists?
# => false
# File lib/sequel/model/base.rb, line 1163
def exists?
  new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
end
extend(mod) click to toggle source

Ignore the model's setter method cache when this instances extends a module, as the module may contain setter methods.

# File lib/sequel/model/base.rb, line 1169
def extend(mod)
  @singleton_setter_added = true
  super
end
freeze() click to toggle source

Freeze the object in such a way that it is still usable but not modifiable. Once an object is frozen, you cannot modify it's values, changed_columns, errors, or dataset.

# File lib/sequel/model/base.rb, line 1177
def freeze
  values.freeze
  changed_columns.freeze
  errors
  validate
  errors.freeze
  this.freeze if !new? && model.primary_key
  super
end
hash() click to toggle source

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 1194
def hash
  case primary_key
  when Array
    [model, !pk.all? ? @values : pk].hash
  when Symbol
    [model, pk.nil? ? @values : pk].hash
  else
    [model, @values].hash
  end
end
id() click to toggle source

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

Artist[1].id # => 1
# File lib/sequel/model/base.rb, line 1209
def id
  @values[:id]
end
inspect() click to toggle source

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

# File lib/sequel/model/base.rb, line 1215
def inspect
  "#<#{model.name} @values=#{inspect_values}>"
end
keys() click to toggle source

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

Artist.new.keys # => []
Artist.new(:name=>'Bob').keys # => [:name]
Artist[1].keys # => [:id, :name]
# File lib/sequel/model/base.rb, line 1224
def keys
  @values.keys
end
lock!() click to toggle source

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 1237
def lock!
  _refresh(this.for_update) unless new?
  self
end
marshallable!() click to toggle source

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 1247
def marshallable!
  @this = nil
  self
end
modified!(column=nil) click to toggle source

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

If a column is given, specifically marked that column as modified, so that save_changes/update will include that column in the update. This should be used if you plan on mutating the column value instead of assigning a new column value:

a.modified!(:name)
a.name.gsub!(/[aeou]/, 'i')
# File lib/sequel/model/base.rb, line 1267
def modified!(column=nil)
  if column && !changed_columns.include?(column)
    changed_columns << column
  end
  @modified = true
end
modified?(column=nil) click to toggle source

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

If a column is given, specifically check if the given column has been modified:

a.modified?(:num_albums) # => false
a.num_albums = 10
a.modified?(:num_albums) # => true
# File lib/sequel/model/base.rb, line 1289
def modified?(column=nil)
  if column
    changed_columns.include?(column)
  else
    @modified || !changed_columns.empty?
  end
end
new?() click to toggle source

Returns true if the current instance represents a new record.

Artist.new.new? # => true
Artist[1].new? # => false
# File lib/sequel/model/base.rb, line 1301
def new?
  defined?(@new) ? @new : (@new = false)
end
pk() click to toggle source

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 1311
def pk
  raise(Error, "No primary key is associated with this model") unless key = primary_key
  if key.is_a?(Array)
    vals = @values
    key.map{|k| vals[k]}
  else
    @values[key]
  end
end
pk_hash() click to toggle source

Returns a hash mapping the receivers primary key column(s) to their values.

Artist[1].pk_hash # => {:id=>1}
Artist[[1, 2]].pk_hash # => {:id1=>1, :id2=>2}
# File lib/sequel/model/base.rb, line 1325
def pk_hash
  model.primary_key_hash(pk)
end
refresh() click to toggle source

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 1337
def refresh
  raise Sequel::Error, "can't refresh frozen object" if frozen?
  _refresh(this)
  self
end
reload() click to toggle source

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

# File lib/sequel/model/base.rb, line 1344
def reload
  refresh
end
save(*columns) click to toggle source

Creates or updates the record, after making sure the record is valid and before hooks execute successfully. Fails if:

  • the record is not valid, or

  • before_save returns false, or

  • the record is new and before_create returns false, or

  • the record is not new and before_update returns false.

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, or a options hash.

Takes the following options:

:changed

save all changed columns, instead of all columns or the columns given

:columns

array of specific columns that should be saved.

:raise_on_failure

set to true or false to override the current raise_on_save_failure setting

:server

set the server/shard on the object before saving, and use that server/shard in any transaction.

:transaction

set to true or false to override the current use_transactions setting

:validate

set to false to skip validation

# File lib/sequel/model/base.rb, line 1376
def save(*columns)
  raise Sequel::Error, "can't save frozen object" if frozen?
  opts = columns.last.is_a?(Hash) ? columns.pop : {}

  Sequel::Deprecation.deprecate('Passing columns as separate arguments to Model#save', 'Instead, provide a :columns option with the array of columns to save.') unless columns.empty?
  columns.concat(Array(opts[:columns])) if opts[:columns]

  set_server(opts[:server]) if opts[:server] 
  if opts[:validate] != false
    unless checked_save_failure(opts){_valid?(true, opts)}
      raise(ValidationFailed.new(self)) if raise_on_failure?(opts)
      return
    end
  end
  checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}}
end
save_changes(opts={}) click to toggle source

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 1402
def save_changes(opts={})
  save(opts.merge(:changed=>true)) || false if modified? 
end
set(hash) click to toggle source

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 1413
def set(hash)
  set_restricted(hash, nil, nil)
end
set_all(hash) click to toggle source

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

Artist.set_allowed_columns(:num_albums)
artist.set_all(:name=>'Jim')
artist.name # => 'Jim'
# File lib/sequel/model/base.rb, line 1423
def set_all(hash)
  set_restricted(hash, false, false)
end
set_except(hash, *except) click to toggle source

Set all values using the entries in the hash, except for the keys given in except. You should probably use set_fields or set_only instead of this method, as blacklist approaches to security are a bad idea.

artist.set_except({:name=>'Jim'}, :hometown)
artist.name # => 'Jim'
# File lib/sequel/model/base.rb, line 1433
def set_except(hash, *except)
  Sequel::Deprecation.deprecate('Model#set_except', 'Please switch to Model#set_only or use the blacklist_security plugin')
  set_restricted(hash, false, except.flatten)
end
set_fields(hash, fields, opts=nil) click to toggle source

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.

You can provide an options hash, with the following options currently respected:

:missing

Can be set to :skip to skip missing entries or :raise to raise an Error for missing entries. The default behavior is not to check for missing entries, in which case the default value is used. To be friendly with most web frameworks, the missing check will also check for the string version of the argument in the hash if given a symbol.

Examples:

artist.set_fields({:name=>'Jim'}, [:name])
artist.name # => 'Jim'

artist.set_fields({:hometown=>'LA'}, [:name])
artist.name # => nil
artist.hometown # => 'Sac'

artist.name # => 'Jim'
artist.set_fields({}, [:name], :missing=>:skip)
artist.name # => 'Jim'

artist.name # => 'Jim'
artist.set_fields({}, [:name], :missing=>:raise)
# Sequel::Error raised
# File lib/sequel/model/base.rb, line 1464
def set_fields(hash, fields, opts=nil)
  opts = if opts
    model.default_set_fields_options.merge(opts)
  else
    model.default_set_fields_options
  end

  case opts[:missing]
  when :skip
    fields.each do |f|
      if hash.has_key?(f) 
        send("#{f}=", hash[f])
      elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
        send("#{sf}=", hash[sf])
      end
    end
  when :raise
    fields.each do |f|
      if hash.has_key?(f)
        send("#{f}=", hash[f])
      elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
        send("#{sf}=", hash[sf])
      else
        raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
      end
    end
  else
    fields.each{|f| send("#{f}=", hash[f])}
  end
  self
end
set_only(hash, *only) click to toggle source

Set the values using the entries in the hash, only if the key is included in only. It may be a better idea to use set_fields instead of this method.

artist.set_only({:name=>'Jim'}, :name)
artist.name # => 'Jim'

artist.set_only({:hometown=>'LA'}, :name) # Raise Error
# File lib/sequel/model/base.rb, line 1504
def set_only(hash, *only)
  set_restricted(hash, only.flatten, false)
end
set_server(s) click to toggle source

Set the shard that this object is tied to. Returns self.

# File lib/sequel/model/base.rb, line 1509
def set_server(s)
  @server = s
  @this.opts[:server] = s if @this
  self
end
set_values(hash) click to toggle source

Replace the current values with hash. Should definitely not be used with untrusted input, and should probably not be called directly by user code.

# File lib/sequel/model/base.rb, line 1518
def set_values(hash)
  @values = hash
end
singleton_method_added(meth) click to toggle source

Clear the setter_methods cache when a method is added

# File lib/sequel/model/base.rb, line 1523
def singleton_method_added(meth)
  @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP
  super
end
this() click to toggle source

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

Artist[1].this
# SELECT * FROM artists WHERE (id = 1) LIMIT 1
# File lib/sequel/model/base.rb, line 1532
def this
  @this ||= use_server(model.instance_dataset.filter(pk_hash))
end
update(hash) click to toggle source

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 1539
def update(hash)
  update_restricted(hash, nil, nil)
end
update_all(hash) click to toggle source

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

Artist.set_allowed_columns(:num_albums)
artist.update_all(:name=>'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)
# File lib/sequel/model/base.rb, line 1548
def update_all(hash)
  update_restricted(hash, false, false)
end
update_except(hash, *except) click to toggle source

Update all values using the entries in the hash, except for the keys given in except. You should probably use update_fields or update_only instead of this method, as blacklist approaches to security are a bad idea.

artist.update_except({:name=>'Jim'}, :hometown) # UPDATE artists SET name = 'Jim' WHERE (id = 1)
# File lib/sequel/model/base.rb, line 1557
def update_except(hash, *except)
  Sequel::Deprecation.deprecate('Model#update_except', 'Please switch to Model#update_only or use the blacklist_security plugin')
  update_restricted(hash, false, except.flatten)
end
update_fields(hash, fields, opts=nil) click to toggle source

Update the instances values by calling set_fields with the arguments, then saves 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 1570
def update_fields(hash, fields, opts=nil)
  set_fields(hash, fields, opts)
  save_changes
end
update_only(hash, *only) click to toggle source

Update the values using the entries in the hash, only if the key is included in only. It may be a better idea to use update_fields instead of this method.

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 1583
def update_only(hash, *only)
  update_restricted(hash, only.flatten, false)
end
valid?(opts = {}) click to toggle source

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 1601
def valid?(opts = {})
  _valid?(false, opts)
end
validate() click to toggle source

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 1593
def validate
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.