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

Class methods for Sequel::Model that implement basic model functionality.

  • All of the method names in Model::DATASET_METHODS have class methods created that call the Model‘s dataset with the method of the same name with the given arguments.

Methods

Constants

FINDER_TYPES = [:first, :all, :each, :get].freeze

External Aliases

with_sql -> fetch
  Returns a copy of the model‘s dataset with custom SQL
  Artist.fetch("SELECT * FROM artists WHERE name LIKE 'A%'")
  Artist.fetch("SELECT * FROM artists WHERE id = ?", 1)

Attributes

allowed_columns  [R]  Which columns should be the only columns allowed in a call to a mass assignment method (e.g. set) (default: not set, so all columns not otherwise restricted are allowed).
cache_anonymous_models  [RW]  Whether to cache the anonymous models created by Sequel::Model(). This is required for reloading them correctly (avoiding the superclass mismatch). True by default for backwards compatibility.
dataset_method_modules  [R]  Array of modules that extend this model‘s dataset. Stored so that if the model‘s dataset is changed, it will be extended with all of these modules.
default_set_fields_options  [RW]  The default options to use for Model#set_fields. These are merged with the options given to set_fields.
fast_instance_delete_sql  [R]  SQL string fragment used for faster DELETE statement creation when deleting/destroying model instances, or nil if the optimization should not be used. For internal use only.
instance_dataset  [R]  The dataset that instance datasets (this) are based on. Generally a naked version of the model‘s dataset limited to one row. For internal use only.
plugins  [R]  Array of plugin modules loaded by this class
  Sequel::Model.plugins
  # => [Sequel::Model, Sequel::Model::Associations]
primary_key  [R]  The primary key for the class. Sequel can determine this automatically for many databases, but not all, so you may need to set it manually. If not determined automatically, the default is :id.
raise_on_save_failure  [RW]  Whether to raise an error instead of returning nil on a failure to save/create/save_changes/update/destroy due to a validation failure or a before_* hook returning false (default: true).
raise_on_typecast_failure  [RW]  Whether to raise an error when unable to typecast data for a column (default: false). This should be set to true if you want to have model setter methods raise errors if the argument cannot be typecast properly.
require_modification  [RW]  Whether to raise an error if an UPDATE or DELETE query related to a model instance does not modify exactly 1 row. If set to false, Sequel will not check the number of rows modified (default: true).
require_valid_table  [RW]  Requires that all models have valid tables, raising exceptions if creating a model without a valid table backing it. Enabling this will break code like:
  class Foo < Sequel::Model
    set_dataset :my_foo
  end

As when Sequel::Model is subclassed, before set_dataset is executed, it will try to get the schema for the foos table, which will raise an exception. You would need to switch to using:

  class Foo < Sequel::Model(:my_foo)
  end

or:

  Foo = Sequel::Model()
  Foo.set_dataset :my_foo
simple_pk  [R]  Should be the literal primary key column name if this Model‘s table has a simple primary key, or nil if the model has a compound primary key or no primary key.
simple_table  [R]  Should be the literal table name if this Model‘s dataset is a simple table (no select, order, join, etc.), or nil otherwise. This and simple_pk are used for an optimization in Model.[].
strict_param_setting  [RW]  Whether new/set/update and their variants should raise an error if an invalid key is used. A key is invalid if no setter method exists for that key or the access to the setter method is restricted (e.g. due to it being a primary key field). If set to false, silently skip any key where the setter method doesn‘t exist or access to it is restricted.
typecast_empty_string_to_nil  [RW]  Whether to typecast the empty string (’’) to nil for columns that are not string or blob. In most cases the empty string would be the way to specify a NULL SQL value in string form (nil.to_s == ’’), and an empty string would not usually be typecast correctly for other types, so the default is true.
typecast_on_assignment  [RW]  Whether to typecast attribute values on assignment (default: true). If set to false, no typecasting is done, so it will be left up to the database to typecast the value correctly.
use_after_commit_rollback  [RW]  Whether to enable the after_commit and after_rollback hooks when saving/destroying instances. On by default, can be turned off for performance reasons or when using prepared transactions (which aren‘t compatible with after commit/rollback).
use_transactions  [RW]  Whether to use a transaction by default when saving/deleting records (default: true). If you are sending database queries in before_* or after_* hooks, you shouldn‘t change the default setting without a good reason.

