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.
Instance Attribute Summary collapse
-
#allowed_columns ⇒ Object
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).
-
#cache_anonymous_models ⇒ Object
Whether to cache the anonymous models created by Sequel::Model().
-
#dataset_method_modules ⇒ Object
readonly
Array of modules that extend this model’s dataset.
-
#dataset_methods ⇒ Object
readonly
Hash of dataset methods with method name keys and proc values that are stored so when the dataset changes, methods defined with def_dataset_method will be applied to the new dataset.
-
#fast_instance_delete_sql ⇒ Object
readonly
SQL string fragment used for faster DELETE statement creation when deleting/destroying model instances, or nil if the optimization should not be used.
-
#instance_dataset ⇒ Object
readonly
The dataset that instance datasets (#this) are based on.
-
#plugins ⇒ Object
readonly
Array of plugin modules loaded by this class.
-
#primary_key ⇒ Object
readonly
The primary key for the class.
-
#raise_on_save_failure ⇒ Object
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 ⇒ Object
Whether to raise an error when unable to typecast data for a column (default: true).
-
#require_modification ⇒ Object
Whether to raise an error if an UPDATE or DELETE query related to a model instance does not modify exactly 1 row.
-
#restricted_columns ⇒ Object
readonly
Which columns are specifically restricted in a call to set/update/new/etc.
-
#simple_pk ⇒ Object
readonly
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 ⇒ Object
readonly
Should be the literal table name if this Model’s dataset is a simple table (no select, order, join, etc.), or nil otherwise.
-
#strict_param_setting ⇒ Object
Whether new/set/update and their variants should raise an error if an invalid key is used.
-
#typecast_empty_string_to_nil ⇒ Object
Whether to typecast the empty string (”) to nil for columns that are not string or blob.
-
#typecast_on_assignment ⇒ Object
Whether to typecast attribute values on assignment (default: true).
-
#use_after_commit_rollback ⇒ Object
Whether to enable the after_commit and after_rollback hooks when saving/destroying instances.
-
#use_transactions ⇒ Object
Whether to use a transaction by default when saving/deleting records (default: true).
Instance Method Summary collapse
-
#[](*args) ⇒ Object
Returns the first record from the database matching the conditions.
-
#call(values) ⇒ Object
Initializes a model instance as an existing record.
-
#clear_setter_methods_cache ⇒ Object
Clear the setter_methods cache.
-
#columns ⇒ Object
Returns the columns in the result set in their original order.
-
#create(values = {}, &block) ⇒ Object
Creates instance using new with the given values and block, and saves it.
-
#dataset ⇒ Object
Returns the dataset associated with the Model class.
-
#dataset=(ds) ⇒ Object
Alias of set_dataset.
-
#dataset_module(mod = nil) ⇒ Object
Extend the dataset with a module, similar to adding a plugin with the methods defined in DatasetMethods.
-
#db ⇒ Object
Returns the database associated with the Model class.
-
#db=(db) ⇒ Object
Sets the database associated with the Model class.
-
#db_schema ⇒ Object
Returns the cached schema information if available or gets it from the database.
-
#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.
-
#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.
-
#find(*args, &block) ⇒ Object
Finds a single record according to the supplied filter.
-
#find_or_create(cond, &block) ⇒ Object
Like
find
but invokes create with given conditions when record does not exist. -
#implicit_table_name ⇒ Object
Returns the implicit table name for the model class, which is the demodulized, underscored, pluralized name of the class.
-
#include(mod) ⇒ Object
Clear the setter_methods cache when a module is included, as it may contain setter methods.
-
#inherited(subclass) ⇒ Object
If possible, set the dataset for the model subclass as soon as it is created.
-
#load(values) ⇒ Object
Calls #call with the values hash.
-
#method_added(meth) ⇒ Object
Clear the setter_methods cache when a setter method is added.
-
#no_primary_key ⇒ Object
Mark the model as not having a primary key.
-
#plugin(plugin, *args, &block) ⇒ Object
Loads a plugin for use with the model class, passing optional arguments to the plugin.
-
#primary_key_hash(value) ⇒ Object
Returns primary key attribute hash.
-
#qualified_primary_key_hash(value, qualifier = table_name) ⇒ Object
Return a hash where the keys are qualified column references.
-
#restrict_primary_key ⇒ Object
Restrict the setting of the primary key(s) when using mass assignment (e.g.
set
). -
#restrict_primary_key? ⇒ Boolean
Whether or not setting the primary key(s) when using mass assignment (e.g.
set
) is restricted, true by default. -
#set_allowed_columns(*cols) ⇒ Object
Set the columns to allow when using mass assignment (e.g.
set
). -
#set_dataset(ds, opts = {}) ⇒ Object
Sets the dataset associated with the Model class.
-
#set_primary_key(*key) ⇒ Object
Sets the primary key for this model.
-
#set_restricted_columns(*cols) ⇒ Object
Set the columns to restrict when using mass assignment (e.g.
set
). -
#setter_methods ⇒ Object
Cache of setter methods to allow by default, in order to speed up new/set/update instance methods.
-
#subset(name, *args, &block) ⇒ Object
Shortcut for
def_dataset_method
that is restricted to modifying the dataset’s filter. -
#table_name ⇒ Object
Returns name of primary table for the dataset.
-
#unrestrict_primary_key ⇒ Object
Allow the setting of the primary key(s) when using the mass assignment methods.
Instance Attribute Details
#allowed_columns ⇒ Object (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_models ⇒ Object
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_modules ⇒ Object (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 |
#dataset_methods ⇒ Object (readonly)
Hash of dataset methods with method name keys and proc values that are stored so when the dataset changes, methods defined with def_dataset_method will be applied to the new dataset.
30 31 32 |
# File 'lib/sequel/model/base.rb', line 30 def dataset_methods @dataset_methods end |
#fast_instance_delete_sql ⇒ Object (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.
34 35 36 |
# File 'lib/sequel/model/base.rb', line 34 def fast_instance_delete_sql @fast_instance_delete_sql end |
#instance_dataset ⇒ Object (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.
38 39 40 |
# File 'lib/sequel/model/base.rb', line 38 def instance_dataset @instance_dataset end |
#plugins ⇒ Object (readonly)
44 45 46 |
# File 'lib/sequel/model/base.rb', line 44 def plugins @plugins end |
#primary_key ⇒ Object (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.
49 50 51 |
# File 'lib/sequel/model/base.rb', line 49 def primary_key @primary_key end |
#raise_on_save_failure ⇒ Object
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.
54 55 56 |
# File 'lib/sequel/model/base.rb', line 54 def raise_on_save_failure @raise_on_save_failure end |
#raise_on_typecast_failure ⇒ Object
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_not_string validations (from either the validation_helpers or validation_class_methods standard plugins) in connection with option to check for typecast failures for columns that aren’t blobs or strings.
63 64 65 |
# File 'lib/sequel/model/base.rb', line 63 def raise_on_typecast_failure @raise_on_typecast_failure end |
#require_modification ⇒ Object
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).
68 69 70 |
# File 'lib/sequel/model/base.rb', line 68 def require_modification @require_modification end |
#restricted_columns ⇒ Object (readonly)
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.
73 74 75 |
# File 'lib/sequel/model/base.rb', line 73 def restricted_columns @restricted_columns end |
#simple_pk ⇒ Object
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.
77 78 79 |
# File 'lib/sequel/model/base.rb', line 77 def simple_pk @simple_pk end |
#simple_table ⇒ Object
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.[].
81 82 83 |
# File 'lib/sequel/model/base.rb', line 81 def simple_table @simple_table end |
#strict_param_setting ⇒ Object
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.
88 89 90 |
# File 'lib/sequel/model/base.rb', line 88 def strict_param_setting @strict_param_setting end |
#typecast_empty_string_to_nil ⇒ Object
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.
95 96 97 |
# File 'lib/sequel/model/base.rb', line 95 def typecast_empty_string_to_nil @typecast_empty_string_to_nil end |
#typecast_on_assignment ⇒ Object
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.
100 101 102 |
# File 'lib/sequel/model/base.rb', line 100 def typecast_on_assignment @typecast_on_assignment end |
#use_after_commit_rollback ⇒ Object
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).
105 106 107 |
# File 'lib/sequel/model/base.rb', line 105 def use_after_commit_rollback @use_after_commit_rollback end |
#use_transactions ⇒ Object
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.
110 111 112 |
# File 'lib/sequel/model/base.rb', line 110 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', ...}>
122 123 124 125 |
# File 'lib/sequel/model/base.rb', line 122 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) ⇒ 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.
131 132 133 134 135 136 |
# File 'lib/sequel/model/base.rb', line 131 def call(values) o = allocate o.set_values(values) o.after_initialize o end |
#clear_setter_methods_cache ⇒ Object
Clear the setter_methods cache
139 140 141 |
# File 'lib/sequel/model/base.rb', line 139 def clear_setter_methods_cache @setter_methods = nil end |
#columns ⇒ Object
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]
150 151 152 |
# File 'lib/sequel/model/base.rb', line 150 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')
162 163 164 |
# File 'lib/sequel/model/base.rb', line 162 def create(values = {}, &block) new(values, &block).save end |
#dataset ⇒ Object
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
172 173 174 |
# File 'lib/sequel/model/base.rb', line 172 def dataset @dataset || raise(Error, "No dataset associated with #{self}") end |
#dataset=(ds) ⇒ Object
Alias of set_dataset
177 178 179 |
# File 'lib/sequel/model/base.rb', line 177 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. If a block is given, an anonymous module is created and the module_evaled, otherwise the argument should be a module. 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
# => :bar
Artist.foo
# => :bar
198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/sequel/model/base.rb', line 198 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 ||= Module.new @dataset_module.module_eval(&Proc.new) if block_given? dataset_extend(@dataset_module) @dataset_module end end |
#db ⇒ Object
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
221 222 223 224 225 226 |
# File 'lib/sequel/model/base.rb', line 221 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
238 239 240 241 |
# File 'lib/sequel/model/base.rb', line 238 def db=(db) @db = db set_dataset(db.dataset(@dataset.opts)) if @dataset end |
#db_schema ⇒ Object
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, ...}}
251 252 253 |
# File 'lib/sequel/model/base.rb', line 251 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.
257 258 259 260 261 262 263 |
# File 'lib/sequel/model/base.rb', line 257 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.
# 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)
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/sequel/model/base.rb', line 281 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 meth = args.first @dataset_methods[meth] = block dataset.(meth, &block) if @dataset end args.each do |arg| if arg.to_s =~ NORMAL_METHOD_NAME_REGEXP instance_eval("def #{arg}(*args, &block); dataset.#{arg}(*args, &block) end", __FILE__, __LINE__) unless respond_to?(arg, true) else def_model_dataset_method_block(arg) end 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
306 307 308 |
# File 'lib/sequel/model/base.rb', line 306 def find(*args, &block) filter(*args, &block).first 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')
322 323 324 |
# File 'lib/sequel/model/base.rb', line 322 def find_or_create(cond, &block) find(cond) || create(cond, &block) end |
#implicit_table_name ⇒ Object
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
372 373 374 |
# File 'lib/sequel/model/base.rb', line 372 def implicit_table_name pluralize(underscore(demodulize(name))).to_sym end |
#include(mod) ⇒ Object
Clear the setter_methods cache when a module is included, as it may contain setter methods.
328 329 330 331 |
# File 'lib/sequel/model/base.rb', line 328 def include(mod) 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
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
# File 'lib/sequel/model/base.rb', line 342 def inherited(subclass) super ivs = subclass.instance_variables.collect{|x| x.to_s} EMPTY_INSTANCE_VARIABLES.each{|iv| subclass.instance_variable_set(iv, nil) unless ivs.include?(iv.to_s)} INHERITED_INSTANCE_VARIABLES.each do |iv, dup| next if ivs.include?(iv.to_s) sup_class_value = instance_variable_get(iv) sup_class_value = sup_class_value.dup if dup == :dup && sup_class_value subclass.instance_variable_set(iv, sup_class_value) end unless ivs.include?("@dataset") db begin if self == Model || !@dataset n = subclass.name subclass.set_dataset(subclass.implicit_table_name) unless n.nil? || n.empty? elsif @dataset subclass.set_dataset(@dataset.clone, :inherited=>true) end rescue nil end end end |
#load(values) ⇒ Object
Calls #call with the values hash. Only for backwards compatibility.
377 378 379 |
# File 'lib/sequel/model/base.rb', line 377 def load(values) call(values) end |
#method_added(meth) ⇒ Object
Clear the setter_methods cache when a setter method is added
382 383 384 385 |
# File 'lib/sequel/model/base.rb', line 382 def method_added(meth) clear_setter_methods_cache if meth.to_s =~ SETTER_METHOD_REGEXP super end |
#no_primary_key ⇒ Object
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
393 394 395 396 |
# File 'lib/sequel/model/base.rb', line 393 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.
403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/sequel/model/base.rb', line 403 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) ⇒ 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}
423 424 425 426 427 428 429 430 431 432 433 |
# File 'lib/sequel/model/base.rb', line 423 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) ⇒ 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.filter(Artist.qualified_primary_key_hash(1))
# SELECT * FROM artists WHERE (artists.id = 1)
442 443 444 445 446 |
# File 'lib/sequel/model/base.rb', line 442 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 ⇒ Object
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
.
451 452 453 454 |
# File 'lib/sequel/model/base.rb', line 451 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.
458 459 460 |
# File 'lib/sequel/model/base.rb', line 458 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
473 474 475 476 |
# File 'lib/sequel/model/base.rb', line 473 def set_allowed_columns(*cols) clear_setter_methods_cache @allowed_columns = cols end |
#set_dataset(ds, 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, extends the dataset with the dataset_method_modules, and defines methods on the dataset using the dataset_methods. 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])
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 |
# File 'lib/sequel/model/base.rb', line 495 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 @dataset_methods.each{|meth, block| @dataset.(meth, &block)} if @dataset_methods end @dataset.model = self if @dataset.respond_to?(:model=) check_non_connection_error{@db_schema = (inherited ? superclass.db_schema : get_db_schema)} @instance_dataset = @dataset.limit(1).naked 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
541 542 543 544 545 546 547 548 549 550 |
# File 'lib/sequel/model/base.rb', line 541 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) ⇒ Object
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_column(:records_sold)
Artist.set(:name=>'Bob', :hometown=>'Sactown') # No Error
Artist.set(:name=>'Bob', :records_sold=>30000) # Error
565 566 567 568 |
# File 'lib/sequel/model/base.rb', line 565 def set_restricted_columns(*cols) clear_setter_methods_cache @restricted_columns = cols end |
#setter_methods ⇒ Object
Cache of setter methods to allow by default, in order to speed up new/set/update instance methods.
571 572 573 574 575 576 577 578 579 580 |
# File 'lib/sequel/model/base.rb', line 571 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) ⇒ Object
Shortcut for def_dataset_method
that is restricted to modifying the dataset’s filter. 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 have to use def_dataset_method.
603 604 605 |
# File 'lib/sequel/model/base.rb', line 603 def subset(name, *args, &block) def_dataset_method(name){filter(*args, &block)} end |
#table_name ⇒ Object
613 614 615 |
# File 'lib/sequel/model/base.rb', line 613 def table_name dataset.first_source_alias end |
#unrestrict_primary_key ⇒ Object
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
623 624 625 626 |
# File 'lib/sequel/model/base.rb', line 623 def unrestrict_primary_key clear_setter_methods_cache @restrict_primary_key = false end |