Module: Sequel::Model::InstanceMethods

### Home Classes Methods

### In Files

- lib/sequel/model/base.rb
- lib/sequel/plugins/prepared_statements.rb

### Methods

- ::new
- #==
- #===
- #[]
- #[]=
- #autoincrementing_primary_key
- #cancel_action
- #changed_columns
- #delete
- #destroy
- #each
- #eql?
- #errors
- #exists?
- #extend
- #freeze
- #hash
- #id
- #inspect
- #keys
- #lock!
- #marshallable!
- #modified!
- #modified?
- #new?
- #pk
- #pk_hash
- #qualified_pk_hash
- #refresh
- #reload
- #save
- #save_changes
- #set
- #set_all
- #set_fields
- #set_only
- #set_server
- #singleton_method_added
- #this
- #update
- #update_all
- #update_fields
- #update_only
- #use_prepared_statements_for?
- #valid?
- #validate

### 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.21.0.txt
- 4.22.0.txt
- 4.23.0.txt
- 4.24.0.txt
- 4.25.0.txt
- 4.26.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::Amalgalite
- Sequel::Amalgalite::Database
- Sequel::Amalgalite::Dataset
- Sequel::Amalgalite::SequelTypeMap
- Sequel::ArbitraryServers
- Sequel::BasicObject
- Sequel::BeforeHookFailed
- Sequel::ColumnsIntrospection
- Sequel::ConnectionPool
- Sequel::ConnectionPool::ClassMethods
- Sequel::ConnectionValidator
- Sequel::ConnectionValidator::Retry
- Sequel::ConstraintValidations
- Sequel::ConstraintValidations::AlterTableGeneratorMethods
- Sequel::ConstraintValidations::CreateTableGeneratorMethods
- Sequel::ConstraintValidations::Generator
- 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::DatabaseMethods
- Sequel::DB2::DatasetMethods
- 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::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::EmptyArrayConsiderNulls
- Sequel::EmulateOffsetWithReverseAndCount
- Sequel::EmulateOffsetWithRowNumber
- Sequel::Error
- Sequel::ErrorSQL
- Sequel::EvalInspect
- Sequel::FilterHaving
- Sequel::Firebird
- Sequel::Firebird::DatabaseMethods
- Sequel::Firebird::DatasetMethods
- 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::Statement
- Sequel::Inflections
- Sequel::Informix
- Sequel::Informix::DatabaseMethods
- Sequel::Informix::DatasetMethods
- Sequel::IntegerMigrator
- 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::Derby
- Sequel::JDBC::Derby::DatabaseMethods
- Sequel::JDBC::Derby::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::Mysql2
- Sequel::Mysql2::Database
- Sequel::Mysql2::Dataset
- Sequel::NamedTimezones
- Sequel::NamedTimezones::DatabaseMethods
- Sequel::NoMatchingRow
- Sequel::ODBC
- Sequel::ODBC::Database
- Sequel::ODBC::Dataset
- Sequel::ODBC::MSSQL
- Sequel::ODBC::MSSQL::DatabaseMethods
- Sequel::ODBC::MSSQL::Dataset
- Sequel::Oracle
- Sequel::Oracle::Database
- Sequel::Oracle::DatabaseMethods
- Sequel::Oracle::Dataset
- Sequel::Oracle::Dataset::ArgumentMapper
- 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::CsvSerializer
- Sequel::Plugins::CsvSerializer::ClassMethods
- Sequel::Plugins::CsvSerializer::DatasetMethods
- Sequel::Plugins::CsvSerializer::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::DelayAddAssociation
- Sequel::Plugins::DelayAddAssociation::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::InstanceMethods
- Sequel::Plugins::InstanceHooks
- Sequel::Plugins::InstanceHooks::InstanceMethods
- Sequel::Plugins::InvertedSubsets
- Sequel::Plugins::InvertedSubsets::ClassMethods
- 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::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::SingularTableNames
- Sequel::Plugins::SingularTableNames::ClassMethods
- 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::UpdateRefresh
- Sequel::Plugins::UpdateRefresh::ClassMethods
- Sequel::Plugins::UpdateRefresh::InstanceMethods
- Sequel::Plugins::ValidateAssociated
- Sequel::Plugins::ValidateAssociated::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::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::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::InetOp
- Sequel::Postgres::InetOpMethods
- 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::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::PatternMatchMethods
- 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::DatasetMethods
- Sequel::Schema
- Sequel::Schema::AlterTableGenerator
- Sequel::Schema::CreateTableGenerator
- Sequel::Schema::Generator
- Sequel::SchemaCaching
- Sequel::SchemaDumper
- Sequel::SelectRemove
- Sequel::Sequel3DatasetMethods
- 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::ToDot
- Sequel::ToDot::DatasetMethods
- Sequel::Unbinder
- Sequel::UnthreadedServerBlock
- Sequel::ValidationFailed
- String
- String::Inflections
- Array
- FalseClass
- Hash
- NilClass
- Numeric
- Object
- PGconn
- PGresult
- Range
- Symbol
- TrueClass