Public Instance methods

Lets you create a Model subclass with its dataset already set. source should be an instance of one of the following classes:

Database :Sets the database for this model to source. Generally only useful when subclassing directly from the returned class, where the name of the subclass sets the table name (which is combined with the Database in source to create the dataset to use)
Dataset :Sets the dataset for this model to source.
other :Sets the table name for this model to source. The class will use the default database for model classes in order to create the dataset.

The purpose of this method is to set the dataset/database automatically for a model class, if the table name doesn‘t match the implicit name. This is neater than using set_dataset inside the class, doesn‘t require a bogus query for the schema.

When creating subclasses of Sequel::Model itself, this method is usually called on Sequel itself, using Sequel::Model(:something).

  # Using a symbol
  class Comment < Sequel::Model(:something)
    table_name # => :something
  end

  # Using a dataset
  class Comment < Sequel::Model(DB1[:something])
    dataset # => DB1[:something]
  end

  # Using a database
  class Comment < Sequel::Model(DB1)
    dataset # => DB1[:comments]
  end

[Source]

     # File lib/sequel/model/base.rb, line 185
185:       def Model(source)
186:         if cache_anonymous_models
187:           mutex = @Model_mutex
188:           cache = mutex.synchronize{@Model_cache ||= {}}
189: 
190:           if klass = mutex.synchronize{cache[source]}
191:             return klass
192:           end
193:         end
194: 
195:         klass = Class.new(self)
196: 
197:         if source.is_a?(::Sequel::Database)
198:           klass.db = source
199:         else
200:           klass.set_dataset(source)
201:         end
202: 
203:         if cache_anonymous_models
204:           mutex.synchronize{cache[source] = klass}
205:         end
206: 
207:         klass
208:       end

Returns the first record from the database matching the conditions. If a hash is given, it is used as the conditions. If another object is given, it finds the first record whose primary key(s) match the given argument(s). If no object is returned by the dataset, returns nil.

  Artist[1] # SELECT * FROM artists WHERE id = 1
  # => #<Artist {:id=>1, ...}>

  Artist[:name=>'Bob'] # SELECT * FROM artists WHERE (name = 'Bob') LIMIT 1
  # => #<Artist {:name=>'Bob', ...}>

[Source]

     # File lib/sequel/model/base.rb, line 220
220:       def [](*args)
221:         args = args.first if args.size <= 1
222:         args.is_a?(Hash) ? first_where(args) : (primary_key_lookup(args) unless args.nil?)
223:       end

Initializes a model instance as an existing record. This constructor is used by Sequel to initialize model instances when fetching records. Requires that values be a hash where all keys are symbols. It probably should not be used by external code.

[Source]

     # File lib/sequel/model/base.rb, line 229
229:       def call(values)
230:         o = allocate
231:         o.instance_variable_set(:@values, values)
232:         o
233:       end

Clear the setter_methods cache

[Source]

     # File lib/sequel/model/base.rb, line 236
236:       def clear_setter_methods_cache
237:         @setter_methods = nil
238:       end

Returns the columns in the result set in their original order. Generally, this will use the columns determined via the database schema, but in certain cases (e.g. models that are based on a joined dataset) it will use Dataset#columns to find the columns.

  Artist.columns
  # => [:id, :name]

[Source]

     # File lib/sequel/model/base.rb, line 247
247:       def columns
248:         @columns || set_columns(dataset.naked.columns)
249:       end

Creates instance using new with the given values and block, and saves it.

  Artist.create(:name=>'Bob')
  # INSERT INTO artists (name) VALUES ('Bob')

  Artist.create do |a|
    a.name = 'Jim'
  end # INSERT INTO artists (name) VALUES ('Jim')

[Source]

     # File lib/sequel/model/base.rb, line 259
259:       def create(values = {}, &block)
260:         new(values, &block).save
261:       end

Returns the dataset associated with the Model class. Raises an Error if there is no associated dataset for this class. In most cases, you don‘t need to call this directly, as Model proxies many dataset methods to the underlying dataset.

  Artist.dataset.all # SELECT * FROM artists

