### Home Classes Methods

### In Files

- lib/sequel/model/base.rb

### Methods

- #[]
- #call
- #check_non_connection_error
- #clear_setter_methods_cache
- #columns
- #create
- #dataset
- #dataset=
- #dataset_extend
- #dataset_module
- #db
- #db=
- #db_schema
- #def_bad_column_accessor
- #def_column_accessor
- #def_column_alias
- #def_dataset_method
- #find
- #find_or_create
- #get_db_schema
- #implicit_table_name
- #include
- #inherited
- #late_binding_class_option
- #load
- #method_added
- #no_primary_key
- #overridable_methods_module
- #plugin
- #plugin_module
- #plugin_module_defined?
- #primary_key_hash
- #primary_key_lookup
- #qualified_primary_key_hash
- #restrict_primary_key
- #restrict_primary_key?
- #set_allowed_columns
- #set_columns
- #set_dataset
- #set_primary_key
- #set_restricted_columns
- #setter_methods
- #subset
- #table_name
- #unrestrict_primary_key

### Files

- CHANGELOG
- MIT-LICENSE
- README.rdoc
- active_record.rdoc
- advanced_associations.rdoc
- association_basics.rdoc
- cheat_sheet.rdoc
- dataset_basics.rdoc
- dataset_filtering.rdoc
- mass_assignment.rdoc
- migration.rdoc
- model_hooks.rdoc
- opening_databases.rdoc
- prepared_statements.rdoc
- querying.rdoc
- reflection.rdoc
- 1.0.txt
- 1.1.txt
- 1.3.txt
- 1.4.0.txt
- 1.5.0.txt
- 2.0.0.txt
- 2.1.0.txt
- 2.10.0.txt
- 2.11.0.txt
- 2.12.0.txt
- 2.2.0.txt
- 2.3.0.txt
- 2.4.0.txt
- 2.5.0.txt
- 2.6.0.txt
- 2.7.0.txt
- 2.8.0.txt
- 2.9.0.txt
- 3.0.0.txt
- 3.1.0.txt
- 3.10.0.txt
- 3.11.0.txt
- 3.12.0.txt
- 3.13.0.txt
- 3.14.0.txt
- 3.15.0.txt
- 3.16.0.txt
- 3.17.0.txt
- 3.18.0.txt
- 3.19.0.txt
- 3.2.0.txt
- 3.20.0.txt
- 3.21.0.txt
- 3.22.0.txt
- 3.23.0.txt
- 3.24.0.txt
- 3.25.0.txt
- 3.26.0.txt
- 3.27.0.txt
- 3.28.0.txt
- 3.29.0.txt
- 3.3.0.txt
- 3.30.0.txt
- 3.31.0.txt
- 3.32.0.txt
- 3.33.0.txt
- 3.4.0.txt
- 3.5.0.txt
- 3.6.0.txt
- 3.7.0.txt
- 3.8.0.txt
- 3.9.0.txt
- schema_modification.rdoc
- sharding.rdoc
- sql.rdoc
- testing.rdoc
- transactions.rdoc
- validations.rdoc
- virtual_rows.rdoc

### Class Index

Quicksearch