No matching classes.

# Sequel::Model::InstanceMethods

Sequel::Model instance methods that implement basic model functionality.

- All of the methods in `HOOKS` and `AROUND_HOOKS` create instance methods that are called by Sequel when the appropriate action occurs. For example, when destroying a model object, Sequel will call `around_destroy`, which will call `before_destroy`, do the destroy, and then call `after_destroy`.

- The following instance_methods all call the class method of the same name: columns, db, primary_key, db_schema.

- All of the methods in `BOOLEAN_SETTINGS` create attr_writers allowing you to set values for the attribute. It also creates instance getters returning the value of the setting. If the value has not yet been set, it gets the default value from the class by calling the class method of the same name.

### Attributes

to_hash[R]

The hash of attribute values. Keys are symbols with the names of the underlying database columns.

    Artist.new(:name=>'Bob').values # => {:name=>'Bob'}
    Artist[1].values # => {:id=>1, :name=>'Jim', ...}

values[R]

The hash of attribute values. Keys are symbols with the names of the underlying database columns.

    Artist.new(:name=>'Bob').values # => {:name=>'Bob'}
    Artist[1].values # => {:id=>1, :name=>'Jim', ...}

### Public Class Methods

new(values = {}) click to toggle source

Creates new instance and passes the given values to set. If a block is given, yield the instance to the block.

Arguments:

values | should be a hash to pass to set.

    Artist.new(:name=>'Bob')

    Artist.new do |a|
      a.name = 'Bob'
    end

    # File lib/sequel/model/base.rb, line 1169
    def initialize(values = {})
      @values = {}
      @new = true
      @modified = true
      initialize_set(values)
      changed_columns.clear
      yield self if block_given?
    end

### Public Instance Methods

==(obj) click to toggle source

Alias of eql?

    # File lib/sequel/model/base.rb, line 1206
    def ==(obj)
      eql?(obj)
    end

===(obj) click to toggle source

If pk is not nil, true only if the objects have the same class and pk. If pk is nil, false.

    Artist[1] === Artist[1] # true
    Artist.new === Artist.new # false
    Artist[1].set(:name=>'Bob') == Artist[1] # => true

    # File lib/sequel/model/base.rb, line 1216
    def ===(obj)
      pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
    end

[](column) click to toggle source

Returns value of the column's attribute.

    Artist[1][:id] #=> 1

    # File lib/sequel/model/base.rb, line 1181
    def [](column)
      @values[column]
    end

[]=(column, value) click to toggle source

Sets the value for the given column. If typecasting is enabled for this object, typecast the value based on the column's type. If this is a new record or the typecasted value isn't the same as the current value for the column, mark the column as changed.

    a = Artist.new
    a[:name] = 'Bob'
    a.values #=> {:name=>'Bob'}

    # File lib/sequel/model/base.rb, line 1193
    def []=(column, value)
      # If it is new, it doesn't have a value yet, so we should
      # definitely set the new value.
      # If the column isn't in @values, we can't assume it is
      # NULL in the database, so assume it has changed.
      v = typecast_value(column, value)
      vals = @values
      if new? || !vals.include?(column) || v != (c = vals[column]) || v.class != c.class
        change_column_value(column, v)
      end
    end

autoincrementing_primary_key() click to toggle source

The autoincrementing primary key for this model object. Should be overridden if you have a composite primary key with one part of it being autoincrementing.

    # File lib/sequel/model/base.rb, line 1231
    def autoincrementing_primary_key
      primary_key
    end

cancel_action(msg=nil) click to toggle source

Cancel the current action. Should be called in before hooks to halt the processing of the action. If a `msg` argument is given and the model instance is configured to raise exceptions on failure, sets the message to use for the raised HookFailed exception.

    # File lib/sequel/model/base.rb, line 1239
    def cancel_action(msg=nil)
      raise_hook_failure(msg)
    end

changed_columns() click to toggle source