[Source]

     # File lib/sequel/model/base.rb, line 269
269:       def dataset
270:         @dataset || raise(Error, "No dataset associated with #{self}")
271:       end

Alias of set_dataset

[Source]

     # File lib/sequel/model/base.rb, line 274
274:       def dataset=(ds)
275:         set_dataset(ds)
276:       end

Extend the dataset with a module, similar to adding a plugin with the methods defined in DatasetMethods. This is the recommended way to add methods to model datasets.

If an argument, it should be a module, and is used to extend the underlying dataset. Otherwise an anonymous module is created, and if a block is given, it is module_evaled, allowing you do define dataset methods directly using the standard ruby def syntax. Returns the module given or the anonymous module created.

  # Usage with existing module
  Artist.dataset_module Sequel::ColumnsIntrospection

  # Usage with anonymous module
  Artist.dataset_module do
    def foo
      :bar
    end
  end
  Artist.dataset.foo
  # => :bar
  Artist.foo
  # => :bar

Any anonymous modules created are actually instances of Sequel::Model::DatasetModule (a Module subclass), which allows you to call the subset method on them:

  Artist.dataset_module do
    subset :released, Sequel.identifier(release_date) > Sequel::CURRENT_DATE
  end

Any public methods in the dataset module will have class methods created that call the method on the dataset, assuming that the class method is not already defined.

[Source]

     # File lib/sequel/model/base.rb, line 312
312:       def dataset_module(mod = nil)
313:         if mod
314:           raise Error, "can't provide both argument and block to Model.dataset_module" if block_given?
315:           dataset_extend(mod)
316:           mod
317:         else
318:           @dataset_module ||= DatasetModule.new(self)
319:           @dataset_module.module_eval(&Proc.new) if block_given?
320:           dataset_extend(@dataset_module)
321:           @dataset_module
322:         end
323:       end

Returns the database associated with the Model class. If this model doesn‘t have a database associated with it, assumes the superclass‘s database, or the first object in Sequel::DATABASES. If no Sequel::Database object has been created, raises an error.

  Artist.db.transaction do # BEGIN
    Artist.create(:name=>'Bob')
    # INSERT INTO artists (name) VALUES ('Bob')
  end # COMMIT

[Source]

     # File lib/sequel/model/base.rb, line 335
335:       def db
336:         return @db if @db
337:         @db = self == Model ? Sequel.synchronize{DATABASES.first} : superclass.db
338:         raise(Error, "No database associated with #{self}: have you called Sequel.connect or #{self}.db= ?") unless @db
339:         @db
340:       end

Sets the database associated with the Model class. If the model has an associated dataset, sets the model‘s dataset to a dataset on the new database with the same options used by the current dataset. This can be used directly on Sequel::Model to set the default database to be used by subclasses, or to override the database used for specific models:

  Sequel::Model.db = DB1
  Artist.db = DB2

Note that you should not use this to change the model‘s database at runtime. If you have that need, you should look into Sequel‘s sharding support.

[Source]

     # File lib/sequel/model/base.rb, line 356
356:       def db=(db)
357:         @db = db
358:         set_dataset(db.dataset.clone(@dataset.opts)) if @dataset
359:       end

Returns the cached schema information if available or gets it from the database. This is a hash where keys are column symbols and values are hashes of information related to the column. See Database#schema.

  Artist.db_schema
  # {:id=>{:type=>:integer, :primary_key=>true, ...},
  #  :name=>{:type=>:string, :primary_key=>false, ...}}

[Source]

     # File lib/sequel/model/base.rb, line 369
369:       def db_schema
370:         @db_schema ||= get_db_schema
371:       end

Define a Model method on the given module that calls the Model method on the receiver. This is how the Sequel::Model() method is defined, and allows you to define Model() methods on other modules, making it easier to have custom model settings for all models under a namespace. Example:

  module Foo
    Model = Class.new(Sequel::Model)
    Model.def_Model(self)
    DB = Model.db = Sequel.connect(ENV['FOO_DATABASE_URL'])
    Model.plugin :prepared_statements

    class Bar < Model
      # Uses Foo::DB[:bars]
    end

    class Baz < Model(:my_baz)
      # Uses Foo::DB[:my_baz]
    end
  end