- Sequel
- Sequel::ADO
- Sequel::ADO::Database
- Sequel::ADO::Dataset
- Sequel::ADO::MSSQL
- Sequel::ADO::MSSQL::DatabaseMethods
- Sequel::ADO::MSSQL::Dataset
- Sequel::ASTTransformer
- Sequel::Access
- Sequel::Access::DatabaseMethods
- Sequel::Access::DatasetMethods
- Sequel::Adapter
- Sequel::AdapterNotFound
- Sequel::AdapterNotFound
- Sequel::Amalgalite
- Sequel::Amalgalite::Database
- Sequel::Amalgalite::Dataset
- Sequel::Amalgalite::SequelTypeMap
- Sequel::ArbitraryServers
- Sequel::BasicObject
- Sequel::ColumnsIntrospection
- Sequel::ConnectionPool
- Sequel::ConnectionPool::ClassMethods
- Sequel::DB2
- Sequel::DB2::DB2Error
- Sequel::DB2::Database
- Sequel::DB2::DatabaseMethods
- Sequel::DB2::Dataset
- Sequel::DB2::DatasetMethods
- Sequel::DBI
- Sequel::DBI::Database
- Sequel::DBI::Dataset
- Sequel::DataObjects
- Sequel::DataObjects::Database
- Sequel::DataObjects::Dataset
- Sequel::DataObjects::MySQL
- Sequel::DataObjects::MySQL::DatabaseMethods
- Sequel::DataObjects::MySQL::Dataset
- Sequel::DataObjects::Postgres
- Sequel::DataObjects::Postgres::AdapterMethods
- Sequel::DataObjects::Postgres::DatabaseMethods
- Sequel::DataObjects::Postgres::Dataset
- Sequel::DataObjects::SQLite
- Sequel::DataObjects::SQLite::DatabaseMethods
- Sequel::DataObjects::SQLite::Dataset
- Sequel::Database
- Sequel::DatabaseConnectionError
- Sequel::DatabaseDisconnectError
- Sequel::DatabaseError
- Sequel::Dataset
- Sequel::Dataset
- Sequel::Dataset::ArgumentMapper
- Sequel::Dataset::BindArgumentMethods
- Sequel::Dataset::Pagination
- Sequel::Dataset::PreparedStatementMethods
- Sequel::Dataset::QueryBlockCopy
- Sequel::Dataset::StoredProcedureMethods
- Sequel::Dataset::StoredProcedures
- Sequel::Dataset::TYPE_TRANSLATOR
- Sequel::Dataset::UnnumberedArgumentMapper
- Sequel::EmulateOffsetWithRowNumber
- Sequel::Error
- Sequel::Firebird
- Sequel::Firebird::Database
- Sequel::Firebird::DatabaseMethods
- Sequel::Firebird::Dataset
- Sequel::Firebird::DatasetMethods
- Sequel::HookFailed
- Sequel::HookFailed
- Sequel::IBMDB
- Sequel::IBMDB::Connection
- Sequel::IBMDB::Connection::Error
- Sequel::IBMDB::Database
- Sequel::IBMDB::Dataset
- Sequel::IBMDB::Dataset::CallableStatementMethods
- Sequel::IBMDB::Dataset::PreparedStatementMethods
- Sequel::IBMDB::Statement
- Sequel::Inflections
- Sequel::Informix
- Sequel::Informix::Database
- Sequel::Informix::DatabaseMethods
- Sequel::Informix::Dataset
- Sequel::Informix::DatasetMethods
- Sequel::IntegerMigrator
- Sequel::InvalidOperation
- Sequel::InvalidOperation
- Sequel::InvalidValue
- Sequel::InvalidValue
- Sequel::JDBC
- Sequel::JDBC::AS400
- Sequel::JDBC::AS400::DatabaseMethods
- Sequel::JDBC::AS400::Dataset
- Sequel::JDBC::DB2
- Sequel::JDBC::DB2::DatabaseMethods
- Sequel::JDBC::DB2::Dataset
- Sequel::JDBC::Database
- Sequel::JDBC::Derby
- Sequel::JDBC::Derby::DatabaseMethods
- Sequel::JDBC::Derby::Dataset
- Sequel::JDBC::Firebird
- Sequel::JDBC::Firebird::DatabaseMethods
- Sequel::JDBC::Firebird::Dataset
- Sequel::JDBC::H2
- Sequel::JDBC::H2::DatabaseMethods
- Sequel::JDBC::H2::Dataset
- Sequel::JDBC::HSQLDB
- Sequel::JDBC::HSQLDB::DatabaseMethods
- Sequel::JDBC::HSQLDB::Dataset
- Sequel::JDBC::Informix
- Sequel::JDBC::Informix::DatabaseMethods
- Sequel::JDBC::Informix::Dataset
- Sequel::JDBC::JTDS
- Sequel::JDBC::JTDS::DatabaseMethods
- Sequel::JDBC::JTDS::Dataset
- Sequel::JDBC::JavaLang
- Sequel::JDBC::JavaSQL
- Sequel::JDBC::JavaxNaming
- Sequel::JDBC::MSSQL
- Sequel::JDBC::MSSQL::DatabaseMethods
- Sequel::JDBC::MySQL
- Sequel::JDBC::MySQL::DatabaseMethods
- Sequel::JDBC::MySQL::Dataset
- Sequel::JDBC::Oracle
- Sequel::JDBC::Oracle::DatabaseMethods
- Sequel::JDBC::Oracle::Dataset
- Sequel::JDBC::Postgres
- Sequel::JDBC::Postgres::AdapterMethods
- Sequel::JDBC::Postgres::DatabaseMethods
- Sequel::JDBC::Postgres::Dataset
- Sequel::JDBC::SQLServer
- Sequel::JDBC::SQLServer::DatabaseMethods
- Sequel::JDBC::SQLServer::DatabaseMethods::MetadataDatasetMethods
- Sequel::JDBC::SQLServer::Dataset
- Sequel::JDBC::SQLite
- Sequel::JDBC::SQLite::DatabaseMethods
- Sequel::JDBC::SQLite::Dataset
- Sequel::JDBC::Transactions
- Sequel::LiteralString
- Sequel::LooserTypecasting
- Sequel::MSSQL
- Sequel::MSSQL::DatabaseMethods
- Sequel::MSSQL::DatasetMethods
- Sequel::Metaprogramming
- Sequel::Migration
- Sequel::MigrationAlterTableReverser
- Sequel::MigrationDSL
- Sequel::MigrationReverser
- Sequel::Migrator
- Sequel::Migrator::Error
- Sequel::Mock
- Sequel::Mock::Connection
- Sequel::Mock::Database
- Sequel::Mock::Dataset
- Sequel::Model
- Sequel::Model::Associations
- Sequel::Model::Associations::AssociationDatasetMethods
- Sequel::Model::Associations::AssociationReflection
- Sequel::Model::Associations::ClassMethods
- Sequel::Model::Associations::DatasetMethods
- Sequel::Model::Associations::EagerGraphLoader
- Sequel::Model::Associations::InstanceMethods
- Sequel::Model::Associations::ManyToManyAssociationReflection
- Sequel::Model::Associations::ManyToOneAssociationReflection
- Sequel::Model::Associations::OneToManyAssociationReflection
- Sequel::Model::Associations::OneToOneAssociationReflection
- Sequel::Model::ClassMethods
- Sequel::Model::DatasetMethods
- Sequel::Model::Errors
- Sequel::Model::InstanceMethods
- Sequel::MySQL
- Sequel::MySQL::DatabaseMethods
- Sequel::MySQL::DatasetMethods
- Sequel::MySQL::DatasetMethods::CallableStatementMethods
- Sequel::MySQL::DatasetMethods::PreparedStatementMethods
- Sequel::MySQL::DatasetMethods::StoredProcedureMethods
- Sequel::MySQL::PreparedStatements
- Sequel::MySQL::PreparedStatements::DatabaseMethods
- Sequel::Mysql2
- Sequel::Mysql2::Database
- Sequel::Mysql2::Dataset
- Sequel::NamedTimezones
- Sequel::NoExistingObject
- Sequel::NoExistingObject
- Sequel::NotImplemented
- Sequel::ODBC
- Sequel::ODBC::DB2
- Sequel::ODBC::DB2::DatabaseMethods
- Sequel::ODBC::DB2::Dataset
- Sequel::ODBC::Database
- Sequel::ODBC::Dataset
- Sequel::ODBC::MSSQL
- Sequel::ODBC::MSSQL::DatabaseMethods
- Sequel::ODBC::MSSQL::Dataset
- Sequel::OpenBase
- Sequel::OpenBase::Database
- Sequel::OpenBase::Dataset
- Sequel::Oracle
- Sequel::Oracle::Database
- Sequel::Oracle::DatabaseMethods
- Sequel::Oracle::DatasetMethods
- Sequel::Plugins
- Sequel::Plugins::ActiveModel
- Sequel::Plugins::ActiveModel::ClassMethods
- Sequel::Plugins::ActiveModel::InstanceMethods
- Sequel::Plugins::AssociationAutoreloading
- Sequel::Plugins::AssociationAutoreloading::ClassMethods
- Sequel::Plugins::AssociationDependencies
- Sequel::Plugins::AssociationDependencies::ClassMethods
- Sequel::Plugins::AssociationDependencies::InstanceMethods
- Sequel::Plugins::AssociationPks
- Sequel::Plugins::AssociationPks::ClassMethods
- Sequel::Plugins::AssociationPks::InstanceMethods
- Sequel::Plugins::AssociationProxies
- Sequel::Plugins::AssociationProxies::AssociationProxy
- Sequel::Plugins::AssociationProxies::ClassMethods
- Sequel::Plugins::BooleanReaders
- Sequel::Plugins::BooleanReaders::ClassMethods
- Sequel::Plugins::Caching
- Sequel::Plugins::Caching::ClassMethods
- Sequel::Plugins::Caching::InstanceMethods
- Sequel::Plugins::ClassTableInheritance
- Sequel::Plugins::ClassTableInheritance::ClassMethods
- Sequel::Plugins::ClassTableInheritance::InstanceMethods
- Sequel::Plugins::Composition
- Sequel::Plugins::Composition::ClassMethods
- Sequel::Plugins::Composition::InstanceMethods
- Sequel::Plugins::DatasetAssociations
- Sequel::Plugins::DatasetAssociations::ClassMethods
- Sequel::Plugins::DatasetAssociations::DatasetMethods
- Sequel::Plugins::DefaultsSetter
- Sequel::Plugins::DefaultsSetter::ClassMethods
- Sequel::Plugins::DefaultsSetter::InstanceMethods
- Sequel::Plugins::ForceEncoding
- Sequel::Plugins::ForceEncoding::ClassMethods
- Sequel::Plugins::ForceEncoding::InstanceMethods
- Sequel::Plugins::HookClassMethods
- Sequel::Plugins::HookClassMethods::ClassMethods
- Sequel::Plugins::HookClassMethods::InstanceMethods
- Sequel::Plugins::IdentityMap
- Sequel::Plugins::IdentityMap::ClassMethods
- Sequel::Plugins::IdentityMap::InstanceMethods
- Sequel::Plugins::InstanceFilters
- Sequel::Plugins::InstanceFilters::InstanceMethods
- Sequel::Plugins::InstanceHooks
- Sequel::Plugins::InstanceHooks::InstanceMethods
- Sequel::Plugins::JsonSerializer
- Sequel::Plugins::JsonSerializer::ClassMethods
- Sequel::Plugins::JsonSerializer::DatasetMethods
- Sequel::Plugins::JsonSerializer::InstanceMethods
- Sequel::Plugins::JsonSerializer::Literal
- Sequel::Plugins::LazyAttributes
- Sequel::Plugins::LazyAttributes::ClassMethods
- Sequel::Plugins::LazyAttributes::InstanceMethods
- Sequel::Plugins::List
- Sequel::Plugins::List::ClassMethods
- Sequel::Plugins::List::InstanceMethods
- Sequel::Plugins::ManyThroughMany
- Sequel::Plugins::ManyThroughMany::ClassMethods
- Sequel::Plugins::ManyThroughMany::DatasetMethods
- Sequel::Plugins::ManyThroughMany::ManyThroughManyAssociationReflection
- Sequel::Plugins::NestedAttributes
- Sequel::Plugins::NestedAttributes::ClassMethods
- Sequel::Plugins::NestedAttributes::InstanceMethods
- Sequel::Plugins::OptimisticLocking
- Sequel::Plugins::OptimisticLocking::ClassMethods
- Sequel::Plugins::OptimisticLocking::InstanceMethods
- Sequel::Plugins::PreparedStatements
- Sequel::Plugins::PreparedStatements::ClassMethods
- Sequel::Plugins::PreparedStatements::InstanceMethods
- Sequel::Plugins::PreparedStatementsAssociations
- Sequel::Plugins::PreparedStatementsAssociations::ClassMethods
- Sequel::Plugins::PreparedStatementsAssociations::InstanceMethods
- Sequel::Plugins::PreparedStatementsSafe
- Sequel::Plugins::PreparedStatementsSafe::ClassMethods
- Sequel::Plugins::PreparedStatementsSafe::InstanceMethods
- Sequel::Plugins::PreparedStatementsWithPk
- Sequel::Plugins::PreparedStatementsWithPk::ClassMethods
- Sequel::Plugins::PreparedStatementsWithPk::DatasetMethods
- Sequel::Plugins::RcteTree
- Sequel::Plugins::Schema
- Sequel::Plugins::Schema::ClassMethods
- Sequel::Plugins::Serialization
- Sequel::Plugins::Serialization::ClassMethods
- Sequel::Plugins::Serialization::InstanceMethods
- Sequel::Plugins::SerializationModificationDetection
- Sequel::Plugins::SerializationModificationDetection::InstanceMethods
- Sequel::Plugins::Sharding
- Sequel::Plugins::Sharding::ClassMethods
- Sequel::Plugins::Sharding::DatasetMethods
- Sequel::Plugins::Sharding::InstanceMethods
- Sequel::Plugins::SingleTableInheritance
- Sequel::Plugins::SingleTableInheritance::ClassMethods
- Sequel::Plugins::SingleTableInheritance::InstanceMethods
- Sequel::Plugins::SkipCreateRefresh
- Sequel::Plugins::SkipCreateRefresh::InstanceMethods
- Sequel::Plugins::StringStripper
- Sequel::Plugins::StringStripper::InstanceMethods
- Sequel::Plugins::Subclasses
- Sequel::Plugins::Subclasses::ClassMethods
- Sequel::Plugins::TacticalEagerLoading
- Sequel::Plugins::TacticalEagerLoading::DatasetMethods
- Sequel::Plugins::TacticalEagerLoading::InstanceMethods
- Sequel::Plugins::Timestamps
- Sequel::Plugins::Timestamps::ClassMethods
- Sequel::Plugins::Timestamps::InstanceMethods
- Sequel::Plugins::Touch
- Sequel::Plugins::Touch::ClassMethods
- Sequel::Plugins::Touch::InstanceMethods
- Sequel::Plugins::Tree
- Sequel::Plugins::Tree::ClassMethods
- Sequel::Plugins::Tree::InstanceMethods
- Sequel::Plugins::Tree::SingleRoot
- Sequel::Plugins::Tree::SingleRoot::ClassMethods
- Sequel::Plugins::Tree::SingleRoot::InstanceMethods
- Sequel::Plugins::Tree::TreeMultipleRootError
- Sequel::Plugins::TypecastOnLoad
- Sequel::Plugins::TypecastOnLoad::ClassMethods
- Sequel::Plugins::TypecastOnLoad::InstanceMethods
- Sequel::Plugins::UpdatePrimaryKey
- Sequel::Plugins::UpdatePrimaryKey::ClassMethods
- Sequel::Plugins::UpdatePrimaryKey::InstanceMethods
- Sequel::Plugins::ValidationClassMethods
- Sequel::Plugins::ValidationClassMethods::ClassMethods
- Sequel::Plugins::ValidationClassMethods::ClassMethods::Generator
- Sequel::Plugins::ValidationClassMethods::InstanceMethods
- Sequel::Plugins::ValidationHelpers
- Sequel::Plugins::ValidationHelpers::InstanceMethods
- Sequel::Plugins::XmlSerializer
- Sequel::Plugins::XmlSerializer::ClassMethods
- Sequel::Plugins::XmlSerializer::DatasetMethods
- Sequel::Plugins::XmlSerializer::InstanceMethods
- Sequel::PoolTimeout
- Sequel::PoolTimeout
- Sequel::Postgres
- Sequel::Postgres::AdapterMethods
- Sequel::Postgres::DatabaseMethods
- Sequel::Postgres::DatasetMethods
- Sequel::Postgres::DatasetMethods::PreparedStatementMethods
- Sequel::PrettyTable
- Sequel::Progress
- Sequel::Progress::DatabaseMethods
- Sequel::Progress::DatasetMethods
- Sequel::Qualifier
- Sequel::Rollback
- Sequel::Rollback
- Sequel::SQL
- Sequel::SQL::AliasMethods
- Sequel::SQL::AliasedExpression
- Sequel::SQL::BitwiseMethods
- Sequel::SQL::Blob
- Sequel::SQL::BooleanConstant
- Sequel::SQL::BooleanExpression
- Sequel::SQL::BooleanMethods
- Sequel::SQL::CaseExpression
- Sequel::SQL::Cast
- Sequel::SQL::CastMethods
- Sequel::SQL::ColumnAll
- Sequel::SQL::ComplexExpression
- Sequel::SQL::ComplexExpressionMethods
- Sequel::SQL::Constant
- Sequel::SQL::Constants
- Sequel::SQL::Expression
- Sequel::SQL::Function
- Sequel::SQL::GenericComplexExpression
- Sequel::SQL::GenericExpression
- Sequel::SQL::Identifier
- Sequel::SQL::IdentifierMethods
- Sequel::SQL::InequalityMethods
- Sequel::SQL::JoinClause
- Sequel::SQL::JoinOnClause
- Sequel::SQL::JoinUsingClause
- Sequel::SQL::NegativeBooleanConstant
- Sequel::SQL::NoBooleanInputMethods
- Sequel::SQL::NumericExpression
- Sequel::SQL::NumericMethods
- Sequel::SQL::OrderMethods
- Sequel::SQL::OrderedExpression
- Sequel::SQL::PlaceholderLiteralString
- Sequel::SQL::QualifiedIdentifier
- Sequel::SQL::QualifyingMethods
- Sequel::SQL::StringConcatenationMethods
- Sequel::SQL::StringExpression
- Sequel::SQL::StringMethods
- Sequel::SQL::Subscript
- Sequel::SQL::SubscriptMethods
- Sequel::SQL::ValueList
- Sequel::SQL::ValueList
- Sequel::SQL::VirtualRow
- Sequel::SQL::Window
- Sequel::SQL::WindowFunction
- Sequel::SQLTime
- Sequel::SQLite
- Sequel::SQLite::DatabaseMethods
- Sequel::SQLite::DatasetMethods
- Sequel::Schema
- Sequel::Schema::AlterTableGenerator
- Sequel::Schema::Generator
- Sequel::ServerBlock
- Sequel::ShardedSingleConnectionPool
- Sequel::ShardedThreadedConnectionPool
- Sequel::SimpleMigration
- Sequel::SingleConnectionPool
- Sequel::Swift
- Sequel::Swift::Database
- Sequel::Swift::Dataset
- Sequel::Swift::MySQL
- Sequel::Swift::MySQL::DatabaseMethods
- Sequel::Swift::MySQL::Dataset
- Sequel::Swift::Postgres
- Sequel::Swift::Postgres::AdapterMethods
- Sequel::Swift::Postgres::DatabaseMethods
- Sequel::Swift::Postgres::Dataset
- Sequel::Swift::SQLite
- Sequel::Swift::SQLite::DatabaseMethods
- Sequel::Swift::SQLite::Dataset
- Sequel::ThreadLocalTimezones
- Sequel::ThreadedConnectionPool
- Sequel::ThreadedServerBlock
- Sequel::TimestampMigrator
- Sequel::Timezones
- Sequel::TinyTDS
- Sequel::TinyTDS::Database
- Sequel::TinyTDS::Dataset
- Sequel::TinyTDS::Dataset::ArgumentMapper
- Sequel::TinyTDS::Dataset::PreparedStatementMethods
- Sequel::ToDot
- Sequel::UnbindDuplicate
- Sequel::Unbinder
- Sequel::UndefinedAssociation
- Sequel::UnthreadedServerBlock
- Sequel::ValidationFailed
- Dataset
- Dataset::ArgumentMapper
- Dataset::BindArgumentMethods
- Dataset::PreparedStatementMethods
- String
- String::Inflections
- Array
- FalseClass
- Hash
- NilClass
- Numeric
- Object
- PGconn
- PGresult
- Proc
- Symbol
- TrueClass