The columns that have been updated. This isn't completely accurate, as it could contain columns whose values have not changed.

    a = Artist[1]
    a.changed_columns # => []
    a.name = 'Bob'
    a.changed_columns # => [:name]

    # File lib/sequel/model/base.rb, line 1250
    def changed_columns
      @changed_columns ||= []
    end

delete() click to toggle source

Deletes and returns `self`. Does not run destroy hooks. Look into using `destroy` instead.

    Artist[1].delete # DELETE FROM artists WHERE (id = 1)
    # => #<Artist {:id=>1, ...}>

    # File lib/sequel/model/base.rb, line 1259
    def delete
      raise Sequel::Error, "can't delete frozen object" if frozen?
      _delete
      self
    end

destroy(opts = OPTS) click to toggle source

Like delete but runs hooks before and after delete. If before_destroy returns false, returns false without deleting the object from the database. Otherwise, deletes the item from the database and returns self. Uses a transaction if use_transactions is true or if the :transaction option is given and true.

    Artist[1].destroy # BEGIN; DELETE FROM artists WHERE (id = 1); COMMIT;
    # => #<Artist {:id=>1, ...}>

    # File lib/sequel/model/base.rb, line 1274
    def destroy(opts = OPTS)
      raise Sequel::Error, "can't destroy frozen object" if frozen?
      checked_save_failure(opts){checked_transaction(opts){_destroy(opts)}}
    end

each(&block) click to toggle source

Iterates through all of the current values using each.

    Album[1].each{|k, v| puts "#{k} => #{v}"}
    # id => 1
    # name => 'Bob'

    # File lib/sequel/model/base.rb, line 1284
    def each(&block)
      @values.each(&block)
    end

eql?(obj) click to toggle source

Compares model instances by values.

    Artist[1] == Artist[1] # => true
    Artist.new == Artist.new # => true
    Artist[1].set(:name=>'Bob') == Artist[1] # => false

    # File lib/sequel/model/base.rb, line 1293
    def eql?(obj)
      (obj.class == model) && (obj.values == @values)
    end

errors() click to toggle source

Returns the validation errors associated with this object. See `Errors`.

    # File lib/sequel/model/base.rb, line 1299
    def errors
      @errors ||= errors_class.new
    end

exists?() click to toggle source

Returns true when current instance exists, false otherwise. Generally an object that isn't new will exist unless it has been deleted. Uses a database query to check for existence, unless the model object is new, in which case this is always false.

    Artist[1].exists? # SELECT 1 FROM artists WHERE (id = 1)
    # => true
    Artist.new.exists?
    # => false

    # File lib/sequel/model/base.rb, line 1313
    def exists?
      new? ? false : !this.get(SQL::AliasedExpression.new(1, :one)).nil?
    end

extend(mod) click to toggle source

Ignore the model's setter method cache when this instances extends a module, as the module may contain setter methods.

    # File lib/sequel/model/base.rb, line 1319
    def extend(mod)
      @singleton_setter_added = true
      super
    end

freeze() click to toggle source

Freeze the object in such a way that it is still usable but not modifiable. Once an object is frozen, you cannot modify it's values, changed_columns, errors, or dataset.

    # File lib/sequel/model/base.rb, line 1327
    def freeze
      values.freeze
      changed_columns.freeze
      unless errors.frozen?
        validate
        errors.freeze
      end
      this.freeze if !new? && model.primary_key
      super
    end

hash() click to toggle source

Value that should be unique for objects with the same class and pk (if pk is not nil), or the same class and values (if pk is nil).

    Artist[1].hash == Artist[1].hash # true
    Artist[1].set(:name=>'Bob').hash == Artist[1].hash # true
    Artist.new.hash == Artist.new.hash # true
    Artist.new(:name=>'Bob').hash == Artist.new.hash # false

    # File lib/sequel/model/base.rb, line 1345
    def hash
      case primary_key
      when Array
        [model, !pk.all? ? @values : pk].hash
      when Symbol
        [model, pk.nil? ? @values : pk].hash
      else
        [model, @values].hash
      end
    end

id() click to toggle source

Returns value for the :id attribute, even if the primary key is not id. To get the primary key value, use `pk`.

    Artist[1].id # => 1

    # File lib/sequel/model/base.rb, line 1360
    def id
      @values[:id]
    end

inspect() click to toggle source

Returns a string representation of the model instance including the class name and values.

    # File lib/sequel/model/base.rb, line 1366
    def inspect
      "#<#{model.name} @values=#{inspect_values}>"
    end

keys() click to toggle source