[Source]

     # File lib/sequel/model/base.rb, line 142
142:       def def_Model(mod)
143:         model = self
144:         (class << mod; self; end).send(:define_method, :Model) do |source|
145:           model.Model(source)
146:         end
147:       end

Create a column alias, where the column methods have one name, but the underlying storage uses a different name.

[Source]

     # File lib/sequel/model/base.rb, line 375
375:       def def_column_alias(meth, column)
376:         clear_setter_methods_cache
377:         overridable_methods_module.module_eval do
378:           define_method(meth){self[column]}
379:           define_method("#{meth}="){|v| self[column] = v}
380:         end
381:       end

If a block is given, define a method on the dataset (if the model currently has an dataset) with the given argument name using the given block. Also define a class method on the model that calls the dataset method. Stores the method name and block so that it can be reapplied if the model‘s dataset changes.

If a block is not given, just define a class method on the model for each argument that calls the dataset method of the same argument name.

It is recommended that you define methods inside a block passed to dataset_module instead of using this method, as dataset_module allows you to use normal ruby def syntax.

  # Add new dataset method and class method that calls it
  Artist.def_dataset_method(:by_name){order(:name)}
  Artist.filter(:name.like('A%')).by_name
  Artist.by_name.filter(:name.like('A%'))

  # Just add a class method that calls an existing dataset method
  Artist.def_dataset_method(:server!)
  Artist.server!(:server1)

[Source]

     # File lib/sequel/model/base.rb, line 403
403:       def def_dataset_method(*args, &block)
404:         raise(Error, "No arguments given") if args.empty?
405: 
406:         if block
407:           raise(Error, "Defining a dataset method using a block requires only one argument") if args.length > 1
408:           dataset_module{define_method(args.first, &block)}
409:         else
410:           args.each{|arg| def_model_dataset_method(arg)}
411:         end
412:       end

Finds a single record according to the supplied filter. You are encouraged to use Model.[] or Model.first instead of this method.

  Artist.find(:name=>'Bob')
  # SELECT * FROM artists WHERE (name = 'Bob') LIMIT 1

  Artist.find{name > 'M'}
  # SELECT * FROM artists WHERE (name > 'M') LIMIT 1

[Source]

     # File lib/sequel/model/base.rb, line 422
422:       def find(*args, &block)
423:         if args.length == 1 && !block
424:           # Use optimized finder
425:           first_where(args.first)
426:         else
427:           filter(*args, &block).first
428:         end
429:       end

Like find but invokes create with given conditions when record does not exist. Unlike find in that the block used in this method is not passed to find, but instead is passed to create only if find does not return an object.

  Artist.find_or_create(:name=>'Bob')
  # SELECT * FROM artists WHERE (name = 'Bob') LIMIT 1
  # INSERT INTO artists (name) VALUES ('Bob')

  Artist.find_or_create(:name=>'Jim'){|a| a.hometown = 'Sactown'}
  # SELECT * FROM artists WHERE (name = 'Jim') LIMIT 1
  # INSERT INTO artists (name, hometown) VALUES ('Jim', 'Sactown')

[Source]

     # File lib/sequel/model/base.rb, line 443
443:       def find_or_create(cond, &block)
444:         find(cond) || create(cond, &block)
445:       end

Create an optimized finder method using a dataset placeholder literalizer. This pre-computes the SQL to use for the query, except for given arguments.

There are two ways to use this. The recommended way is to pass a symbol that represents a model class method that returns a dataset:

  def Artist.by_name(name)
    where(:name=>name)
  end

  Artist.finder :by_name

This creates an optimized first_by_name method, which you can call normally:

  Artist.first_by_name("Joe")

The alternative way to use this to pass your own block:

  Artist.finder(:name=>:first_by_name){|pl, ds| ds.where(:name=>pl.arg).limit(1)}

Note that if you pass your own block, you are responsible for manually setting limits if necessary (as shown above).

Options:

