Module: Sequel::Model::ClassMethods

External Aliases

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

Attributes

allowed_columns	[R]	Which columns should be the only columns allowed in a call to a mass assignment method (e.g. set) (default: not set, so all columns not otherwise restricted are allowed).
dataset_method_modules	[R]	Array of modules that extend this model‘s dataset. Stored so that if the model‘s dataset is changed, it will be extended with all of these modules.
default_set_fields_options	[RW]	The default options to use for Model#set_fields. These are merged with the options given to set_fields.
fast_instance_delete_sql	[R]	SQL string fragment used for faster DELETE statement creation when deleting/destroying model instances, or nil if the optimization should not be used. For internal use only.
instance_dataset	[R]	The dataset that instance datasets (this) are based on. Generally a naked version of the model‘s dataset limited to one row. For internal use only.
plugins	[R]	Array of plugin modules loaded by this class Sequel::Model.plugins # => [Sequel::Model, Sequel::Model::Associations]
primary_key	[R]	The primary key for the class. Sequel can determine this automatically for many databases, but not all, so you may need to set it manually. If not determined automatically, the default is :id.
raise_on_save_failure	[RW]	Whether to raise an error instead of returning nil on a failure to save/create/save_changes/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).
simple_pk	[R]	Should be the literal primary key column name if this Model‘s table has a simple primary key, or nil if the model has a compound primary key or no primary key.
simple_table	[R]	Should be the literal table name if this Model‘s dataset is a simple table (no select, order, join, etc.), or nil otherwise. This and simple_pk are used for an optimization in Model.[].
strict_param_setting	[RW]	Whether new/set/update and their variants should raise an error if an invalid key is used. A key is invalid if no setter method exists for that key or the access to the setter method is restricted (e.g. due to it being a primary key field). If set to false, silently skip any key where the setter method doesn‘t exist or access to it is restricted.
typecast_empty_string_to_nil	[RW]	Whether to typecast the empty string (’’) to nil for columns that are not string or blob. In most cases the empty string would be the way to specify a NULL SQL value in string form (nil.to_s == ’’), and an empty string would not usually be typecast correctly for other types, so the default is true.
typecast_on_assignment	[RW]	Whether to typecast attribute values on assignment (default: true). If set to false, no typecasting is done, so it will be left up to the database to typecast the value correctly.
use_after_commit_rollback	[RW]	Whether to enable the after_commit and after_rollback hooks when saving/destroying instances. On by default, can be turned off for performance reasons or when using prepared transactions (which aren‘t compatible with after commit/rollback).
use_transactions	[RW]	Whether to use a transaction by default when saving/deleting records (default: true). If you are sending database queries in before_* or after_* hooks, you shouldn‘t change the default setting without a good reason.

Public Instance methods

[](*args)

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