Returns the keys in `values`. May not include all column names.

    Artist.new.keys # => []
    Artist.new(:name=>'Bob').keys # => [:name]
    Artist[1].keys # => [:id, :name]

    # File lib/sequel/model/base.rb, line 1375
    def keys
      @values.keys
    end

lock!() click to toggle source

Refresh this record using `for_update` unless this is a new record. Returns self. This can be used to make sure no other process is updating the record at the same time.

    a = Artist[1]
    Artist.db.transaction do
      a.lock!
      a.update(:name=>'A')
    end

    # File lib/sequel/model/base.rb, line 1388
    def lock!
      _refresh(this.for_update) unless new?
      self
    end

marshallable!() click to toggle source

Remove elements of the model object that make marshalling fail. Returns self.

    a = Artist[1]
    a.marshallable!
    Marshal.dump(a)

    # File lib/sequel/model/base.rb, line 1398
    def marshallable!
      @this = nil
      self
    end

modified!(column=nil) click to toggle source

Explicitly mark the object as modified, so `save_changes`/`update` will run callbacks even if no columns have changed.

    a = Artist[1]
    a.save_changes # No callbacks run, as no changes
    a.modified!
    a.save_changes # Callbacks run, even though no changes made

If a column is given, specifically marked that column as modified, so that `save_changes`/`update` will include that column in the update. This should be used if you plan on mutating the column value instead of assigning a new column value:

    a.modified!(:name)
    a.name.gsub!(/[aeou]/, 'i')

    # File lib/sequel/model/base.rb, line 1418
    def modified!(column=nil)
      if column && !changed_columns.include?(column)
        changed_columns << column
      end
      @modified = true
    end

modified?(column=nil) click to toggle source

Whether this object has been modified since last saved, used by save_changes to determine whether changes should be saved. New values are always considered modified.

    a = Artist[1]
    a.modified? # => false
    a.set(:name=>'Jim')
    a.modified? # => true

If a column is given, specifically check if the given column has been modified:

    a.modified?(:num_albums) # => false
    a.num_albums = 10
    a.modified?(:num_albums) # => true

    # File lib/sequel/model/base.rb, line 1440
    def modified?(column=nil)
      if column
        changed_columns.include?(column)
      else
        @modified || !changed_columns.empty?
      end
    end

new?() click to toggle source

Returns true if the current instance represents a new record.

    Artist.new.new? # => true
    Artist[1].new? # => false

    # File lib/sequel/model/base.rb, line 1452
    def new?
      defined?(@new) ? @new : (@new = false)
    end

pk() click to toggle source

Returns the primary key value identifying the model instance. Raises an `Error` if this model does not have a primary key. If the model has a composite primary key, returns an array of values.

    Artist[1].pk # => 1
    Artist[[1, 2]].pk # => [1, 2]

    # File lib/sequel/model/base.rb, line 1462
    def pk
      raise(Error, "No primary key is associated with this model") unless key = primary_key
      if key.is_a?(Array)
        vals = @values
        key.map{|k| vals[k]}
      else
        @values[key]
      end
    end

pk_hash() click to toggle source

Returns a hash mapping the receivers primary key column(s) to their values.

    Artist[1].pk_hash # => {:id=>1}
    Artist[[1, 2]].pk_hash # => {:id1=>1, :id2=>2}

    # File lib/sequel/model/base.rb, line 1476
    def pk_hash
      model.primary_key_hash(pk)
    end

qualified_pk_hash(qualifier=model.table_name) click to toggle source

Returns a hash mapping the receivers primary key column(s) to their values.

    Artist[1].qualified_pk_hash
    # => {Sequel.qualify(:artists, :id)=>1}
    Artist[[1, 2]].qualified_pk_hash
    # => {Sequel.qualify(:artists, :id1)=>1, Sequel.qualify(:artists, :id2)=>2}

    # File lib/sequel/model/base.rb, line 1486
    def qualified_pk_hash(qualifier=model.table_name)
      model.qualified_primary_key_hash(pk, qualifier)
    end

refresh() click to toggle source

Reloads attributes from database and returns self. Also clears all changed_columns information. Raises an `Error` if the record no longer exists in the database.

    a = Artist[1]
    a.name = 'Jim'
    a.refresh
    a.name # => 'Bob'

    # File lib/sequel/model/base.rb, line 1498
    def refresh
      raise Sequel::Error, "can't refresh frozen object" if frozen?
      _refresh(this)
      self
    end

reload() click to toggle source