:arity :When using a symbol method name, this specifies the arity of the method. This should be used if if the method accepts an arbitrary number of arguments, or the method has default argument values. Note that if the method is defined as a dataset method, the class method Sequel creates accepts an arbitrary number of arguments, so you should use this option in that case. If you want to handle multiple possible arities, you need to call the finder method multiple times with unique :arity and :name methods each time.
:name :The name of the method to create. This must be given if you pass a block. If you use a symbol, this defaults to the symbol prefixed by the type.
:mod :The module in which to create the finder method. Defaults to the singleton class of the model.
:type :The type of query to run. Can be :first, :each, :all, or :get, defaults to :first.

Caveats:

This doesn‘t handle all possible cases. For example, if you have a method such as:

  def Artist.by_name(name)
    name ? where(:name=>name) : exclude(:name=>nil)
  end

Then calling a finder without an argument will not work as you expect.

  Artist.finder :by_name
  Artist.by_name(nil).first
  # WHERE (name IS NOT NULL)
  Artist.first_by_name(nil)
  # WHERE (name IS NULL)

See Dataset::PlaceholderLiteralizer for additional caveats.

[Source]

     # File lib/sequel/model/base.rb, line 505
505:       def finder(meth=OPTS, opts=OPTS, &block)
506:         if block
507:           raise Error, "cannot pass both a method name argument and a block of Model.finder" unless meth.is_a?(Hash)
508:           raise Error, "cannot pass two option hashes to Model.finder" unless opts.equal?(OPTS)
509:           opts = meth
510:           raise Error, "must provide method name via :name option when passing block to Model.finder" unless meth_name = opts[:name]
511:         end
512: 
513:         type = opts.fetch(:type, :first)
514:         unless prepare = opts[:prepare]
515:           raise Error, ":type option to Model.finder must be :first, :all, :each, or :get" unless FINDER_TYPES.include?(type)
516:         end
517:         limit1 = type == :first || type == :get
518:         meth_name ||= opts[:name] || "#{type}_#{meth}""#{type}_#{meth}"
519: 
520:         argn = lambda do |model|
521:           if arity = opts[:arity]
522:             arity
523:           else
524:             method = block || model.method(meth)
525:             (method.arity < 0 ? method.arity.abs - 1 : method.arity)
526:           end
527:         end
528: 
529:         loader_proc = if prepare
530:           proc do |model|
531:             args = prepare_method_args('$a', argn.call(model))
532:             ds = if block
533:               model.instance_exec(*args, &block)
534:             else
535:               model.send(meth, *args)
536:             end
537:             ds = ds.limit(1) if limit1
538:             model_name = model.name
539:             if model_name.to_s.empty?
540:               model_name = model.object_id
541:             else
542:               model_name = model_name.gsub(/\W/, '_')
543:             end
544:             ds.prepare(type, "#{model_name}_#{meth_name}""#{model_name}_#{meth_name}")
545:           end
546:         else
547:           proc do |model|
548:             n = argn.call(model)
549:             block ||= lambda do |pl, model2|
550:               args = (0...n).map{pl.arg}
551:               ds = model2.send(meth, *args)
552:               ds = ds.limit(1) if limit1
553:               ds
554:             end
555: 
556:             Sequel::Dataset::PlaceholderLiteralizer.loader(model, &block) 
557:           end
558:         end
559: 
560:         Sequel.synchronize{@finder_loaders[meth_name] = loader_proc}
561:         mod = opts[:mod] || (class << self; self; end)
562:         if prepare
563:           def_prepare_method(mod, meth_name)
564:         else
565:           def_finder_method(mod, meth_name, type)
566:         end
567:       end

An alias for calling first on the model‘s dataset, but with optimized handling of the single argument case.

[Source]

     # File lib/sequel/model/base.rb, line 571
571:       def first(*args, &block)
572:         if args.length == 1 && !block && !args.first.is_a?(Integer)
573:           # Use optimized finder
574:           first_where(args.first)
575:         else
576:           dataset.first(*args, &block)
577:         end
578:       end

An alias for calling first! on the model‘s dataset, but with optimized handling of the single argument case.

[Source]

     # File lib/sequel/model/base.rb, line 582
582:       def first!(*args, &block)
583:         first(*args, &block) || raise(Sequel::NoMatchingRow.new(dataset))
584:       end

