Module: Sequel::Model::ClassMethods

Included in:
Sequel::Model
Defined in:
lib/sequel/model/base.rb

Overview

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.

Constant Summary

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#allowed_columnsObject (readonly)

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



15
16
17
# File 'lib/sequel/model/base.rb', line 15

def allowed_columns
  @allowed_columns
end

#cache_anonymous_modelsObject

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.



20
21
22
# File 'lib/sequel/model/base.rb', line 20

def cache_anonymous_models
  @cache_anonymous_models
end

#dataset_method_modulesObject (readonly)

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.



25
26
27
# File 'lib/sequel/model/base.rb', line 25

def dataset_method_modules
  @dataset_method_modules
end

#default_set_fields_optionsObject

The default options to use for Model#set_fields. These are merged with the options given to set_fields.



29
30
31
# File 'lib/sequel/model/base.rb', line 29

def default_set_fields_options
  @default_set_fields_options
end

#fast_instance_delete_sqlObject (readonly)

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.



33
34
35
# File 'lib/sequel/model/base.rb', line 33

def fast_instance_delete_sql
  @fast_instance_delete_sql
end

#instance_datasetObject (readonly)

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.



37
38
39
# File 'lib/sequel/model/base.rb', line 37

def instance_dataset
  @instance_dataset
end

#pluginsObject (readonly)

Array of plugin modules loaded by this class

Sequel::Model.plugins
# => [Sequel::Model, Sequel::Model::Associations]


43
44
45
# File 'lib/sequel/model/base.rb', line 43

def plugins
  @plugins
end

#primary_keyObject (readonly)

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.



48
49
50
# File 'lib/sequel/model/base.rb', line 48

def primary_key
  @primary_key
end

#raise_on_save_failureObject

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



53
54
55
# File 'lib/sequel/model/base.rb', line 53

def raise_on_save_failure
  @raise_on_save_failure
end

#raise_on_typecast_failureObject

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.



58
59
60
# File 'lib/sequel/model/base.rb', line 58

def raise_on_typecast_failure
  @raise_on_typecast_failure
end

#require_modificationObject

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



63
64
65
# File 'lib/sequel/model/base.rb', line 63

def require_modification
  @require_modification
end

#require_valid_tableObject

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


83
84
85
# File 'lib/sequel/model/base.rb', line 83

def require_valid_table
  @require_valid_table
end

#simple_pkObject

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.



87
88
89
# File 'lib/sequel/model/base.rb', line 87

def simple_pk
  @simple_pk
end

#simple_tableObject

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.[].



91
92
93
# File 'lib/sequel/model/base.rb', line 91

def simple_table
  @simple_table
end

#strict_param_settingObject

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.



98
99
100
# File 'lib/sequel/model/base.rb', line 98

def strict_param_setting
  @strict_param_setting
end

#typecast_empty_string_to_nilObject

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.



105
106
107
# File 'lib/sequel/model/base.rb', line 105

def typecast_empty_string_to_nil
  @typecast_empty_string_to_nil
end

#typecast_on_assignmentObject

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.



110
111
112
# File 'lib/sequel/model/base.rb', line 110

def typecast_on_assignment
  @typecast_on_assignment
end

#use_after_commit_rollbackObject

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



115
116
117
# File 'lib/sequel/model/base.rb', line 115

def use_after_commit_rollback
  @use_after_commit_rollback
end

#use_transactionsObject

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.



120
121
122
# File 'lib/sequel/model/base.rb', line 120

def use_transactions
  @use_transactions
end

Instance Method Details

#[](*args) ⇒ Object

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


220
221
222
223
# File 'lib/sequel/model/base.rb', line 220

def [](*args)
  args = args.first if args.size <= 1
  args.is_a?(Hash) ? first_where(args) : (primary_key_lookup(args) unless args.nil?)
end

#call(values) ⇒ Object

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.



229
230
231
232
233
# File 'lib/sequel/model/base.rb', line 229

def call(values)
  o = allocate
  o.instance_variable_set(:@values, values)
  o
end

#clear_setter_methods_cacheObject

Clear the setter_methods cache