Alias of refresh, but not aliased directly to make overriding in a plugin easier.

    # File lib/sequel/model/base.rb, line 1505
    def reload
      refresh
    end

save(opts=OPTS) click to toggle source

Creates or updates the record, after making sure the record is valid and before hooks execute successfully. Fails if:

- the record is not valid, or

- before_save returns false, or

- the record is new and before_create returns false, or

- the record is not new and before_update returns false.

If `save` fails and either raise_on_save_failure or the :raise_on_failure option is true, it raises ValidationFailed or HookFailed. Otherwise it returns nil.

If it succeeds, it returns self.

You can provide an optional list of columns to update, in which case it only updates those columns, or a options hash.

Takes the following options:

:changed | save all changed columns, instead of all columns or the columns given
:columns | array of specific columns that should be saved.
:raise_on_failure | set to true or false to override the current `raise_on_save_failure` setting
:server | set the server/shard on the object before saving, and use that server/shard in any transaction.
:transaction | set to true or false to override the current `use_transactions` setting
:validate | set to false to skip validation

    # File lib/sequel/model/base.rb, line 1537
    def save(opts=OPTS)
      raise Sequel::Error, "can't save frozen object" if frozen?
      set_server(opts[:server]) if opts[:server]
      _before_validation
      if opts[:validate] != false
        unless checked_save_failure(opts){_valid?(true, opts)}
          raise(ValidationFailed.new(self)) if raise_on_failure?(opts)
          return
        end
      end
      checked_save_failure(opts){checked_transaction(opts){_save(opts)}}
    end

save_changes(opts=OPTS) click to toggle source

Saves only changed columns if the object has been modified. If the object has not been modified, returns nil. If unable to save, returns false unless `raise_on_save_failure` is true.

    a = Artist[1]
    a.save_changes # => nil
    a.name = 'Jim'
    a.save_changes # UPDATE artists SET name = 'Bob' WHERE (id = 1)
    # => #<Artist {:id=>1, :name=>'Jim', ...}

    # File lib/sequel/model/base.rb, line 1559
    def save_changes(opts=OPTS)
      save(Hash[opts].merge!(:changed=>true)) || false if modified?
    end

set(hash) click to toggle source

Updates the instance with the supplied values with support for virtual attributes, raising an exception if a value is used that doesn't have a setter method (or ignoring it if `strict_param_setting = false`). Does not save the record.

    artist.set(:name=>'Jim')
    artist.name # => 'Jim'

    # File lib/sequel/model/base.rb, line 1570
    def set(hash)
      set_restricted(hash, :default)
    end

set_all(hash) click to toggle source

Set all values using the entries in the hash, ignoring any setting of allowed_columns in the model.

    Artist.set_allowed_columns(:num_albums)
    artist.set_all(:name=>'Jim')
    artist.name # => 'Jim'

    # File lib/sequel/model/base.rb, line 1580
    def set_all(hash)
      set_restricted(hash, :all)
    end

set_fields(hash, fields, opts=nil) click to toggle source

For each of the fields in the given array `fields`, call the setter method with the value of that `hash` entry for the field. Returns self.

You can provide an options hash, with the following options currently respected:

:missing | Can be set to :skip to skip missing entries or :raise to raise an Error for missing entries. The default behavior is not to check for missing entries, in which case the default value is used. To be friendly with most web frameworks, the missing check will also check for the string version of the argument in the hash if given a symbol.

Examples:

    artist.set_fields({:name=>'Jim'}, [:name])
    artist.name # => 'Jim'

    artist.set_fields({:hometown=>'LA'}, [:name])
    artist.name # => nil
    artist.hometown # => 'Sac'

    artist.name # => 'Jim'
    artist.set_fields({}, [:name], :missing=>:skip)
    artist.name # => 'Jim'

    artist.name # => 'Jim'
    artist.set_fields({}, [:name], :missing=>:raise)
    # Sequel::Error raised

    # File lib/sequel/model/base.rb, line 1610
    def set_fields(hash, fields, opts=nil)
      opts = if opts
        Hash[model.default_set_fields_options].merge!(opts)
      else
        model.default_set_fields_options
      end

      case opts[:missing]
      when :skip
        fields.each do |f|
          if hash.has_key?(f)
            set_column_value("#{f}=", hash[f])
          elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
            set_column_value("#{sf}=", hash[sf])
          end
        end
      when :raise
        fields.each do |f|
          if hash.has_key?(f)
            set_column_value("#{f}=", hash[f])
          elsif f.is_a?(Symbol) && hash.has_key?(sf = f.to_s)
            set_column_value("#{sf}=", hash[sf])
          else
            raise(Sequel::Error, "missing field in hash: #{f.inspect} not in #{hash.inspect}")
          end
        end
      else
        fields.each{|f| set_column_value("#{f}=", hash[f])}
      end
      self
    end