Returns the implicit table name for the model class, which is the demodulized, underscored, pluralized name of the class.

  Artist.implicit_table_name # => :artists
  Foo::ArtistAlias.implicit_table_name # => :artist_aliases

[Source]

     # File lib/sequel/model/base.rb, line 639
639:       def implicit_table_name
640:         pluralize(underscore(demodulize(name))).to_sym
641:       end

Clear the setter_methods cache when a module is included, as it may contain setter methods.

[Source]

     # File lib/sequel/model/base.rb, line 588
588:       def include(*mods)
589:         clear_setter_methods_cache
590:         super
591:       end

If possible, set the dataset for the model subclass as soon as it is created. Also, make sure the inherited class instance variables are copied into the subclass.

Sequel queries the database to get schema information as soon as a model class is created:

  class Artist < Sequel::Model # Causes schema query
  end

[Source]

     # File lib/sequel/model/base.rb, line 602
602:       def inherited(subclass)
603:         super
604:         ivs = subclass.instance_variables.collect(&:to_s)
605:         inherited_instance_variables.each do |iv, dup|
606:           next if ivs.include?(iv.to_s)
607:           if (sup_class_value = instance_variable_get(iv)) && dup
608:             sup_class_value = case dup
609:             when :dup
610:               sup_class_value.dup
611:             when :hash_dup
612:               h = {}
613:               sup_class_value.each{|k,v| h[k] = v.dup}
614:               h
615:             when Proc
616:               dup.call(sup_class_value)
617:             else
618:               raise Error, "bad inherited instance variable type: #{dup.inspect}"
619:             end
620:           end
621:           subclass.instance_variable_set(iv, sup_class_value)
622:         end
623: 
624:         unless ivs.include?("@dataset")
625:           if @dataset && self != Model
626:             subclass.set_dataset(@dataset.clone, :inherited=>true)
627:           elsif (n = subclass.name) && !n.to_s.empty?
628:             db
629:             subclass.set_dataset(subclass.implicit_table_name)
630:           end
631:         end
632:       end

Calls call with the values hash. Only for backwards compatibility.

[Source]

     # File lib/sequel/model/base.rb, line 644
644:       def load(values)
645:         call(values)
646:       end

Clear the setter_methods cache when a setter method is added

[Source]

     # File lib/sequel/model/base.rb, line 649
649:       def method_added(meth)
650:         clear_setter_methods_cache if meth.to_s =~ SETTER_METHOD_REGEXP
651:         super
652:       end

Mark the model as not having a primary key. Not having a primary key can cause issues, among which is that you won‘t be able to update records.

  Artist.primary_key # => :id
  Artist.no_primary_key
  Artist.primary_key # => nil

[Source]

     # File lib/sequel/model/base.rb, line 660
660:       def no_primary_key
661:         clear_setter_methods_cache
662:         self.simple_pk = @primary_key = nil
663:       end

Loads a plugin for use with the model class, passing optional arguments to the plugin. If the plugin is a module, load it directly. Otherwise, require the plugin from either sequel/plugins/#{plugin} or sequel_#{plugin}, and then attempt to load the module using a the camelized plugin name under Sequel::Plugins.

[Source]

     # File lib/sequel/model/base.rb, line 670
670:       def plugin(plugin, *args, &block)
671:         m = plugin.is_a?(Module) ? plugin : plugin_module(plugin)
672:         unless @plugins.include?(m)
673:           @plugins << m
674:           m.apply(self, *args, &block) if m.respond_to?(:apply)
675:           extend(m::ClassMethods) if plugin_module_defined?(m, :ClassMethods)
676:           include(m::InstanceMethods) if plugin_module_defined?(m, :InstanceMethods)
677:           if plugin_module_defined?(m, :DatasetMethods)
678:             dataset_extend(m::DatasetMethods, :create_class_methods=>false)
679:           end
680:         end
681:         m.configure(self, *args, &block) if m.respond_to?(:configure)
682:       end

Similar to finder, but uses a prepared statement instead of a placeholder literalizer. This makes the SQL used static (cannot vary per call), but allows binding argument values instead of literalizing them into the SQL query string.