236
237
238
# File 'lib/sequel/model/base.rb', line 236

def clear_setter_methods_cache
  @setter_methods = nil
end

#columnsObject

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]


247
248
249
# File 'lib/sequel/model/base.rb', line 247

def columns
  @columns || set_columns(dataset.naked.columns)
end

#create(values = {}, &block) ⇒ Object

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')


259
260
261
# File 'lib/sequel/model/base.rb', line 259

def create(values = {}, &block)
  new(values, &block).save
end

#datasetObject

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


269
270
271
# File 'lib/sequel/model/base.rb', line 269

def dataset
  @dataset || raise(Error, "No dataset associated with #{self}")
end

#dataset=(ds) ⇒ Object

Alias of set_dataset



274
275
276
# File 'lib/sequel/model/base.rb', line 274

def dataset=(ds)
  set_dataset(ds)
end

#dataset_module(mod = nil) ⇒ Object

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
Album.dataset_module Sequel::ColumnsIntrospection

# Usage with anonymous module
Album.dataset_module do
  def foo
    :bar
  end
end
Album.dataset.foo
# => :bar
Album.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, which defines a dataset method that adds a filter. There are also a number of other methods with the same names as the dataset methods, which can use to define named dataset methods:

Album.dataset_module do
  subset :released, Sequel.identifier(release_date) <= Sequel::CURRENT_DATE
  order :by_release_date, :release_date
  select :for_select_options, :id, :name, :release_date
end
Album.released.sql
# => "SELECT * FROM artists WHERE (release_date <= CURRENT_DATE)"
Album.by_release_date.sql
# => "SELECT * FROM artists ORDER BY release_date"
Album.for_select_options.sql
# => "SELECT id, name, release_date FROM artists"
Album.released.by_release_date.for_select_options.sql
# => "SELECT id, name, release_date FROM artists WHERE (release_date <= CURRENT_DATE) ORDER BY release_date"

The following methods are supported: distinct, exclude, exclude_having, grep, group, group_and_count, group_append, having, limit, offset, order, order_append, order_prepend, select, select_all, select_append, select_group, where, and server.

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.



329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/sequel/model/base.rb', line 329

def dataset_module(mod = nil)
  if mod
    raise Error, "can't provide both argument and block to Model.dataset_module" if block_given?
    dataset_extend(mod)
    mod
  else
    @dataset_module ||= DatasetModule.new(self)
    @dataset_module.module_eval(&Proc.new) if block_given?
    dataset_extend(@dataset_module)
    @dataset_module
  end
end

#dbObject

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

Raises:



352
353
354
355
356
357
# File 'lib/sequel/model/base.rb', line 352

def db
  return @db if @db
  @db = self == Model ? Sequel.synchronize{DATABASES.first} : superclass.db
  raise(Error, "No database associated with #{self}: have you called Sequel.connect or #{self}.db= ?") unless @db
  @db
end

#db=(db) ⇒ Object

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.



373
374
375
376
# File 'lib/sequel/model/base.rb', line 373

def db=(db)
  @db = db
  set_dataset(db.dataset.clone(@dataset.opts)) if @dataset
end

#db_schemaObject

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


386
387
388
# File 'lib/sequel/model/base.rb', line 386

def db_schema
  @db_schema ||= get_db_schema
end

#def_column_alias(meth, column) ⇒ Object

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



392
393
394
395
396
397
398
# File 'lib/sequel/model/base.rb', line 392

def def_column_alias(meth, column)
  clear_setter_methods_cache
  overridable_methods_module.module_eval do
    define_method(meth){self[column]}
    define_method("#{meth}="){|v| self[column] = v}
  end
end

#def_dataset_method(*args, &block) ⇒ Object

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.

Using dataset_module is recommended over using this method. In addition to allowing more natural ruby syntax for defining methods manually, it also offers numerous helper methods that make defining common dataset methods more easily, as well as supporting dataset caching (assuming the arguments allow it).

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

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

Raises:



421
422
423
424
425
426
427
428
429
430
# File 'lib/sequel/model/base.rb', line 421

