Module: Sequel::Model::ClassMethods

### Home Classes Methods

### In Files

- lib/sequel/model/base.rb

### Methods

- #[]
- #call
- #clear_setter_methods_cache
- #columns
- #create
- #dataset
- #dataset=
- #dataset_module
- #db
- #db=
- #db_schema
- #def_column_alias
- #def_dataset_method
- #find
- #find_or_create
- #finder
- #first
- #first!
- #implicit_table_name
- #include
- #inherited
- #load
- #method_added
- #no_primary_key
- #plugin
- #prepared_finder
- #primary_key_hash
- #qualified_primary_key_hash
- #restrict_primary_key
- #restrict_primary_key?
- #set_allowed_columns
- #set_dataset
- #set_primary_key
- #setter_methods
- #subset
- #table_name
- #unrestrict_primary_key
- #with_pk
- #with_pk!

### Files

- CHANGELOG
- MIT-LICENSE
- README.rdoc
- active_record.rdoc
- advanced_associations.rdoc
- association_basics.rdoc
- bin_sequel.rdoc
- cheat_sheet.rdoc
- code_order.rdoc
- core_extensions.rdoc
- dataset_basics.rdoc
- dataset_filtering.rdoc
- extensions.rdoc
- mass_assignment.rdoc
- migration.rdoc
- model_hooks.rdoc
- model_plugins.rdoc
- mssql_stored_procedures.rdoc
- object_model.rdoc
- opening_databases.rdoc
- postgresql.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.34.0.txt
- 3.35.0.txt
- 3.36.0.txt
- 3.37.0.txt
- 3.38.0.txt
- 3.39.0.txt
- 3.4.0.txt
- 3.40.0.txt
- 3.41.0.txt
- 3.42.0.txt
- 3.43.0.txt
- 3.44.0.txt
- 3.45.0.txt
- 3.46.0.txt
- 3.47.0.txt
- 3.48.0.txt
- 3.5.0.txt
- 3.6.0.txt
- 3.7.0.txt
- 3.8.0.txt
- 3.9.0.txt
- 4.0.0.txt
- 4.1.0.txt
- 4.10.0.txt
- 4.11.0.txt
- 4.12.0.txt
- 4.13.0.txt
- 4.14.0.txt
- 4.15.0.txt
- 4.16.0.txt
- 4.17.0.txt
- 4.18.0.txt
- 4.19.0.txt
- 4.2.0.txt
- 4.20.0.txt
- 4.3.0.txt
- 4.4.0.txt
- 4.5.0.txt
- 4.6.0.txt
- 4.7.0.txt
- 4.8.0.txt
- 4.9.0.txt
- schema_modification.rdoc
- security.rdoc
- sharding.rdoc
- sql.rdoc
- testing.rdoc
- thread_safety.rdoc
- transactions.rdoc
- validations.rdoc
- virtual_rows.rdoc

### Class/Module Index

Quicksearch