If a block is used with this method, it is instance_execed by the model, and should accept the desired number of placeholder arguments.

The options are the same as the options for finder, with the following exception:

:type :Specifies the type of prepared statement to create

[Source]

     # File lib/sequel/model/base.rb, line 736
736:       def prepared_finder(meth=OPTS, opts=OPTS, &block)
737:         if block
738:           raise Error, "cannot pass both a method name argument and a block of Model.finder" unless meth.is_a?(Hash)
739:           meth = meth.merge(:prepare=>true)
740:         else
741:           opts = opts.merge(:prepare=>true)
742:         end
743:         finder(meth, opts, &block)
744:       end

Returns primary key attribute hash. If using a composite primary key value such be an array with values for each primary key in the correct order. For a standard primary key, value should be an object with a compatible type for the key. If the model does not have a primary key, raises an Error.

  Artist.primary_key_hash(1) # => {:id=>1}
  Artist.primary_key_hash([1, 2]) # => {:id1=>1, :id2=>2}

[Source]

     # File lib/sequel/model/base.rb, line 692
692:       def primary_key_hash(value)
693:         case key = @primary_key
694:         when Symbol
695:           {key => value}
696:         when Array
697:           hash = {}
698:           key.zip(Array(value)){|k,v| hash[k] = v}
699:           hash
700:         else
701:           raise(Error, "#{self} does not have a primary key")
702:         end
703:       end

Return a hash where the keys are qualified column references. Uses the given qualifier if provided, or the table_name otherwise. This is useful if you plan to join other tables to this table and you want the column references to be qualified.

  Artist.filter(Artist.qualified_primary_key_hash(1))
  # SELECT * FROM artists WHERE (artists.id = 1)

[Source]

     # File lib/sequel/model/base.rb, line 712
712:       def qualified_primary_key_hash(value, qualifier=table_name)
713:         case key = @primary_key
714:         when Symbol
715:           {SQL::QualifiedIdentifier.new(qualifier, key) => value}
716:         when Array
717:           hash = {}
718:           key.zip(Array(value)){|k,v| hash[SQL::QualifiedIdentifier.new(qualifier, k)] = v}
719:           hash
720:         else
721:           raise(Error, "#{self} does not have a primary key")
722:         end
723:       end

Restrict the setting of the primary key(s) when using mass assignment (e.g. set). Because this is the default, this only make sense to use in a subclass where the parent class has used unrestrict_primary_key.

[Source]

     # File lib/sequel/model/base.rb, line 749
749:       def restrict_primary_key
750:         clear_setter_methods_cache
751:         @restrict_primary_key = true
752:       end

Whether or not setting the primary key(s) when using mass assignment (e.g. set) is restricted, true by default.

[Source]

     # File lib/sequel/model/base.rb, line 756
756:       def restrict_primary_key?
757:         @restrict_primary_key
758:       end

Set the columns to allow when using mass assignment (e.g. set). Using this means that any columns not listed here will not be modified. If you have any virtual setter methods (methods that end in =) that you want to be used during mass assignment, they need to be listed here as well (without the =).

It may be better to use a method such as set_only or set_fields that lets you specify the allowed fields per call.

  Artist.set_allowed_columns(:name, :hometown)
  Artist.set(:name=>'Bob', :hometown=>'Sactown') # No Error
  Artist.set(:name=>'Bob', :records_sold=>30000) # Error

[Source]

     # File lib/sequel/model/base.rb, line 771
771:       def set_allowed_columns(*cols)
772:         clear_setter_methods_cache
773:         @allowed_columns = cols
774:       end

Sets the dataset associated with the Model class. ds can be a Symbol, LiteralString, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression (all specifying a table name in the current database), or a Dataset. If a dataset is used, the model‘s database is changed to the database of the given dataset. If a dataset is not used, a dataset is created from the current database with the table name given. Other arguments raise an Error. Returns self.

This changes the row_proc of the dataset to return model objects and extends the dataset with the dataset_method_modules. It also attempts to determine the database schema for the model, based on the given dataset.

  Artist.set_dataset(:tbl_artists)
  Artist.set_dataset(DB[:artists])