No matching classes.

# Sequel::Model::ClassMethods

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.

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

dataset_methods[R]

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.

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

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.

### Public Instance Methods

[](*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] # SELECT * FROM artists WHERE id = 1
      # => #<Artist {:id=>1, ...}>

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

         # File lib/sequel/model/base.rb, line 109
    109:       def [](*args)
    110:         args = args.first if (args.size == 1)
    111:         args.is_a?(Hash) ? dataset[args] : primary_key_lookup(args)
    112:       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.

         # File lib/sequel/model/base.rb, line 118
    118:       def call(values)
    119:         o = allocate
    120:         o.set_values(values)
    121:         o.after_initialize
    122:         o
    123:       end

clear_setter_methods_cache() click to toggle source

Clear the setter_methods cache

         # File lib/sequel/model/base.rb, line 126
    126:       def clear_setter_methods_cache
    127:         @setter_methods = nil
    128:       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
      # => [:id, :name]

         # File lib/sequel/model/base.rb, line 137
    137:       def columns
    138:         @columns || set_columns(dataset.naked.columns)
    139:       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')
      # INSERT INTO artists (name) VALUES ('Bob')

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

         # File lib/sequel/model/base.rb, line 149
    149:       def create(values = {}, &block)
    150:         new(values, &block).save
    151:       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

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