- Sequel
- Sequel::ADO
- Sequel::ADO::Access
- Sequel::ADO::Access::AdoSchema
- Sequel::ADO::Access::AdoSchema::Column
- Sequel::ADO::Access::DatabaseMethods
- Sequel::ADO::Access::Dataset
- 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::AdapterNotFound
- Sequel::Amalgalite
- Sequel::Amalgalite::Database
- Sequel::Amalgalite::Dataset
- Sequel::Amalgalite::SequelTypeMap
- Sequel::ArbitraryServers
- Sequel::BasicObject
- Sequel::BeforeHookFailed
- Sequel::CheckConstraintViolation
- Sequel::ColumnsIntrospection
- Sequel::ConnectionPool
- Sequel::ConnectionPool::ClassMethods
- Sequel::ConnectionValidator
- Sequel::ConnectionValidator::Retry
- Sequel::ConstraintValidations
- Sequel::ConstraintValidations::AlterTableGeneratorMethods
- Sequel::ConstraintValidations::CreateTableGeneratorMethods
- Sequel::ConstraintValidations::Generator
- Sequel::ConstraintViolation
- Sequel::CoreRefinements
- Sequel::Cubrid
- Sequel::Cubrid::Database
- Sequel::Cubrid::DatabaseMethods
- Sequel::Cubrid::Dataset
- Sequel::Cubrid::DatasetMethods
- Sequel::CurrentDateTimeTimestamp
- Sequel::CurrentDateTimeTimestamp::DatasetMethods
- Sequel::CurrentDateTimeTimestamp::DateTime
- Sequel::CurrentDateTimeTimestamp::Time
- 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::DatabaseMethods
- Sequel::DataObjects::SQLite
- Sequel::DataObjects::SQLite::DatabaseMethods
- Sequel::Database
- Sequel::Database::DatasetClass
- Sequel::Database::FromBlock
- Sequel::Database::ResetIdentifierMangling
- Sequel::Database::SplitAlterTable
- Sequel::DatabaseConnectionError
- Sequel::DatabaseDisconnectError
- Sequel::DatabaseError
- Sequel::DatabaseQuery
- Sequel::Dataset
- Sequel::Dataset::ArgumentMapper
- Sequel::Dataset::DatasetSourceAlias
- Sequel::Dataset::NullDataset
- Sequel::Dataset::Nullifiable
- Sequel::Dataset::Pagination
- Sequel::Dataset::PlaceholderLiteralizer
- Sequel::Dataset::PlaceholderLiteralizer::Argument
- Sequel::Dataset::PlaceholderLiteralizer::Recorder
- Sequel::Dataset::PreparedStatementMethods
- Sequel::Dataset::Query
- Sequel::Dataset::Replace
- Sequel::Dataset::RoundTimestamps
- Sequel::Dataset::SplitArrayNil
- Sequel::Dataset::StoredProcedureMethods
- Sequel::Dataset::StoredProcedures
- Sequel::Dataset::UnnumberedArgumentMapper
- Sequel::DatasetPagination
- Sequel::DatasetPrinter
- Sequel::DatasetQuery
- Sequel::Deprecation
- Sequel::EmptyArrayIgnoreNulls
- Sequel::EmulateOffsetWithReverseAndCount
- Sequel::EmulateOffsetWithRowNumber
- Sequel::Error
- Sequel::Error::AdapterNotFound
- Sequel::Error::InvalidOperation
- Sequel::Error::InvalidValue
- Sequel::Error::PoolTimeoutError
- Sequel::Error::Rollback
- Sequel::ErrorSQL
- Sequel::EvalInspect
- Sequel::Fdbsql
- Sequel::Fdbsql::Connection
- Sequel::Fdbsql::Database
- Sequel::Fdbsql::DatabaseMethods
- Sequel::Fdbsql::Dataset
- Sequel::Fdbsql::Dataset::BindArgumentMethods
- Sequel::Fdbsql::Dataset::PreparedStatementMethods
- Sequel::Fdbsql::DatasetMethods
- Sequel::Fdbsql::DatasetMethods::PreparedStatementMethods
- Sequel::FilterHaving
- Sequel::Firebird
- Sequel::Firebird::Database
- Sequel::Firebird::DatabaseMethods
- Sequel::Firebird::Dataset
- Sequel::Firebird::DatasetMethods
- Sequel::ForeignKeyConstraintViolation
- Sequel::GraphEach
- Sequel::HashAliases
- 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::InvalidValue
- Sequel::JDBC
- Sequel::JDBC::AS400
- Sequel::JDBC::AS400::DatabaseMethods
- Sequel::JDBC::AS400::Dataset
- Sequel::JDBC::Cubrid
- Sequel::JDBC::Cubrid::DatabaseMethods
- Sequel::JDBC::DB2
- Sequel::JDBC::DB2::DatabaseMethods
- Sequel::JDBC::DB2::Dataset
- Sequel::JDBC::Database
- Sequel::JDBC::Dataset
- Sequel::JDBC::Dataset::PreparedStatementMethods
- Sequel::JDBC::Dataset::StoredProcedureMethods
- Sequel::JDBC::Derby
- Sequel::JDBC::Derby::DatabaseMethods
- Sequel::JDBC::Derby::Dataset
- Sequel::JDBC::Fdbsql
- Sequel::JDBC::Fdbsql::DatabaseMethods
- Sequel::JDBC::Fdbsql::Dataset
- Sequel::JDBC::Firebird
- Sequel::JDBC::Firebird::DatabaseMethods
- 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::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::Oracle
- Sequel::JDBC::Oracle::DatabaseMethods
- Sequel::JDBC::Oracle::Dataset
- Sequel::JDBC::Postgres
- Sequel::JDBC::Postgres::DatabaseMethods
- Sequel::JDBC::Postgres::Dataset
- Sequel::JDBC::Progress
- Sequel::JDBC::Progress::DatabaseMethods
- Sequel::JDBC::SQLServer
- Sequel::JDBC::SQLServer::DatabaseMethods
- Sequel::JDBC::SQLServer::DatabaseMethods::MetadataDatasetMethods
- Sequel::JDBC::SQLite
- Sequel::JDBC::SQLite::DatabaseMethods
- Sequel::JDBC::SqlAnywhere
- Sequel::JDBC::SqlAnywhere::DatabaseMethods
- Sequel::JDBC::SqlAnywhere::Dataset
- Sequel::JDBC::Transactions
- Sequel::JDBC::TypeConvertor
- Sequel::LiteralString
- Sequel::LooserTypecasting
- Sequel::MSSQL
- Sequel::MSSQL::DatabaseMethods
- Sequel::MSSQL::DatasetMethods
- Sequel::MSSQL::EmulateLateralWithApply
- Sequel::Metaprogramming
- Sequel::Migration
- Sequel::MigrationAlterTableReverser
- Sequel::MigrationDSL
- Sequel::MigrationReverser
- Sequel::Migrator
- Sequel::Migrator::Error
- Sequel::Migrator::NotCurrentError
- 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::OneThroughOneAssociationReflection
- Sequel::Model::Associations::OneToManyAssociationReflection
- Sequel::Model::Associations::OneToOneAssociationReflection
- Sequel::Model::Associations::SingularAssociationReflection
- Sequel::Model::ClassMethods
- Sequel::Model::DatasetMethods
- Sequel::Model::DatasetModule
- Sequel::Model::Errors
- Sequel::Model::InstanceMethods
- Sequel::MySQL
- Sequel::MySQL::Database
- Sequel::MySQL::DatabaseMethods
- Sequel::MySQL::Dataset
- Sequel::MySQL::DatasetMethods
- Sequel::MySQL::PreparedStatements
- Sequel::MySQL::PreparedStatements::DatabaseMethods
- Sequel::MySQL::PreparedStatements::DatasetMethods
- Sequel::MySQL::PreparedStatements::DatasetMethods::CallableStatementMethods
- Sequel::MySQL::PreparedStatements::DatasetMethods::PreparedStatementMethods
- Sequel::MySQL::PreparedStatements::DatasetMethods::StoredProcedureMethods
- Sequel::Mysql2
- Sequel::Mysql2::Database
- Sequel::Mysql2::Dataset
- Sequel::NamedTimezones
- Sequel::NamedTimezones::DatabaseMethods
- Sequel::NoExistingObject
- Sequel::NoMatchingRow
- Sequel::NotNullConstraintViolation
- Sequel::ODBC
- 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::Dataset
- Sequel::Oracle::Dataset::ArgumentMapper
- Sequel::Oracle::Dataset::BindArgumentMethods
- Sequel::Oracle::Dataset::PreparedStatementMethods
- Sequel::Oracle::DatasetMethods
- Sequel::Plugins
- Sequel::Plugins::AccessedColumns
- Sequel::Plugins::AccessedColumns::InstanceMethods
- Sequel::Plugins::ActiveModel
- Sequel::Plugins::ActiveModel::ClassMethods
- Sequel::Plugins::ActiveModel::Errors
- Sequel::Plugins::ActiveModel::InstanceMethods
- Sequel::Plugins::AfterInitialize
- Sequel::Plugins::AfterInitialize::ClassMethods
- Sequel::Plugins::AfterInitialize::InstanceMethods
- Sequel::Plugins::AssociationAutoreloading
- 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::AutoValidations
- Sequel::Plugins::AutoValidations::ClassMethods
- Sequel::Plugins::AutoValidations::InstanceMethods
- Sequel::Plugins::BlacklistSecurity
- Sequel::Plugins::BlacklistSecurity::ClassMethods
- Sequel::Plugins::BlacklistSecurity::InstanceMethods
- Sequel::Plugins::BlacklistSecurity::InstanceMethods::ExceptionList
- 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::ColumnConflicts
- Sequel::Plugins::ColumnConflicts::ClassMethods
- Sequel::Plugins::ColumnConflicts::InstanceMethods
- Sequel::Plugins::ColumnSelect
- Sequel::Plugins::ColumnSelect::ClassMethods
- Sequel::Plugins::Composition
- Sequel::Plugins::Composition::ClassMethods
- Sequel::Plugins::Composition::InstanceMethods
- Sequel::Plugins::ConstraintValidations
- Sequel::Plugins::ConstraintValidations::ClassMethods
- Sequel::Plugins::ConstraintValidations::DatabaseMethods
- Sequel::Plugins::ConstraintValidations::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::Dirty
- Sequel::Plugins::Dirty::InstanceMethods
- Sequel::Plugins::EagerEach
- Sequel::Plugins::EagerEach::DatasetMethods
- Sequel::Plugins::ErrorSplitter
- Sequel::Plugins::ErrorSplitter::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::InputTransformer
- Sequel::Plugins::InputTransformer::ClassMethods
- Sequel::Plugins::InputTransformer::InstanceMethods
- Sequel::Plugins::InsertReturningSelect
- Sequel::Plugins::InsertReturningSelect::ClassMethods
- Sequel::Plugins::InsertReturningSelect::InstanceMethods
- Sequel::Plugins::InstanceFilters
- Sequel::Plugins::InstanceFilters::Error
- 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::ManyThroughMany::OneThroughManyAssociationReflection
- Sequel::Plugins::ManyToOnePkLookup
- Sequel::Plugins::ModificationDetection
- Sequel::Plugins::ModificationDetection::ClassMethods
- Sequel::Plugins::ModificationDetection::InstanceMethods
- Sequel::Plugins::MssqlOptimisticLocking
- Sequel::Plugins::MssqlOptimisticLocking::ClassMethods
- Sequel::Plugins::MssqlOptimisticLocking::InstanceMethods
- Sequel::Plugins::NestedAttributes
- Sequel::Plugins::NestedAttributes::ClassMethods
- Sequel::Plugins::NestedAttributes::InstanceMethods
- Sequel::Plugins::OptimisticLocking
- Sequel::Plugins::OptimisticLocking::ClassMethods
- Sequel::Plugins::OptimisticLocking::Error
- Sequel::Plugins::OptimisticLocking::InstanceMethods
- Sequel::Plugins::PgArrayAssociations
- Sequel::Plugins::PgArrayAssociations::ClassMethods
- Sequel::Plugins::PgArrayAssociations::DatasetMethods
- Sequel::Plugins::PgArrayAssociations::ManyToPgArrayAssociationReflection
- Sequel::Plugins::PgArrayAssociations::PgArrayToManyAssociationReflection
- Sequel::Plugins::PgRow
- Sequel::Plugins::PgRow::ClassMethods
- Sequel::Plugins::PgRow::DatabaseMethods
- Sequel::Plugins::PgRow::InstanceMethods
- Sequel::Plugins::PgTypecastOnLoad
- Sequel::Plugins::PgTypecastOnLoad::ClassMethods
- Sequel::Plugins::PgTypecastOnLoad::InstanceMethods
- Sequel::Plugins::PreparedStatements
- Sequel::Plugins::PreparedStatements::ClassMethods
- Sequel::Plugins::PreparedStatements::InstanceMethods
- Sequel::Plugins::PreparedStatementsAssociations
- 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::Scissors
- Sequel::Plugins::Scissors::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::SplitValues
- Sequel::Plugins::SplitValues::ClassMethods
- Sequel::Plugins::SplitValues::InstanceMethods
- Sequel::Plugins::StaticCache
- Sequel::Plugins::StaticCache::ClassMethods
- Sequel::Plugins::StaticCache::InstanceMethods
- Sequel::Plugins::StringStripper
- Sequel::Plugins::StringStripper::ClassMethods
- Sequel::Plugins::Subclasses
- Sequel::Plugins::Subclasses::ClassMethods
- Sequel::Plugins::TableSelect
- Sequel::Plugins::TableSelect::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::UnlimitedUpdate
- Sequel::Plugins::UnlimitedUpdate::InstanceMethods
- Sequel::Plugins::UpdateOrCreate
- Sequel::Plugins::UpdateOrCreate::ClassMethods
- Sequel::Plugins::UpdatePrimaryKey
- 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::Postgres
- Sequel::Postgres::Adapter
- Sequel::Postgres::AlterTableGenerator
- Sequel::Postgres::ArrayOp
- Sequel::Postgres::ArrayOpMethods
- Sequel::Postgres::CreateTableGenerator
- Sequel::Postgres::Database
- Sequel::Postgres::DatabaseMethods
- Sequel::Postgres::Dataset
- Sequel::Postgres::Dataset::ArgumentMapper
- Sequel::Postgres::Dataset::BindArgumentMethods
- Sequel::Postgres::Dataset::PreparedStatementMethods
- Sequel::Postgres::DatasetMethods
- Sequel::Postgres::DatasetMethods::PreparedStatementMethods
- Sequel::Postgres::EnumDatabaseMethods
- Sequel::Postgres::ExclusionConstraintViolation
- Sequel::Postgres::HStore
- Sequel::Postgres::HStore::DatabaseMethods
- Sequel::Postgres::HStore::Parser
- Sequel::Postgres::HStoreOp
- Sequel::Postgres::HStoreOpMethods
- Sequel::Postgres::InetDatabaseMethods
- Sequel::Postgres::InetDatasetMethods
- Sequel::Postgres::IntervalDatabaseMethods
- Sequel::Postgres::IntervalDatabaseMethods::Parser
- Sequel::Postgres::IntervalDatasetMethods
- Sequel::Postgres::JSONArray
- Sequel::Postgres::JSONArrayBase
- Sequel::Postgres::JSONBArray
- Sequel::Postgres::JSONBHash
- Sequel::Postgres::JSONBOp
- Sequel::Postgres::JSONBaseOp
- Sequel::Postgres::JSONDatabaseMethods
- Sequel::Postgres::JSONHash
- Sequel::Postgres::JSONHashBase
- Sequel::Postgres::JSONOp
- Sequel::Postgres::JSONOpMethods
- Sequel::Postgres::LooseCount
- Sequel::Postgres::PGArray
- Sequel::Postgres::PGArray::Creator
- Sequel::Postgres::PGArray::DatabaseMethods
- Sequel::Postgres::PGArray::JSONCreator
- Sequel::Postgres::PGArray::Parser
- Sequel::Postgres::PGRange
- Sequel::Postgres::PGRange::DatabaseMethods
- Sequel::Postgres::PGRange::DatasetMethods
- Sequel::Postgres::PGRange::Parser
- Sequel::Postgres::PGRow
- Sequel::Postgres::PGRow::ArrayRow
- Sequel::Postgres::PGRow::DatabaseMethods
- Sequel::Postgres::PGRow::HashRow
- Sequel::Postgres::PGRow::Parser
- Sequel::Postgres::PGRow::Splitter
- Sequel::Postgres::PGRowOp
- Sequel::Postgres::PGRowOp::ExpressionMethods
- Sequel::Postgres::RangeOp
- Sequel::Postgres::RangeOpMethods
- Sequel::Postgres::StaticCacheUpdater
- Sequel::PrettyTable
- Sequel::Progress
- Sequel::Progress::DatabaseMethods
- Sequel::Progress::DatasetMethods
- Sequel::Qualifier
- Sequel::QueryLiterals
- 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::Builders
- 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::DateAdd
- Sequel::SQL::DateAdd::DatasetMethods
- Sequel::SQL::DelayedEvaluation
- Sequel::SQL::Expression
- Sequel::SQL::Function
- Sequel::SQL::GenericExpression
- Sequel::SQL::Identifier
- Sequel::SQL::InequalityMethods
- Sequel::SQL::JoinClause
- Sequel::SQL::JoinOnClause
- Sequel::SQL::JoinUsingClause
- Sequel::SQL::NegativeBooleanConstant
- Sequel::SQL::NumericExpression
- Sequel::SQL::NumericMethods
- Sequel::SQL::OperatorBuilders
- 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::VirtualRow
- Sequel::SQL::Window
- Sequel::SQL::Wrapper
- Sequel::SQLTime
- Sequel::SQLite
- Sequel::SQLite::Database
- Sequel::SQLite::DatabaseMethods
- Sequel::SQLite::Dataset
- Sequel::SQLite::Dataset::ArgumentMapper
- Sequel::SQLite::Dataset::BindArgumentMethods
- Sequel::SQLite::Dataset::PreparedStatementMethods
- Sequel::SQLite::DatasetMethods
- Sequel::Schema
- Sequel::Schema::AlterTableGenerator
- Sequel::Schema::CreateTableGenerator
- Sequel::Schema::Generator
- Sequel::SchemaCaching
- Sequel::SchemaDumper
- Sequel::SelectRemove
- Sequel::Sequel3DatasetMethods
- Sequel::SerializationFailure
- Sequel::ServerBlock
- Sequel::SetOverrides
- Sequel::ShardedSingleConnectionPool
- Sequel::ShardedThreadedConnectionPool
- Sequel::SimpleMigration
- Sequel::SingleConnectionPool
- Sequel::SqlAnywhere
- Sequel::SqlAnywhere::Database
- Sequel::SqlAnywhere::DatabaseMethods
- Sequel::SqlAnywhere::Dataset
- Sequel::SqlAnywhere::DatasetMethods
- Sequel::SqlAnywhere::SQLAnywhereException
- 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::DatabaseMethods
- 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::ToDot::DatasetMethods
- Sequel::UnbindDuplicate
- Sequel::Unbinder
- Sequel::UndefinedAssociation
- Sequel::UniqueConstraintViolation
- Sequel::UnthreadedServerBlock
- Sequel::ValidationFailed
- String
- String::Inflections
- Array
- FalseClass
- Hash
- NilClass
- Numeric
- Object
- PGconn
- PGresult
- Range
- 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.