def def_dataset_method(*args, &block)
  raise(Error, "No arguments given") if args.empty?

  if block
    raise(Error, "Defining a dataset method using a block requires only one argument") if args.length > 1
    dataset_module{define_method(args.first, &block)}
  else
    args.each{|arg| def_model_dataset_method(arg)}
  end
end

#def_Model(mod) ⇒ Object

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


142
143
144
145
146
147
# File 'lib/sequel/model/base.rb', line 142

def def_Model(mod)
  model = self
  (class << mod; self; end).send(:define_method, :Model) do |source|
    model.Model(source)
  end
end

#find(*args, &block) ⇒ Object

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


440
441
442
443
444
445
446
447
# File 'lib/sequel/model/base.rb', line 440

def find(*args, &block)
  if args.length == 1 && !block
    # Use optimized finder
    first_where(args.first)
  else
    where(*args, &block).first
  end
end

#find_or_create(cond, &block) ⇒ Object

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')


461
462
463
# File 'lib/sequel/model/base.rb', line 461

def find_or_create(cond, &block)
  find(cond) || create(cond, &block)
end

#finder(meth = OPTS, opts = OPTS, &block) ⇒ Object

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.



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'lib/sequel/model/base.rb', line 523

def finder(meth=OPTS, opts=OPTS, &block)
  if block
    raise Error, "cannot pass both a method name argument and a block of Model.finder" unless meth.is_a?(Hash)
    raise Error, "cannot pass two option hashes to Model.finder" unless opts.equal?(OPTS)
    opts = meth
    raise Error, "must provide method name via :name option when passing block to Model.finder" unless meth_name = opts[:name]
  end

  type = opts.fetch(:type, :first)
  unless prepare = opts[:prepare]
    raise Error, ":type option to Model.finder must be :first, :all, :each, or :get" unless FINDER_TYPES.include?(type)
  end
  limit1 = type == :first || type == :get
  meth_name ||= opts[:name] || :#{type}_#{meth}"

  argn = lambda do |model|
    if arity = opts[:arity]
      arity
    else
      method = block || model.method(meth)
      (method.arity < 0 ? method.arity.abs - 1 : method.arity)
    end
  end

  loader_proc = if prepare
    proc do |model|
      args = prepare_method_args('$a', argn.call(model))
      ds = if block
        model.instance_exec(*args, &block)
      else
        model.send(meth, *args)
      end
      ds = ds.limit(1) if limit1
      model_name = model.name
      if model_name.to_s.empty?
        model_name = model.object_id
      else
        model_name = model_name.gsub(/\W/, '_')
      end
      ds.prepare(type, :#{model_name}_#{meth_name}")
    end
  else
    proc do |model|
      n = argn.call(model)
      block ||= lambda do |pl, model2|
        args = (0...n).map{pl.arg}
        ds = model2.send(meth, *args)
        ds = ds.limit(1) if limit1
        ds
      end

      Sequel::Dataset::PlaceholderLiteralizer.loader(model, &block) 
    end
  end

  Sequel.synchronize{@finder_loaders[meth_name] = loader_proc}
  mod = opts[:mod] || (class << self; self; end)
  if prepare
    def_prepare_method(mod, meth_name)
  else
    def_finder_method(mod, meth_name, type)
  end
end

#first(*args, &block) ⇒ Object

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



589
590
591
592
593
594
595
596
# File 'lib/sequel/model/base.rb', line 589

def first(*args, &block)
  if args.length == 1 && !block && !args.first.is_a?(Integer)
    # Use optimized finder
    first_where(args.first)
  else
    dataset.first(*args, &block)
  end
end

#first!(*args, &block) ⇒ Object

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



600
601
602
# File 'lib/sequel/model/base.rb', line 600

def first!(*args, &block)
  first(*args, &block) || raise(Sequel::NoMatchingRow.new(dataset))
end

#implicit_table_nameObject

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


657
658
659
# File 'lib/sequel/model/base.rb', line 657

def implicit_table_name
  pluralize(underscore(demodulize(name))).to_sym
end

#include(*mods) ⇒ Object

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



606
607
608
609
# File 'lib/sequel/model/base.rb', line 606

def include(*mods)
  clear_setter_methods_cache
  super
end

#inherited(subclass) ⇒ Object

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


620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
# File 'lib/sequel/model/base.rb', line 620

def inherited(subclass)
  super
  ivs = subclass.instance_variables.collect(&:to_s)
  inherited_instance_variables.each do |iv, dup|
    next if ivs.include?(iv.to_s)
    if (sup_class_value = instance_variable_get(iv)) && dup
      sup_class_value = case dup
      when :dup
        sup_class_value.dup
      when :hash_dup
        h = {}
        sup_class_value.each{|k,v| h[k] = v.dup}
        h
      when Proc
        dup.call(sup_class_value)
      else
        raise Error, "bad inherited instance variable type: #{dup.inspect}"
      end
    end
    subclass.instance_variable_set(iv, sup_class_value)
  end

  unless ivs.include?("@dataset")
    if @dataset && self != Model
      subclass.set_dataset(@dataset.clone, :inherited=>true)
    elsif (n = subclass.name) && !n.to_s.empty?
      db
      subclass.set_dataset(subclass.implicit_table_name)
    end
  end
end

#load(values) ⇒ Object

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



662
663
664
# File 'lib/sequel/model/base.rb', line 662

def load(values)
  call(values)
end

#method_added(meth) ⇒ Object

Clear the setter_methods cache when a setter method is added



667
668
669
670
# File 'lib/sequel/model/base.rb', line 667

def method_added(meth)
  clear_setter_methods_cache if meth.to_s =~ SETTER_METHOD_REGEXP
  super
end

#Model(source) ⇒ Object

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


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/sequel/model/base.rb', line 185

def Model(source)
  if cache_anonymous_models
    mutex = @Model_mutex
    cache = mutex.synchronize{@Model_cache ||= {}}

    if klass = mutex.synchronize{cache[source]}
      return klass
    end
  end

  klass = Class.new(self)

  if source.is_a?(::Sequel::Database)
    klass.db = source
  else
    klass.set_dataset(source)
  end

  if cache_anonymous_models
    mutex.synchronize{cache[source] = klass}
  end

  klass
end

#no_primary_keyObject

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


678
679
680
681
# File 'lib/sequel/model/base.rb', line 678

def no_primary_key
  clear_setter_methods_cache
  self.simple_pk = @primary_key = nil
end

#plugin(plugin, *args, &block) ⇒ Object

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.



688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'lib/sequel/model/base.rb', line 688

def plugin(plugin, *args, &block)
  m = plugin.is_a?(Module) ? plugin : plugin_module(plugin)
  unless @plugins.include?(m)
    @plugins << m
    m.apply(self, *args, &block) if m.respond_to?(:apply)
    extend(m::ClassMethods) if plugin_module_defined?(m, :ClassMethods)
    include(m::InstanceMethods) if plugin_module_defined?(m, :InstanceMethods)
    if plugin_module_defined?(m, :DatasetMethods)
      dataset_extend(m::DatasetMethods, :create_class_methods=>false)
    end
  end
  m.configure(self, *args, &block) if m.respond_to?(:configure)
end

#prepared_finder(meth = OPTS, opts = OPTS, &block) ⇒ Object

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



754
755
756
757
758
759
760
761
762
# File 'lib/sequel/model/base.rb', line 754

def prepared_finder(meth=OPTS, opts=OPTS, &block)
  if block
    raise Error, "cannot pass both a method name argument and a block of Model.finder" unless meth.is_a?(Hash)
    meth = meth.merge(:prepare=>true)
  else
    opts = opts.merge(:prepare=>true)
  end
  finder(meth, opts, &block)
end

#primary_key_hash(value) ⇒ Object

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}