dataset=(ds) click to toggle source

Alias of set_dataset

         # File lib/sequel/model/base.rb, line 164
    164:       def dataset=(ds)
    165:         set_dataset(ds)
    166:       end

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

         # File lib/sequel/model/base.rb, line 185
    185:       def dataset_module(mod = nil)
    186:         if mod
    187:           raise Error, "can't provide both argument and block to Model.dataset_module" if block_given?
    188:           dataset_extend(mod)
    189:           mod
    190:         else
    191:           @dataset_module ||= Module.new
    192:           @dataset_module.module_eval(&Proc.new) if block_given?
    193:           dataset_extend(@dataset_module)
    194:           @dataset_module
    195:         end
    196:       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 # BEGIN
        Artist.create(:name=>'Bob')
        # INSERT INTO artists (name) VALUES ('Bob')
      end # COMMIT

         # File lib/sequel/model/base.rb, line 208
    208:       def db
    209:         return @db if @db
    210:         @db = self == Model ? DATABASES.first : superclass.db
    211:         raise(Error, "No database associated with #{self}: have you called Sequel.connect or #{self}.db= ?") unless @db
    212:         @db
    213:       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

         # File lib/sequel/model/base.rb, line 225
    225:       def db=(db)
    226:         @db = db
    227:         set_dataset(db.dataset(@dataset.opts)) if @dataset
    228:       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
      # {:id=>{:type=>:integer, :primary_key=>true, ...},
      #  :name=>{:type=>:string, :primary_key=>false, ...}}

         # File lib/sequel/model/base.rb, line 238
    238:       def db_schema
    239:         @db_schema ||= get_db_schema
    240:       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.

         # File lib/sequel/model/base.rb, line 244
    244:       def def_column_alias(meth, column)
    245:         clear_setter_methods_cache
    246:         overridable_methods_module.module_eval do
    247:           define_method(meth){self[column]}
    248:           define_method("#{meth}="){|v| self[column] = v}
    249:         end
    250:       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.

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

         # File lib/sequel/model/base.rb, line 268
    268:       def def_dataset_method(*args, &block)
    269:         raise(Error, "No arguments given") if args.empty?
    270:         if block
    271:           raise(Error, "Defining a dataset method using a block requires only one argument") if args.length > 1
    272:           meth = args.first
    273:           @dataset_methods[meth] = block
    274:           dataset.meta_def(meth, &block) if @dataset
    275:         end
    276:         args.each do |arg|
    277:           if arg.to_s =~ NORMAL_METHOD_NAME_REGEXP
    278:             instance_eval("def #{arg}(*args, &block); dataset.#{arg}(*args, &block) end", __FILE__, __LINE__) unless respond_to?(arg, true)
    279:           else
    280:             def_model_dataset_method_block(arg)
    281:           end
    282:         end
    283:       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')
      # SELECT * FROM artists WHERE (name = 'Bob') LIMIT 1

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

         # File lib/sequel/model/base.rb, line 308
    308:       def find(*args, &block)
    309:         filter(*args, &block).first
    310:       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')
      # 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')

         # File lib/sequel/model/base.rb, line 324
    324:       def find_or_create(cond, &block)
    325:         find(cond) || create(cond, &block)
    326:       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 # => :artists
      Foo::ArtistAlias.implicit_table_name # => :artist_aliases

         # File lib/sequel/model/base.rb, line 374
    374:       def implicit_table_name
    375:         pluralize(underscore(demodulize(name))).to_sym
    376:       end