### Constants

FINDER_TYPES

### 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/update/destroy due to a validation failure or a before_* hook returning false (default: true).

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) 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 108
    def [](*args)
      args = args.first if args.size <= 1
      args.is_a?(Hash) ? first_where(args) : (primary_key_lookup(args) unless args.nil?)
    end

call(values) 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 117
    def call(values)
      o = allocate
      o.instance_variable_set(:@values, values)
      o
    end

clear_setter_methods_cache() click to toggle source

Clear the setter_methods cache

    # File lib/sequel/model/base.rb, line 124
    def clear_setter_methods_cache
      @setter_methods = nil
    end

columns() click to toggle source

Returns the columns in the result set in their original order. Generally, this will use the columns determined via the database schema, but in certain cases (e.g. models that are based on a joined dataset) it will use `Dataset#columns` to find the columns.

    Artist.columns
    # => [:id, :name]

    # File lib/sequel/model/base.rb, line 135
    def columns
      @columns || set_columns(dataset.naked.columns)
    end

create(values = {}, &block) click to toggle source

Creates instance using new with the given values and block, and saves it.

    Artist.create(:name=>'Bob')
    # 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 147
    def create(values = {}, &block)
      new(values, &block).save
    end

dataset() click to toggle source

Returns the dataset associated with the Model class. Raises an `Error` if there is no associated dataset for this class. In most cases, you don't need to call this directly, as Model proxies many dataset methods to the underlying dataset.

    Artist.dataset.all # SELECT * FROM artists

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