710
711
712
713
714
715
716
717
718
719
720
721
# File 'lib/sequel/model/base.rb', line 710

def primary_key_hash(value)
  case key = @primary_key
  when Symbol
    {key => value}
  when Array
    hash = {}
    key.zip(Array(value)){|k,v| hash[k] = v}
    hash
  else
    raise(Error, "#{self} does not have a primary key")
  end
end

#qualified_primary_key_hash(value, qualifier = table_name) ⇒ Object

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.where(Artist.qualified_primary_key_hash(1))
# SELECT * FROM artists WHERE (artists.id = 1)


730
731
732
733
734
735
736
737
738
739
740
741
# File 'lib/sequel/model/base.rb', line 730

def qualified_primary_key_hash(value, qualifier=table_name)
  case key = @primary_key
  when Symbol
    {SQL::QualifiedIdentifier.new(qualifier, key) => value}
  when Array
    hash = {}
    key.zip(Array(value)){|k,v| hash[SQL::QualifiedIdentifier.new(qualifier, k)] = v}
    hash
  else
    raise(Error, "#{self} does not have a primary key")
  end
end

#restrict_primary_keyObject

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.



767
768
769
770
# File 'lib/sequel/model/base.rb', line 767

def restrict_primary_key
  clear_setter_methods_cache
  @restrict_primary_key = true