include(mod) click to toggle source

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

         # File lib/sequel/model/base.rb, line 330
    330:       def include(mod)
    331:         clear_setter_methods_cache
    332:         super
    333:       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 # Causes schema query
      end

         # File lib/sequel/model/base.rb, line 344
    344:       def inherited(subclass)
    345:         super
    346:         ivs = subclass.instance_variables.collect{|x| x.to_s}
    347:         EMPTY_INSTANCE_VARIABLES.each{|iv| subclass.instance_variable_set(iv, nil) unless ivs.include?(iv.to_s)}
    348:         INHERITED_INSTANCE_VARIABLES.each do |iv, dup|
    349:           next if ivs.include?(iv.to_s)
    350:           sup_class_value = instance_variable_get(iv)
    351:           sup_class_value = sup_class_value.dup if dup == :dup && sup_class_value
    352:           subclass.instance_variable_set(iv, sup_class_value)
    353:         end
    354:         unless ivs.include?("@dataset")
    355:           db
    356:           begin
    357:             if self == Model || !@dataset
    358:               n = subclass.name
    359:               subclass.set_dataset(subclass.implicit_table_name) unless n.nil? || n.empty?
    360:             elsif @dataset
    361:               subclass.set_dataset(@dataset.clone, :inherited=>true)
    362:             end
    363:           rescue
    364:             nil
    365:           end
    366:         end
    367:       end