dataset=(ds) click to toggle source

Alias of set_dataset

    # File lib/sequel/model/base.rb, line 162
    def dataset=(ds)
      set_dataset(ds)
    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. This is the recommended way to add methods to model datasets.

If an argument, it should be a module, and is used to extend the underlying dataset. Otherwise an anonymous module is created, and if a block is given, it is module_evaled, allowing you do define dataset methods directly using the standard ruby def syntax. Returns the module given or the anonymous module created.

    # Usage with existing module
    Artist.dataset_module Sequel::ColumnsIntrospection

    # Usage with anonymous module
    Artist.dataset_module do
      def foo
        :bar
      end
    end
    Artist.dataset.foo
    # => :bar
    Artist.foo
    # => :bar

Any anonymous modules created are actually instances of Sequel::Model::DatasetModule (a Module subclass), which allows you to call the subset method on them:

    Artist.dataset_module do
      subset :released, Sequel.identifier(release_date) > Sequel::CURRENT_DATE
    end

Any public methods in the dataset module will have class methods created that call the method on the dataset, assuming that the class method is not already defined.

    # File lib/sequel/model/base.rb, line 200
    def dataset_module(mod = nil)
      if mod
        raise Error, "can't provide both argument and block to Model.dataset_module" if block_given?
        dataset_extend(mod)
        mod
      else
        @dataset_module ||= DatasetModule.new(self)
        @dataset_module.module_eval(&Proc.new) if block_given?
        dataset_extend(@dataset_module)
        @dataset_module
      end
    end