end

#restrict_primary_key?Boolean

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

Returns:

  • (Boolean)


774
775
776
# File 'lib/sequel/model/base.rb', line 774

def restrict_primary_key?
  @restrict_primary_key
end

#set_allowed_columns(*cols) ⇒ Object

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


789
790
791
792
# File 'lib/sequel/model/base.rb', line 789

def set_allowed_columns(*cols)
  clear_setter_methods_cache
  @allowed_columns = cols
end

#set_dataset(ds, opts = OPTS) ⇒ Object

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.



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
# File 'lib/sequel/model/base.rb', line 814

def set_dataset(ds, opts=OPTS)
  inherited = opts[:inherited]
  @dataset = convert_input_dataset(ds)
  @require_modification = Sequel::Model.require_modification.nil? ? @dataset.provides_accurate_rows_matched? : Sequel::Model.require_modification
  if inherited
    self.simple_table = superclass.simple_table
    @columns = superclass.instance_variable_get(:@columns)
    @db_schema = superclass.instance_variable_get(:@db_schema)
  else
    @dataset = @dataset.with_extend(*@dataset_method_modules.reverse) if @dataset_method_modules
    @db_schema = get_db_schema
  end

  reset_instance_dataset
  self
end

#set_primary_key(key) ⇒ Object

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


845
846
847
848
849
850
851
852
853
854
855
856
857
858
# File 'lib/sequel/model/base.rb', line 845

def set_primary_key(key)
  clear_setter_methods_cache
  if key.is_a?(Array)
    if key.length < 2
      key = key.first
    else
      key = key.dup.freeze
    end
  end
  self.simple_pk = if key && !key.is_a?(Array)
    (@dataset || db).literal(key)
  end
  @primary_key = key
end

#setter_methodsObject

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



861
862
863
# File 'lib/sequel/model/base.rb', line 861

def setter_methods
  @setter_methods ||= get_setter_methods
end

#subset(name, *args, &block) ⇒ Object

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.



887
888
889
890
891
892
893
894
895
896
# File 'lib/sequel/model/base.rb', line 887

def subset(name, *args, &block)
  if block || args.flatten.any?{|arg| arg.is_a?(Proc)}
    def_dataset_method(name){filter(*args, &block)}
  else
    key = :_subset_#{name}_ds"
    def_dataset_method(name) do
      cached_dataset(key){filter(*args)}
    end
  end
end

#table_nameObject

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


904
905
906
# File 'lib/sequel/model/base.rb', line 904

def table_name
  dataset.first_source_alias
end

#unrestrict_primary_keyObject

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


914
915
916
917
# File 'lib/sequel/model/base.rb', line 914

def unrestrict_primary_key
  clear_setter_methods_cache
  @restrict_primary_key = false
end

#with_pk(pk) ⇒ Object

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



920
921
922
# File 'lib/sequel/model/base.rb', line 920

def with_pk(pk)
  primary_key_lookup(pk)
end

#with_pk!(pk) ⇒ Object

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



925
926
927
# File 'lib/sequel/model/base.rb', line 925

def with_pk!(pk)
  with_pk(pk) || raise(NoMatchingRow.new(dataset))
end