load(values) click to toggle source

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

         # File lib/sequel/model/base.rb, line 379
    379:       def load(values)
    380:         call(values)
    381:       end

method_added(meth) click to toggle source

Clear the setter_methods cache when a setter method is added

         # File lib/sequel/model/base.rb, line 384
    384:       def method_added(meth)
    385:         clear_setter_methods_cache if meth.to_s =~ SETTER_METHOD_REGEXP
    386:         super
    387:       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 # => :id
      Artist.no_primary_key
      Artist.primary_key # => nil

         # File lib/sequel/model/base.rb, line 395
    395:       def no_primary_key
    396:         clear_setter_methods_cache
    397:         @simple_pk = @primary_key = nil
    398:       end

plugin(plugin, *args, &blk) 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.

         # File lib/sequel/model/base.rb, line 405
    405:       def plugin(plugin, *args, &blk)
    406:         m = plugin.is_a?(Module) ? plugin : plugin_module(plugin)
    407:         unless @plugins.include?(m)
    408:           @plugins << m
    409:           m.apply(self, *args, &blk) if m.respond_to?(:apply)
    410:           include(m::InstanceMethods) if plugin_module_defined?(m, :InstanceMethods)
    411:           extend(m::ClassMethods)if plugin_module_defined?(m, :ClassMethods)
    412:           dataset_extend(m::DatasetMethods) if plugin_module_defined?(m, :DatasetMethods)
    413:         end
    414:         m.configure(self, *args, &blk) if m.respond_to?(:configure)
    415:       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) # => {:id=>1}
      Artist.primary_key_hash([1, 2]) # => {:id1=>1, :id2=>2}

         # File lib/sequel/model/base.rb, line 425
    425:       def primary_key_hash(value)
    426:         raise(Error, "#{self} does not have a primary key") unless key = @primary_key
    427:         case key
    428:         when Array
    429:           hash = {}
    430:           key.each_with_index{|k,i| hash[k] = value[i]}
    431:           hash
    432:         else
    433:           {key => value}
    434:         end
    435:       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)

         # File lib/sequel/model/base.rb, line 444
    444:       def qualified_primary_key_hash(value, qualifier=table_name)
    445:         h = primary_key_hash(value)
    446:         h.to_a.each{|k,v| h[SQL::QualifiedIdentifier.new(qualifier, k)] = h.delete(k)}
    447:         h
    448:       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`.

         # File lib/sequel/model/base.rb, line 453
    453:       def restrict_primary_key
    454:         clear_setter_methods_cache
    455:         @restrict_primary_key = true
    456:       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.

         # File lib/sequel/model/base.rb, line 460
    460:       def restrict_primary_key?
    461:         @restrict_primary_key
    462:       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') # No Error
      Artist.set(:name=>'Bob', :records_sold=>30000) # Error

         # File lib/sequel/model/base.rb, line 475
    475:       def set_allowed_columns(*cols)
    476:         clear_setter_methods_cache
    477:         @allowed_columns = cols
    478:       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, 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])

         # File lib/sequel/model/base.rb, line 497
    497:       def set_dataset(ds, opts={})
    498:         inherited = opts[:inherited]
    499:         @dataset = case ds
    500:         when Symbol, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression, LiteralString
    501:           @simple_table = db.literal(ds)
    502:           db.from(ds)
    503:         when Dataset
    504:           @simple_table = if ds.send(:simple_select_all?)
    505:             ds.literal(ds.first_source_table)
    506:           else
    507:             nil
    508:           end
    509:           @db = ds.db
    510:           ds
    511:         else
    512:           raise(Error, "Model.set_dataset takes one of the following classes as an argument: Symbol, LiteralString, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression, Dataset")
    513:         end
    514:         @dataset.row_proc = self
    515:         @require_modification = Sequel::Model.require_modification.nil? ? @dataset.provides_accurate_rows_matched? : Sequel::Model.require_modification
    516:         if inherited
    517:           @simple_table = superclass.simple_table
    518:           @columns = @dataset.columns rescue nil
    519:         else
    520:           @dataset_method_modules.each{|m| @dataset.extend(m)} if @dataset_method_modules
    521:           @dataset_methods.each{|meth, block| @dataset.meta_def(meth, &block)} if @dataset_methods
    522:         end
    523:         @dataset.model = self if @dataset.respond_to?(:model=)
    524:         check_non_connection_error{@db_schema = (inherited ? superclass.db_schema : get_db_schema)}
    525:         self
    526:       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
        # regular key
        set_primary_key :person_id
      end

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

         # File lib/sequel/model/base.rb, line 542
    542:       def set_primary_key(*key)
    543:         clear_setter_methods_cache
    544:         key = key.flatten
    545:         @simple_pk = if key.length == 1
    546:           (@dataset || db).literal(key.first)
    547:         else
    548:           nil
    549:         end
    550:         @primary_key = (key.length == 1) ? key[0] : key
    551:       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_column(:records_sold)
      Artist.set(:name=>'Bob', :hometown=>'Sactown') # No Error
      Artist.set(:name=>'Bob', :records_sold=>30000) # Error

         # File lib/sequel/model/base.rb, line 566
    566:       def set_restricted_columns(*cols)
    567:         clear_setter_methods_cache
    568:         @restricted_columns = cols
    569:       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.

         # File lib/sequel/model/base.rb, line 572
    572:       def setter_methods
    573:         @setter_methods ||= if allowed_columns
    574:           allowed_columns.map{|x| "#{x}="}
    575:         else
    576:           meths = instance_methods.collect{|x| x.to_s}.grep(SETTER_METHOD_REGEXP) - RESTRICTED_SETTER_METHODS
    577:           meths -= Array(primary_key).map{|x| "#{x}="} if primary_key && restrict_primary_key?
    578:           meths -= restricted_columns.map{|x| "#{x}="} if restricted_columns
    579:           meths
    580:         end
    581:       end

subset(name, *args, &block) click to toggle source

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.

         # File lib/sequel/model/base.rb, line 604
    604:       def subset(name, *args, &block)
    605:         def_dataset_method(name){filter(*args, &block)}
    606:       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 # => :artists
      Sequel::Model(:foo).table_name # => :foo
      Sequel::Model(:foo___bar).table_name # => :bar

         # File lib/sequel/model/base.rb, line 614
    614:       def table_name
    615:         dataset.first_source_alias
    616:       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) # Error
      Artist.unrestrict_primary_key
      Artist.set(:id=>1) # No Error

         # File lib/sequel/model/base.rb, line 624
    624:       def unrestrict_primary_key
    625:         clear_setter_methods_cache
    626:         @restrict_primary_key = false
    627:       end

### Private Instance Methods

check_non_connection_error() click to toggle source

Yield to the passed block and swallow all errors other than DatabaseConnectionErrors.

         # File lib/sequel/model/base.rb, line 632
    632:       def check_non_connection_error
    633:         begin
    634:           yield
    635:         rescue Sequel::DatabaseConnectionError
    636:           raise
    637:         rescue
    638:           nil
    639:         end
    640:       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.

         # File lib/sequel/model/base.rb, line 645
    645:       def dataset_extend(mod)
    646:         dataset.extend(mod) if @dataset
    647:         dataset_method_modules << mod
    648:         meths = mod.public_instance_methods.reject{|x| NORMAL_METHOD_NAME_REGEXP !~ x.to_s}
    649:         def_dataset_method(*meths) unless meths.empty?
    650:       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.

         # File lib/sequel/model/base.rb, line 653
    653:       def def_bad_column_accessor(column)
    654:         overridable_methods_module.module_eval do
    655:           define_method(column){self[column]}
    656:           define_method("#{column}="){|v| self[column] = v}
    657:         end
    658:       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.

         # File lib/sequel/model/base.rb, line 662
    662:       def def_column_accessor(*columns)
    663:         clear_setter_methods_cache
    664:         columns, bad_columns = columns.partition{|x| NORMAL_METHOD_NAME_REGEXP.match(x.to_s)}
    665:         bad_columns.each{|x| def_bad_column_accessor(x)}
    666:         im = instance_methods.collect{|x| x.to_s}
    667:         columns.each do |column|
    668:           meth = "#{column}="
    669:           overridable_methods_module.module_eval("def #{column}; self[:#{column}] end", __FILE__, __LINE__) unless im.include?(column.to_s)
    670:           overridable_methods_module.module_eval("def #{meth}(v); self[:#{column}] = v end", __FILE__, __LINE__) unless im.include?(meth)
    671:         end
    672:       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.

         # File lib/sequel/model/base.rb, line 677
    677:       def get_db_schema(reload = false)
    678:         set_columns(nil)
    679:         return nil unless @dataset
    680:         schema_hash = {}
    681:         ds_opts = dataset.opts
    682:         get_columns = proc{check_non_connection_error{columns} || []}
    683:         schema_array = check_non_connection_error{db.schema(dataset, :reload=>reload)}
    684:         if schema_array
    685:           schema_array.each{|k,v| schema_hash[k] = v}
    686:           if ds_opts.include?(:select)
    687:             # We don't remove the columns from the schema_hash,
    688:             # as it's possible they will be used for typecasting
    689:             # even if they are not selected.
    690:             cols = get_columns.call
    691:             cols.each{|c| schema_hash[c] ||= {}}
    692:             def_column_accessor(*schema_hash.keys)
    693:           else
    694:             # Dataset is for a single table with all columns,
    695:             # so set the columns based on the order they were
    696:             # returned by the schema.
    697:             cols = schema_array.collect{|k,v| k}
    698:             set_columns(cols)
    699:             # Set the primary key(s) based on the schema information,
    700:             # if the schema information includes primary key information
    701:             if schema_array.all?{|k,v| v.has_key?(:primary_key)}
    702:               pks = schema_array.collect{|k,v| k if v[:primary_key]}.compact
    703:               pks.length > 0 ? set_primary_key(*pks) : no_primary_key
    704:             end
    705:             # Also set the columns for the dataset, so the dataset
    706:             # doesn't have to do a query to get them.
    707:             dataset.instance_variable_set(:@columns, cols)
    708:           end
    709:         else
    710:           # If the dataset uses multiple tables or custom sql or getting
    711:           # the schema raised an error, just get the columns and
    712:           # create an empty schema hash for it.
    713:           get_columns.call.each{|c| schema_hash[c] = {}}
    714:         end
    715:         schema_hash
    716:       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.

         # File lib/sequel/model/base.rb, line 722
    722:       def late_binding_class_option(opts, default)
    723:         case opts[:class]
    724:           when String, Symbol
    725:             # Delete :class to allow late binding
    726:             opts[:class_name] ||= opts.delete(:class).to_s
    727:           when Class
    728:             opts[:class_name] ||= opts[:class].name
    729:         end
    730:         opts[:class_name] ||= ((name || '').split("::")[0..2] + [camelize(default)]).join('::')
    731:       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`.

         # File lib/sequel/model/base.rb, line 735
    735:       def overridable_methods_module
    736:         include(@overridable_methods_module = Module.new) unless @overridable_methods_module
    737:         @overridable_methods_module
    738:       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.

         # File lib/sequel/model/base.rb, line 742
    742:       def plugin_module(plugin)
    743:         module_name = plugin.to_s.gsub(/(^|_)(.)/){|x| x[1..1].upcase}
    744:         if !Sequel::Plugins.const_defined?(module_name) ||
    745:            (Sequel.const_defined?(module_name) &&
    746:             Sequel::Plugins.const_get(module_name) == Sequel.const_get(module_name))
    747:           begin
    748:             Sequel.tsk_require "sequel/plugins/#{plugin}"
    749:           rescue LoadError => e
    750:             begin
    751:               Sequel.tsk_require "sequel_#{plugin}"
    752:             rescue LoadError => e2
    753:               e.message << "; #{e2.message}"
    754:               raise e
    755:             end
    756:           end
    757:         end
    758:         Sequel::Plugins.const_get(module_name)
    759:       end

plugin_module_defined?(plugin, submod) click to toggle source

Check if the plugin module `plugin` defines the constant named by `submod`.

         # File lib/sequel/model/base.rb, line 762
    762:       def plugin_module_defined?(plugin, submod)
    763:         if RUBY_VERSION >= '1.9'
    764:           plugin.const_defined?(submod, false)
    765:         else
    766:           plugin.const_defined?(submod)
    767:         end
    768:       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.

         # File lib/sequel/model/base.rb, line 772
    772:       def primary_key_lookup(pk)
    773:         if t = simple_table and p = simple_pk
    774:           with_sql("SELECT * FROM #{t} WHERE #{p} = #{dataset.literal(pk)}").first
    775:         else
    776:           dataset[primary_key_hash(pk)]
    777:         end
    778:       end

set_columns(new_columns) click to toggle source

Set the columns for this model and create accessor methods for each column.

         # File lib/sequel/model/base.rb, line 781
    781:       def set_columns(new_columns)
    782:         @columns = new_columns
    783:         def_column_accessor(*new_columns) if new_columns
    784:         @columns
    785:       end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.