db() click to toggle source

Returns the database associated with the Model class. If this model doesn't have a database associated with it, assumes the superclass's database, or the first object in Sequel::DATABASES. If no Sequel::Database object has been created, raises an error.

    Artist.db.transaction do # BEGIN
      Artist.create(:name=>'Bob')
      # INSERT INTO artists (name) VALUES ('Bob')
    end # COMMIT

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

db=(db) click to toggle source

Sets the database associated with the Model class. If the model has an associated dataset, sets the model's dataset to a dataset on the new database with the same options used by the current dataset. This can be used directly on Sequel::Model to set the default database to be used by subclasses, or to override the database used for specific models:

    Sequel::Model.db = DB1
    Artist.db = DB2

Note that you should not use this to change the model's database at runtime. If you have that need, you should look into Sequel's sharding support.

    # File lib/sequel/model/base.rb, line 244
    def db=(db)
      @db = db
      set_dataset(db.dataset.clone(@dataset.opts)) if @dataset
    end

db_schema() click to toggle source

Returns the cached schema information if available or gets it from the database. This is a hash where keys are column symbols and values are hashes of information related to the column. See `Database#schema`.

    Artist.db_schema
    # {:id=>{:type=>:integer, :primary_key=>true, ...},
    #  :name=>{:type=>:string, :primary_key=>false, ...}}

    # File lib/sequel/model/base.rb, line 257
    def db_schema
      @db_schema ||= get_db_schema
    end