Note that you should not use this to change the model‘s dataset at runtime. If you have that need, you should look into Sequel‘s sharding support.

[Source]

     # File lib/sequel/model/base.rb, line 796
796:       def set_dataset(ds, opts=OPTS)
797:         inherited = opts[:inherited]
798:         @dataset = convert_input_dataset(ds)
799:         @require_modification = Sequel::Model.require_modification.nil? ? @dataset.provides_accurate_rows_matched? : Sequel::Model.require_modification
800:         if inherited
801:           self.simple_table = superclass.simple_table
802:           @columns = superclass.instance_variable_get(:@columns)
803:           @db_schema = superclass.instance_variable_get(:@db_schema)
804:         else
805:           @dataset_method_modules.each{|m| @dataset.extend(m)} if @dataset_method_modules
806:           @db_schema = get_db_schema
807:         end
808: 
809:         @dataset.model = self if @dataset.respond_to?(:model=)
810:         reset_instance_dataset
811:         self
812:       end

Sets the primary key for this model. You can use either a regular or a composite primary key. To not use a primary key, set to nil or use no_primary_key. On most adapters, Sequel can automatically determine the primary key to use, so this method is not needed often.

  class Person < Sequel::Model
    # regular key
    set_primary_key :person_id
  end

  class Tagging < Sequel::Model
    # composite key
    set_primary_key [:taggable_id, :tag_id]
  end

[Source]

     # File lib/sequel/model/base.rb, line 828
828:       def set_primary_key(key)
829:         clear_setter_methods_cache
830:         if key.is_a?(Array)
831:           if key.length < 2
832:             key = key.first
833:           else
834:             key = key.dup.freeze
835:           end
836:         end
837:         self.simple_pk = if key && !key.is_a?(Array)
838:           (@dataset || db).literal(key)
839:         end
840:         @primary_key = key
841:       end

Cache of setter methods to allow by default, in order to speed up new/set/update instance methods.

[Source]

     # File lib/sequel/model/base.rb, line 844
844:       def setter_methods
845:         @setter_methods ||= get_setter_methods
846:       end

Sets up a dataset method that returns a filtered dataset. Sometimes thought of as a scope, and like most dataset methods, they can be chained. For example:

  Topic.subset(:joes, :username.like('%joe%'))
  Topic.subset(:popular){num_posts > 100}
  Topic.subset(:recent){created_on > Date.today - 7}

Allows you to do:

  Topic.joes.recent.popular

to get topics with a username that includes joe that have more than 100 posts and were created less than 7 days ago.

Both the args given and the block are passed to Dataset#filter.

This method creates dataset methods that do not accept arguments. To create dataset methods that accept arguments, you should use define a method directly inside a dataset_module block.

[Source]

     # File lib/sequel/model/base.rb, line 870
870:       def subset(name, *args, &block)
871:         def_dataset_method(name){filter(*args, &block)}
872:       end

Returns name of primary table for the dataset. If the table for the dataset is aliased, returns the aliased name.

  Artist.table_name # => :artists
  Sequel::Model(:foo).table_name # => :foo
  Sequel::Model(:foo___bar).table_name # => :bar

[Source]

     # File lib/sequel/model/base.rb, line 880
880:       def table_name
881:         dataset.first_source_alias
882:       end

Allow the setting of the primary key(s) when using the mass assignment methods. Using this method can open up security issues, be very careful before using it.

  Artist.set(:id=>1) # Error
  Artist.unrestrict_primary_key
  Artist.set(:id=>1) # No Error

[Source]

     # File lib/sequel/model/base.rb, line 890
890:       def unrestrict_primary_key
891:         clear_setter_methods_cache
892:         @restrict_primary_key = false
893:       end

Return the model instance with the primary key, or nil if there is no matching record.

[Source]

     # File lib/sequel/model/base.rb, line 896
896:       def with_pk(pk)
897:         primary_key_lookup(pk)
898:       end

Return the model instance with the primary key, or raise NoMatchingRow if there is no matching record.

[Source]

     # File lib/sequel/model/base.rb, line 901
901:       def with_pk!(pk)
902:         with_pk(pk) || raise(NoMatchingRow.new(dataset))
903:       end

[Validate]