set_only(hash, *only) click to toggle source

Set the values using the entries in the hash, only if the key is included in only. It may be a better idea to use `set_fields` instead of this method.

    artist.set_only({:name=>'Jim'}, :name)
    artist.name # => 'Jim'

    artist.set_only({:hometown=>'LA'}, :name) # Raise Error

    # File lib/sequel/model/base.rb, line 1650
    def set_only(hash, *only)
      set_restricted(hash, only.flatten)
    end

set_server(s) click to toggle source

Set the shard that this object is tied to. Returns self.

    # File lib/sequel/model/base.rb, line 1655
    def set_server(s)
      @server = s
      @this.opts[:server] = s if @this
      self
    end

singleton_method_added(meth) click to toggle source

Clear the setter_methods cache when a method is added

    # File lib/sequel/model/base.rb, line 1662
    def singleton_method_added(meth)
      @singleton_setter_added = true if meth.to_s =~ SETTER_METHOD_REGEXP
      super
    end

this() click to toggle source

Returns (naked) dataset that should return only this instance.

    Artist[1].this
    # SELECT * FROM artists WHERE (id = 1) LIMIT 1

    # File lib/sequel/model/base.rb, line 1671
    def this
      return @this if @this
      raise Error, "No dataset for model #{model}" unless ds = model.instance_dataset

      cond = if ds.joined_dataset?
        qualified_pk_hash
      else
        pk_hash
      end

      @this = use_server(ds.where(cond))
    end

update(hash) click to toggle source

Runs set with the passed hash and then runs save_changes.

    artist.update(:name=>'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)

    # File lib/sequel/model/base.rb, line 1687
    def update(hash)
      update_restricted(hash, :default)
    end

update_all(hash) click to toggle source

Update all values using the entries in the hash, ignoring any setting of `allowed_columns` in the model.

    Artist.set_allowed_columns(:num_albums)
    artist.update_all(:name=>'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)

    # File lib/sequel/model/base.rb, line 1696
    def update_all(hash)
      update_restricted(hash, :all)
    end

update_fields(hash, fields, opts=nil) click to toggle source

Update the instances values by calling `set_fields` with the arguments, then saves any changes to the record. Returns self.

    artist.update_fields({:name=>'Jim'}, [:name])
    # UPDATE artists SET name = 'Jim' WHERE (id = 1)

    artist.update_fields({:hometown=>'LA'}, [:name])
    # UPDATE artists SET name = NULL WHERE (id = 1)

    # File lib/sequel/model/base.rb, line 1708
    def update_fields(hash, fields, opts=nil)
      set_fields(hash, fields, opts)
      save_changes
    end

update_only(hash, *only) click to toggle source

Update the values using the entries in the hash, only if the key is included in only. It may be a better idea to use `update_fields` instead of this method.

    artist.update_only({:name=>'Jim'}, :name)
    # UPDATE artists SET name = 'Jim' WHERE (id = 1)

    artist.update_only({:hometown=>'LA'}, :name) # Raise Error

    # File lib/sequel/model/base.rb, line 1721
    def update_only(hash, *only)
      update_restricted(hash, only.flatten)
    end

use_prepared_statements_for?(type) click to toggle source

Whether prepared statements should be used for the given type of query (:insert, :insert_select, :refresh, :update, or :delete). True by default, can be overridden in other plugins to disallow prepared statements for specific types of queries.

    # File lib/sequel/plugins/prepared_statements.rb, line 8
    def use_prepared_statements_for?(type)
      true
    end

valid?(opts = OPTS) click to toggle source

Validates the object and returns true if no errors are reported.

    artist(:name=>'Valid').valid? # => true
    artist(:name=>'Invalid').valid? # => false
    artist.errors.full_messages # => ['name cannot be Invalid']

    # File lib/sequel/model/base.rb, line 1739
    def valid?(opts = OPTS)
      _before_validation
      _valid?(false, opts)
    end

validate() click to toggle source

Validates the object. If the object is invalid, errors should be added to the errors attribute. By default, does nothing, as all models are valid by default. See the "Model Validations" guide. for details about validation. Should not be called directly by user code, call `valid?` instead to check if an object is valid.

    # File lib/sequel/model/base.rb, line 1731
    def validate
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.