def_column_alias(meth, column) click to toggle source

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

    # File lib/sequel/model/base.rb, line 263
    def def_column_alias(meth, column)
      clear_setter_methods_cache
      overridable_methods_module.module_eval do
        define_method(meth){self[column]}
        define_method("#{meth}="){|v| self[column] = v}
      end
    end

def_dataset_method(*args, &block) click to toggle source

If a block is given, define a method on the dataset (if the model currently has an dataset) with the given argument name using the given block. Also define a class method on the model that calls the dataset method. Stores the method name and block so that it can be reapplied if the model's dataset changes.

If a block is not given, just define a class method on the model for each argument that calls the dataset method of the same argument name.

It is recommended that you define methods inside a block passed to dataset_module instead of using this method, as dataset_module allows you to use normal ruby def syntax.

    # 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 291
    def def_dataset_method(*args, &block)
      raise(Error, "No arguments given") if args.empty?

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

find(*args, &block) click to toggle source

Finds a single record according to the supplied filter. You are encouraged to use Model.[] or Model.first instead of this method.

    Artist.find(:name=>'Bob')
    # 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 310
    def find(*args, &block)
      if args.length == 1 && !block
        # Use optimized finder
        first_where(args.first)
      else
        filter(*args, &block).first
      end
    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 331
    def find_or_create(cond, &block)
      find(cond) || create(cond, &block)
    end

finder(meth=OPTS, opts=OPTS, &block) click to toggle source

Create an optimized finder method using a dataset placeholder literalizer. This pre-computes the SQL to use for the query, except for given arguments.

There are two ways to use this. The recommended way is to pass a symbol that represents a model class method that returns a dataset:

    def Artist.by_name(name)
      where(:name=>name)
    end

    Artist.finder :by_name

This creates an optimized first_by_name method, which you can call normally:

    Artist.first_by_name("Joe")

The alternative way to use this to pass your own block:

    Artist.finder(:name=>:first_by_name){|pl, ds| ds.where(:name=>pl.arg).limit(1)}

Note that if you pass your own block, you are responsible for manually setting limits if necessary (as shown above).

Options:

:arity | When using a symbol method name, this specifies the arity of the method. This should be used if if the method accepts an arbitrary number of arguments, or the method has default argument values. Note that if the method is defined as a dataset method, the class method Sequel creates accepts an arbitrary number of arguments, so you should use this option in that case. If you want to handle multiple possible arities, you need to call the finder method multiple times with unique :arity and :name methods each time.
:name | The name of the method to create. This must be given if you pass a block. If you use a symbol, this defaults to the symbol prefixed by the type.
:mod | The module in which to create the finder method. Defaults to the singleton class of the model.
:type | The type of query to run. Can be :first, :each, :all, or :get, defaults to :first.

Caveats:

This doesn't handle all possible cases. For example, if you have a method such as:

    def Artist.by_name(name)
      name ? where(:name=>name) : exclude(:name=>nil)
    end

