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
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/etc due to a validation failure or a before_* hook
returning false.
raise_on_typecast_failure[RW]
Whether to raise an error when unable to typecast data for a column
(default: true). This should be set to false if you want to use
validations to display nice error messages to the user (e.g. most web
applications). You can use the validates_schema_types validation (from the
validation_helpers plugin) in connection with this setting to check for
typecast failures during validation.
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).
restricted_columns[R]
Which columns are specifically restricted in a call to set/update/new/etc.
(default: not set). Some columns are restricted regardless of this
setting, such as the primary key column and columns in
Model::RESTRICTED_SETTER_METHODS.
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.
[](*args)
click to toggle source
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]
Artist[:name=>'Bob']
def [](*args)
args = args.first if args.size <= 1
args.is_a?(Hash) ? dataset[args] : (primary_key_lookup(args) unless args.nil?)
end
call(values)
click to toggle source
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.
def call(values)
o = allocate
o.set_values(values)
o.after_initialize
o
end
clear_setter_methods_cache()
click to toggle source
Clear the #setter_methods cache
def clear_setter_methods_cache
@setter_methods = nil
end
columns()
click to toggle source
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
def columns
@columns || set_columns(dataset.naked.columns)
end
create(values = {}, &block)
click to toggle source
Creates instance using new with the given values and block, and saves it.
Artist.create(:name=>'Bob')
Artist.create do |a|
a.name = 'Jim'
end
def create(values = {}, &block)
new(values, &block).save
end
dataset()
click to toggle source
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
def dataset
@dataset || raise(Error, "No dataset associated with #{self}")
end
dataset=(ds)
click to toggle source
dataset_module(mod = nil)
click to toggle source
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.
Artist.dataset_module Sequel::ColumnsIntrospection
Artist.dataset_module do
def foo
:bar
end
end
Artist.dataset.foo
Artist.foo
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.
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
db()
click to toggle source
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
Artist.create(:name=>'Bob')
end
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)
click to toggle source
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.
def db=(db)
@db = db
set_dataset(db.dataset(@dataset.opts)) if @dataset
end
db_schema()
click to toggle source
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
def db_schema
@db_schema ||= get_db_schema
end
def_column_alias(meth, column)
click to toggle source
Create a column alias, where the column methods have one name, but the
underlying storage uses a different name.
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)
click to toggle source
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.
Artist.def_dataset_method(:by_name){order(:name)}
Artist.filter(:name.like('A%')).by_name
Artist.by_name.filter(:name.like('A%'))
Artist.def_dataset_method(:server!)
Artist.server!(:server1)
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
find(*args, &block)
click to toggle source
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')
Artist.find{name > 'M'}
def find(*args, &block)
filter(*args, &block).first
end
find_or_create(cond, &block)
click to toggle source
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')
Artist.find_or_create(:name=>'Jim'){|a| a.hometown = 'Sactown'}
def find_or_create(cond, &block)
find(cond) || create(cond, &block)
end
implicit_table_name()
click to toggle source
Returns the implicit table name for the model class, which is the
demodulized, underscored, pluralized name of the class.
Artist.implicit_table_name
Foo::ArtistAlias.implicit_table_name
def implicit_table_name
pluralize(underscore(demodulize(name))).to_sym
end
include(mod)
click to toggle source
Clear the #setter_methods cache
when a module is included, as it may contain setter methods.
Calls superclass method
def include(mod)
clear_setter_methods_cache
super
end
inherited(subclass)
click to toggle source
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
end
Calls superclass method
def inherited(subclass)
super
ivs = subclass.instance_variables.collect{|x| x.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 self == Model || !@dataset
n = subclass.name
unless n.nil? || n.empty?
db
subclass.set_dataset(subclass.implicit_table_name) rescue nil
end
elsif @dataset
subclass.set_dataset(@dataset.clone, :inherited=>true) rescue nil
end
end
end
load(values)
click to toggle source
Calls call with the values
hash. Only for backwards compatibility.
def load(values)
call(values)
end
method_added(meth)
click to toggle source
Clear the #setter_methods cache
when a setter method is added
Calls superclass method
def method_added(meth)
clear_setter_methods_cache if meth.to_s =~ SETTER_METHOD_REGEXP
super
end
no_primary_key()
click to toggle source
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
Artist.no_primary_key
Artist.primary_key
def no_primary_key
clear_setter_methods_cache
self.simple_pk = @primary_key = nil
end
plugin(plugin, *args, &block)
click to toggle source
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.
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)
include(m::InstanceMethods) if plugin_module_defined?(m, :InstanceMethods)
extend(m::ClassMethods)if plugin_module_defined?(m, :ClassMethods)
dataset_extend(m::DatasetMethods) if plugin_module_defined?(m, :DatasetMethods)
end
m.configure(self, *args, &block) if m.respond_to?(:configure)
end
primary_key_hash(value)
click to toggle source
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)
Artist.primary_key_hash([1, 2])
def primary_key_hash(value)
raise(Error, "#{self} does not have a primary key") unless key = @primary_key
case key
when Array
hash = {}
key.each_with_index{|k,i| hash[k] = value[i]}
hash
else
{key => value}
end
end
qualified_primary_key_hash(value, qualifier=table_name)
click to toggle source
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)
def qualified_primary_key_hash(value, qualifier=table_name)
h = primary_key_hash(value)
h.to_a.each{|k,v| h[SQL::QualifiedIdentifier.new(qualifier, k)] = h.delete(k)}
h
end
restrict_primary_key()
click to toggle source
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
.
def restrict_primary_key
clear_setter_methods_cache
@restrict_primary_key = true
end
restrict_primary_key?()
click to toggle source
Whether or not setting the primary key(s) when using mass assignment (e.g.
set
) is restricted, true by default.
def restrict_primary_key?
@restrict_primary_key
end
set_allowed_columns(*cols)
click to toggle source
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')
Artist.set(:name=>'Bob', :records_sold=>30000)
def set_allowed_columns(*cols)
clear_setter_methods_cache
@allowed_columns = cols
end
set_dataset(ds, opts={})
click to toggle source
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.
def set_dataset(ds, opts={})
inherited = opts[:inherited]
@dataset = case ds
when Symbol, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression, LiteralString
self.simple_table = db.literal(ds)
db.from(ds)
when Dataset
self.simple_table = if ds.send(:simple_select_all?)
ds.literal(ds.first_source_table)
else
nil
end
@db = ds.db
ds
else
raise(Error, "Model.set_dataset takes one of the following classes as an argument: Symbol, LiteralString, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression, Dataset")
end
@dataset.row_proc = self
@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 = @dataset.columns rescue nil
else
@dataset_method_modules.each{|m| @dataset.extend(m)} if @dataset_method_modules
end
@dataset.model = self if @dataset.respond_to?(:model=)
check_non_connection_error{@db_schema = (inherited ? superclass.db_schema : get_db_schema)}
reset_instance_dataset
self
end
set_primary_key(*key)
click to toggle source
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
set_primary_key :person_id
end
class Tagging < Sequel::Model
set_primary_key [:taggable_id, :tag_id]
end
def set_primary_key(*key)
clear_setter_methods_cache
key = key.flatten
self.simple_pk = if key.length == 1
(@dataset || db).literal(key.first)
else
nil
end
@primary_key = (key.length == 1) ? key[0] : key
end
set_restricted_columns(*cols)
click to toggle source
Set the columns to restrict when using mass assignment (e.g.
set
). Using this means that attempts to call setter methods
for the columns listed here will cause an exception or be silently skipped
(based on the strict_param_setting
setting). If you have any
virtual setter methods (methods that end in =) that you want not to be used
during mass assignment, they need to be listed here as well (without the
=).
It's generally a bad idea to rely on a blacklist approach for security.
Using a whitelist approach such as #set_allowed_columns
or the instance level set_only or set_fields methods is usually a better
choice. So use of this method is generally a bad idea.
Artist.set_restricted_columns(:records_sold)
Artist.set(:name=>'Bob', :hometown=>'Sactown')
Artist.set(:name=>'Bob', :records_sold=>30000)
def set_restricted_columns(*cols)
clear_setter_methods_cache
@restricted_columns = cols
end
setter_methods()
click to toggle source
Cache of setter methods to allow by default, in order to speed up
new/set/update instance methods.
def setter_methods
@setter_methods ||= if allowed_columns
allowed_columns.map{|x| "#{x}="}
else
meths = instance_methods.collect{|x| x.to_s}.grep(SETTER_METHOD_REGEXP) - RESTRICTED_SETTER_METHODS
meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && restrict_primary_key?
meths -= restricted_columns.map{|x| "#{x}="} if restricted_columns
meths
end
end
subset(name, *args, &block)
click to toggle source
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.
def subset(name, *args, &block)
dataset_module.subset(name, *args, &block)
end
table_name()
click to toggle source
Returns name of primary table for the dataset. If the table for the dataset
is aliased, returns the aliased name.
Artist.table_name
Sequel::Model(:foo).table_name
Sequel::Model(:foo___bar).table_name
def table_name
dataset.first_source_alias
end
unrestrict_primary_key()
click to toggle source
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)
Artist.unrestrict_primary_key
Artist.set(:id=>1)
def unrestrict_primary_key
clear_setter_methods_cache
@restrict_primary_key = false
end
check_non_connection_error() { || ... }
click to toggle source
Yield to the passed block and swallow all errors other than
DatabaseConnectionErrors.
def check_non_connection_error
begin
yield
rescue Sequel::DatabaseConnectionError
raise
rescue
nil
end
end
dataset_extend(mod)
click to toggle source
Add the module to the class's dataset_method_modules. Extend the
dataset with the module if the model has a dataset. Add dataset methods to
the class for all public dataset methods.
def dataset_extend(mod)
@dataset.extend(mod) if defined?(@dataset) && @dataset
reset_instance_dataset
dataset_method_modules << mod
mod.public_instance_methods.each{|meth| def_model_dataset_method(meth)}
end
def_bad_column_accessor(column)
click to toggle source
Create a column accessor for a column with a method name that is hard to
use in ruby code.
def def_bad_column_accessor(column)
overridable_methods_module.module_eval do
define_method(column){self[column]}
define_method("#{column}="){|v| self[column] = v}
end
end
def_column_accessor(*columns)
click to toggle source
Create the column accessors. For columns that can be used as method names
directly in ruby code, use a string to define the method for speed. For
other columns names, use a block.
def def_column_accessor(*columns)
clear_setter_methods_cache
columns, bad_columns = columns.partition{|x| NORMAL_METHOD_NAME_REGEXP.match(x.to_s)}
bad_columns.each{|x| def_bad_column_accessor(x)}
im = instance_methods.collect{|x| x.to_s}
columns.each do |column|
meth = "#{column}="
overridable_methods_module.module_eval("def #{column}; self[:#{column}] end", __FILE__, __LINE__) unless im.include?(column.to_s)
overridable_methods_module.module_eval("def #{meth}(v); self[:#{column}] = v end", __FILE__, __LINE__) unless im.include?(meth)
end
end
def_model_dataset_method(meth)
click to toggle source
Define a model method that calls the dataset method with the same name,
only used for methods with names that can't be presented directly in
ruby code.
def def_model_dataset_method(meth)
return if respond_to?(meth, true)
if meth.to_s =~ NORMAL_METHOD_NAME_REGEXP
instance_eval("def #{meth}(*args, &block); dataset.#{meth}(*args, &block) end", __FILE__, __LINE__)
else
(class << self; self; end).send(:define_method, meth){|*args, &block| dataset.send(meth, *args, &block)}
end
end
get_db_schema(reload = false)
click to toggle source
Get the schema from the database, fall back on checking the columns via the
database if that will return inaccurate results or if it raises an error.
def get_db_schema(reload = false)
set_columns(nil)
return nil unless @dataset
schema_hash = {}
ds_opts = dataset.opts
get_columns = proc{check_non_connection_error{columns} || []}
schema_array = check_non_connection_error{db.schema(dataset, :reload=>reload)}
if schema_array
schema_array.each{|k,v| schema_hash[k] = v}
if ds_opts.include?(:select)
cols = get_columns.call
cols.each{|c| schema_hash[c] ||= {}}
def_column_accessor(*schema_hash.keys)
else
cols = schema_array.collect{|k,v| k}
set_columns(cols)
if schema_array.all?{|k,v| v.has_key?(:primary_key)}
pks = schema_array.collect{|k,v| k if v[:primary_key]}.compact
pks.length > 0 ? set_primary_key(*pks) : no_primary_key
end
dataset.instance_variable_set(:@columns, cols)
end
else
get_columns.call.each{|c| schema_hash[c] = {}}
end
schema_hash
end
inherited_instance_variables()
click to toggle source
A hash of instance variables to automatically set up in subclasses. See
Sequel::Model::INHERITED_INSTANCE_VARIABLES. It is safe to modify the hash
returned by this method, though it may not be safe to modify values of the
hash.
def inherited_instance_variables
INHERITED_INSTANCE_VARIABLES.dup
end
late_binding_class_option(opts, default)
click to toggle source
For the given opts hash and default name or :class option, add a
:class_name option unless already present which contains the name of the
class to use as a string. The purpose is to allow late binding to the
class later using constantize.
def late_binding_class_option(opts, default)
case opts[:class]
when String, Symbol
opts[:class_name] ||= opts.delete(:class).to_s
when Class
opts[:class_name] ||= opts[:class].name
end
opts[:class_name] ||= ((name || '').split("::")[0..-2] + [camelize(default)]).join('::')
end
overridable_methods_module()
click to toggle source
Module that the class includes that holds methods the class adds for column
accessors and associations so that the methods can be overridden with
super
.
def overridable_methods_module
include(@overridable_methods_module = Module.new) unless defined?(@overridable_methods_module) && @overridable_methods_module
@overridable_methods_module
end
plugin_module(plugin)
click to toggle source
Returns the module for the specified plugin. If the module is not defined,
the corresponding plugin required.
def plugin_module(plugin)
module_name = plugin.to_s.gsub(/(^|_)(.)/){|x| x[-1..-1].upcase}
if !Sequel::Plugins.const_defined?(module_name) ||
(Sequel.const_defined?(module_name) &&
Sequel::Plugins.const_get(module_name) == Sequel.const_get(module_name))
begin
Sequel.tsk_require "sequel/plugins/#{plugin}"
rescue LoadError => e
begin
Sequel.tsk_require "sequel_#{plugin}"
rescue LoadError => e2
e.message << "; #{e2.message}"
raise e
end
end
end
Sequel::Plugins.const_get(module_name)
end
plugin_module_defined?(plugin, submod)
click to toggle source
Check if the plugin module plugin
defines the constant named
by submod
.
def plugin_module_defined?(plugin, submod)
if RUBY_VERSION >= '1.9'
plugin.const_defined?(submod, false)
else
plugin.const_defined?(submod)
end
end
primary_key_lookup(pk)
click to toggle source
Find the row in the dataset that matches the primary key. Uses a static SQL optimization if the table and primary key are
simple.
This method should not be called with a nil primary key, in case it is
overridden by plugins which assume that the passed argument is valid.
def primary_key_lookup(pk)
if sql = @fast_pk_lookup_sql
sql = sql.dup
ds = dataset
ds.literal_append(sql, pk)
ds.fetch_rows(sql){|r| return ds.row_proc.call(r)}
nil
else
dataset[primary_key_hash(pk)]
end
end
reset_fast_pk_lookup_sql()
click to toggle source
Reset the cached fast primary lookup SQL if a
simple table and primary key are used, or set it to nil if not used.
def reset_fast_pk_lookup_sql
@fast_pk_lookup_sql = if @simple_table && @simple_pk
"SELECT * FROM #@simple_table WHERE #@simple_pk = ".freeze
end
@fast_instance_delete_sql = if @simple_table && @simple_pk
"DELETE FROM #@simple_table WHERE #@simple_pk = ".freeze
end
end
reset_instance_dataset()
click to toggle source
Reset the instance dataset to a modified copy of the current dataset,
should be used whenever the model's dataset is modified.
def reset_instance_dataset
@instance_dataset = @dataset.limit(1).naked if defined?(@dataset) && @dataset
end
set_columns(new_columns)
click to toggle source
Set the columns for this model and create accessor methods for each column.
def set_columns(new_columns)
@columns = new_columns
def_column_accessor(*new_columns) if new_columns
@columns
end
simple_pk=(pk)
click to toggle source
Reset the fast primary key lookup SQL when the #simple_pk value
changes.
def simple_pk=(pk)
@simple_pk = pk
reset_fast_pk_lookup_sql
end
simple_table=(t)
click to toggle source
Reset the fast primary key lookup SQL when the #simple_table value
changes.
def simple_table=(t)
@simple_table = t
reset_fast_pk_lookup_sql
end