Then calling a finder without an argument will not work as you expect.

    Artist.finder :by_name
    Artist.by_name(nil).first
    # WHERE (name IS NOT NULL)
    Artist.first_by_name(nil)
    # WHERE (name IS NULL)

See Dataset::PlaceholderLiteralizer for additional caveats.

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

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

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

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

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

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

first(*args, &block) click to toggle source

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

    # File lib/sequel/model/base.rb, line 459
    def first(*args, &block)
      if args.length == 1 && !block && !args.first.is_a?(Integer)
        # Use optimized finder
        first_where(args.first)
      else
        dataset.first(*args, &block)
      end
    end

first!(*args, &block) click to toggle source

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

    # File lib/sequel/model/base.rb, line 470
    def first!(*args, &block)
      first(*args, &block) || raise(Sequel::NoMatchingRow)
    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 529
    def implicit_table_name
      pluralize(underscore(demodulize(name))).to_sym
    end

include(*mods) 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 476
    def include(*mods)
      clear_setter_methods_cache
      super
    end

inherited(subclass) click to toggle source

If possible, set the dataset for the model subclass as soon as it is created. Also, make sure the inherited class instance variables are copied into the subclass.

Sequel queries the database to get schema information as soon as a model class is created:

    class Artist < Sequel::Model # Causes schema query
    end

    # File lib/sequel/model/base.rb, line 490
    def inherited(subclass)
      super
      ivs = subclass.instance_variables.collect{|x| x.to_s}
      inherited_instance_variables.each do |iv, dup|
        next if ivs.include?(iv.to_s)
        if (sup_class_value = instance_variable_get(iv)) && dup
          sup_class_value = case dup
          when :dup
            sup_class_value.dup
          when :hash_dup
            h = {}
            sup_class_value.each{|k,v| h[k] = v.dup}
            h
          when Proc
            dup.call(sup_class_value)
          else
            raise Error, "bad inherited instance variable type: #{dup.inspect}"
          end
        end
        subclass.instance_variable_set(iv, sup_class_value)
      end
      unless ivs.include?("@dataset")
        if self == Model || !@dataset
          n = subclass.name
          unless n.nil? || n.empty?
            db
            subclass.set_dataset(subclass.implicit_table_name) rescue nil
          end
        elsif @dataset
          subclass.set_dataset(@dataset.clone, :inherited=>true) rescue nil
        end
      end
    end

load(values) click to toggle source

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

    # File lib/sequel/model/base.rb, line 534
    def load(values)
      call(values)
    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 539
    def method_added(meth)
      clear_setter_methods_cache if meth.to_s =~ SETTER_METHOD_REGEXP
      super
    end

no_primary_key() click to toggle source

Mark the model as not having a primary key. Not having a primary key can cause issues, among which is that you won't be able to update records.

    Artist.primary_key # => :id
    Artist.no_primary_key
    Artist.primary_key # => nil

    # File lib/sequel/model/base.rb, line 550
    def no_primary_key
      clear_setter_methods_cache
      self.simple_pk = @primary_key = nil
    end

plugin(plugin, *args, &block) click to toggle source

Loads a plugin for use with the model class, passing optional arguments to the plugin. If the plugin is a module, load it directly. Otherwise, require the plugin from either sequel/plugins/#{plugin} or sequel_#{plugin}, and then attempt to load the module using a the camelized plugin name under Sequel::Plugins.

    # File lib/sequel/model/base.rb, line 560
    def plugin(plugin, *args, &block)
      m = plugin.is_a?(Module) ? plugin : plugin_module(plugin)
      unless @plugins.include?(m)
        @plugins << m
        m.apply(self, *args, &block) if m.respond_to?(:apply)
        extend(m::ClassMethods) if plugin_module_defined?(m, :ClassMethods)
        include(m::InstanceMethods) if plugin_module_defined?(m, :InstanceMethods)
        if plugin_module_defined?(m, :DatasetMethods)
          dataset_extend(m::DatasetMethods, :create_class_methods=>false)
        end
      end
      m.configure(self, *args, &block) if m.respond_to?(:configure)
    end

prepared_finder(meth=OPTS, opts=OPTS, &block) click to toggle source

Similar to finder, but uses a prepared statement instead of a placeholder literalizer. This makes the SQL used static (cannot vary per call), but allows binding argument values instead of literalizing them into the SQL query string.

If a block is used with this method, it is instance_execed by the model, and should accept the desired number of placeholder arguments.

The options are the same as the options for finder, with the following exception:

:type | Specifies the type of prepared statement to create

    # File lib/sequel/model/base.rb, line 626
    def prepared_finder(meth=OPTS, opts=OPTS, &block)
      if block
        raise Error, "cannot pass both a method name argument and a block of Model.finder" unless meth.is_a?(Hash)
        meth = meth.merge(:prepare=>true)
      else
        opts = opts.merge(:prepare=>true)
      end
      finder(meth, opts, &block)
    end

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

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

restrict_primary_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 639
    def restrict_primary_key
      clear_setter_methods_cache
      @restrict_primary_key = true
    end

restrict_primary_key?() click to toggle source

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

    # File lib/sequel/model/base.rb, line 646
    def restrict_primary_key?
      @restrict_primary_key
    end

set_allowed_columns(*cols) click to toggle source

Set the columns to allow when using mass assignment (e.g. `set`). Using this means that any columns not listed here will not be modified. If you have any virtual setter methods (methods that end in =) that you want to be used during mass assignment, they need to be listed here as well (without the =).

It may be better to use a method such as `set_only` or `set_fields` that lets you specify the allowed fields per call.

    Artist.set_allowed_columns(:name, :hometown)
    Artist.set(:name=>'Bob', :hometown=>'Sactown') # No Error
    Artist.set(:name=>'Bob', :records_sold=>30000) # Error

    # File lib/sequel/model/base.rb, line 661
    def set_allowed_columns(*cols)
      clear_setter_methods_cache
      @allowed_columns = cols
    end

set_dataset(ds, opts=OPTS) click to toggle source

Sets the dataset associated with the Model class. `ds` can be a `Symbol`, `LiteralString`, `SQL::Identifier`, `SQL::QualifiedIdentifier`, `SQL::AliasedExpression` (all specifying a table name in the current database), or a `Dataset`. If a dataset is used, the model's database is changed to the database of the given dataset. If a dataset is not used, a dataset is created from the current database with the table name given. Other arguments raise an `Error`. Returns self.

This changes the row_proc of the dataset to return model objects and extends the dataset with the dataset_method_modules. It also attempts to determine the database schema for the model, based on the given dataset.

    Artist.set_dataset(:tbl_artists)
    Artist.set_dataset(DB[:artists])

Note that you should not use this to change the model's dataset at runtime. If you have that need, you should look into Sequel's sharding support.

    # File lib/sequel/model/base.rb, line 686
    def set_dataset(ds, opts=OPTS)
      inherited = opts[:inherited]
      @dataset = convert_input_dataset(ds)
      @require_modification = Sequel::Model.require_modification.nil? ? @dataset.provides_accurate_rows_matched? : Sequel::Model.require_modification
      if inherited
        self.simple_table = superclass.simple_table
        @columns = @dataset.columns rescue nil
      else
        @dataset_method_modules.each{|m| @dataset.extend(m)} if @dataset_method_modules
      end
      @dataset.model = self if @dataset.respond_to?(:model=)
      check_non_connection_error{@db_schema = (inherited ? superclass.db_schema : get_db_schema)}
      reset_instance_dataset
      self
    end

set_primary_key(key) click to toggle source

Sets the primary key for this model. You can use either a regular or a composite primary key. To not use a primary key, set to nil or use `no_primary_key`. On most adapters, Sequel can automatically determine the primary key to use, so this method is not needed often.

    class Person < Sequel::Model
      # 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 716
    def set_primary_key(key)
      clear_setter_methods_cache
      if key.is_a?(Array)
        if key.length < 2
          key = key.first
        else
          key = key.dup.freeze
        end
      end
      self.simple_pk = if key && !key.is_a?(Array)
        (@dataset || db).literal(key)
      end
      @primary_key = key
    end

setter_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 732
    def setter_methods
      @setter_methods ||= get_setter_methods
    end

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

Sets up a dataset method that returns a filtered dataset. Sometimes thought of as a scope, and like most dataset methods, they can be chained. For example:

    Topic.subset(:joes, :username.like('%joe%'))
    Topic.subset(:popular){num_posts > 100}
    Topic.subset(:recent){created_on > Date.today - 7}

Allows you to do:

    Topic.joes.recent.popular

to get topics with a username that includes joe that have more than 100 posts and were created less than 7 days ago.

Both the args given and the block are passed to `Dataset#filter`.

This method creates dataset methods that do not accept arguments. To create dataset methods that accept arguments, you should use define a method directly inside a dataset_module block.

    # File lib/sequel/model/base.rb, line 758
    def subset(name, *args, &block)
      dataset_module.subset(name, *args, &block)
    end

table_name() click to toggle source

Returns name of primary table for the dataset. If the table for the dataset is aliased, returns the aliased name.

    Artist.table_name # => :artists
    Sequel::Model(:foo).table_name # => :foo
    Sequel::Model(:foo___bar).table_name # => :bar

    # File lib/sequel/model/base.rb, line 768
    def table_name
      dataset.first_source_alias
    end

unrestrict_primary_key() click to toggle source

Allow the setting of the primary key(s) when using the mass assignment methods. Using this method can open up security issues, be very careful before using it.

    Artist.set(:id=>1) # Error
    Artist.unrestrict_primary_key
    Artist.set(:id=>1) # No Error

    # File lib/sequel/model/base.rb, line 778
    def unrestrict_primary_key
      clear_setter_methods_cache
      @restrict_primary_key = false
    end

with_pk(pk) click to toggle source

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

    # File lib/sequel/model/base.rb, line 784
    def with_pk(pk)
      primary_key_lookup(pk)
    end

with_pk!(pk) click to toggle source

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

    # File lib/sequel/model/base.rb, line 789
    def with_pk!(pk)
      with_pk(pk) || raise(NoMatchingRow)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.