### Home Classes Methods

### In Files

- lib/sequel/adapters/utils/stored_procedures.rb
- lib/sequel/extensions/pagination.rb
- lib/sequel/extensions/null_dataset.rb
- lib/sequel/extensions/select_remove.rb
- lib/sequel/extensions/to_dot.rb
- lib/sequel/extensions/split_array_nil.rb
- lib/sequel/extensions/query.rb
- lib/sequel/extensions/columns_introspection.rb
- lib/sequel/extensions/pretty_table.rb
- lib/sequel/dataset.rb
- lib/sequel/dataset/misc.rb
- lib/sequel/dataset/graph.rb
- lib/sequel/dataset/mutation.rb
- lib/sequel/dataset/actions.rb
- lib/sequel/dataset/prepared_statements.rb
- lib/sequel/dataset/sql.rb
- lib/sequel/dataset/features.rb
- lib/sequel/dataset/query.rb

### Parent

Object

### Sections

- 1 - Methods that return modified datasets
- 2 - Methods that execute code on the database
- 3 - User Methods relating to SQL Creation
- 4 - Methods that describe what the dataset supports
- 5 - Methods related to dataset graphing
- 6 - Miscellaneous methods
- 7 - Mutation methods
- 8 - Methods related to prepared statements or bound variables
- 9 - Internal Methods relating to SQL Creation

### Namespace

- MODULE Sequel::Dataset::ArgumentMapper
- MODULE Sequel::Dataset::DeprecateModifyHash
- MODULE Sequel::Dataset::NullDataset
- MODULE Sequel::Dataset::Nullifiable
- MODULE Sequel::Dataset::Pagination
- MODULE Sequel::Dataset::PreparedStatementMethods
- MODULE Sequel::Dataset::SplitArrayNil
- MODULE Sequel::Dataset::StoredProcedureMethods
- MODULE Sequel::Dataset::StoredProcedures
- MODULE Sequel::Dataset::UnnumberedArgumentMapper
- CLASS Sequel::Dataset::Query

### Methods

- ::clause_methods
- ::def_append_methods
- ::def_mutation_method
- ::introspect_all_columns
- ::new
- ::register_extension
- #<<
- #==
- #[]
- #[]=
- #_import
- #_insert_sql
- #_select_map_multiple
- #_select_map_single
- #_update_sql
- #add_graph_aliases
- #aliased_expression_sql_append
- #all
- #and
- #array_sql_append
- #avg
- #bind
- #boolean_constant_sql_append
- #call
- #case_expression_sql_append
- #cast_sql_append
- #clone
- #column_all_sql_append
- #columns
- #columns!
- #columns_without_introspection
- #complex_expression_sql_append
- #compound_clone
- #compound_from_self
- #constant_sql_append
- #count
- #db=
- #delayed_evaluation_sql_append
- #delete
- #delete_sql
- #distinct
- #each
- #each_page
- #each_server
- #empty?
- #emulated_function_sql_append
- #eql?
- #escape_like
- #except
- #exclude
- #exclude_having
- #exclude_where
- #exists
- #extension
- #extension!
- #fetch_rows
- #filter
- #first
- #first!
- #first_source
- #first_source_alias
- #first_source_table
- #for_update
- #from
- #from_self
- #from_self!
- #function_sql_append
- #get
- #graph
- #grep
- #group
- #group_and_count
- #group_by
- #group_cube
- #group_rollup
- #hash
- #having
- #identifier_input_method
- #identifier_output_method
- #import
- #insert
- #insert_multiple
- #insert_sql
- #inspect
- #intersect
- #interval
- #invert
- #join
- #join_clause_sql_append
- #join_on_clause_sql_append
- #join_table
- #join_using_clause_sql_append
- #last
- #limit
- #literal_append
- #lock_style
- #map
- #max
- #min
- #multi_insert
- #multi_insert_sql
- #naked
- #naked!
- #negative_boolean_constant_sql_append
- #nullify
- #nullify!
- #options_overlap
- #opts=
- #or
- #order
- #order_append
- #order_by
- #order_more
- #order_prepend
- #ordered_expression_sql_append
- #paged_each
- #paginate
- #placeholder_literal_string_sql_append
- #prepare
- #print
- #provides_accurate_rows_matched?
- #qualified_identifier_sql_append
- #qualify
- #qualify_to
- #qualify_to_first_source
- #query
- #quote_identifier_append
- #quote_identifiers?
- #quote_schema_table_append
- #quoted_identifier_append
- #range
- #recursive_cte_requires_column_aliases?
- #requires_placeholder_type_specifiers?
- #requires_sql_standard_datetimes?
- #returning
- #reverse
- #reverse_order
- #row_number_column
- #schema_and_table
- #select
- #select_all
- #select_append
- #select_group
- #select_hash
- #select_hash_groups
- #select_map
- #select_more
- #select_order_map
- #select_remove
- #select_sql
- #server
- #set
- #set_defaults
- #set_graph_aliases
- #set_overrides
- #simple_select_all?
- #single_record
- #single_value
- #split_alias
- #split_qualifiers
- #sql
- #subscript_sql_append
- #sum
- #supports_cte?
- #supports_cte_in_subqueries?
- #supports_distinct_on?
- #supports_group_cube?
- #supports_group_rollup?
- #supports_insert_select?
- #supports_intersect_except?
- #supports_intersect_except_all?
- #supports_is_true?
- #supports_join_using?
- #supports_modifying_joins?
- #supports_multiple_column_in?
- #supports_ordered_distinct_on?
- #supports_regexp?
- #supports_returning?
- #supports_select_all_and_column?
- #supports_timestamp_timezones?
- #supports_timestamp_usecs?
- #supports_where_true?
- #supports_window_functions?
- #to_csv
- #to_dot
- #to_hash
- #to_hash_groups
- #to_prepared_statement
- #truncate
- #truncate_sql
- #unbind
- #unfiltered
- #ungraphed
- #ungrouped
- #union
- #unlimited
- #unordered
- #unused_table_alias
- #update
- #update_sql
- #where
- #window_function_sql_append
- #window_sql_append
- #with
- #with_recursive
- #with_sql
- #with_sql_delete

### Included Modules

- Sequel::ColumnsIntrospection
- Enumerable
- Sequel::SQL::AliasMethods
- Sequel::SQL::BooleanMethods
- Sequel::SQL::CastMethods
- Sequel::SQL::ComplexExpressionMethods
- Sequel::SQL::InequalityMethods
- Sequel::SQL::NumericMethods
- Sequel::SQL::OrderMethods
- Sequel::SQL::StringMethods

### 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
- mass_assignment.rdoc
- migration.rdoc
- model_hooks.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
- 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::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::ResetIdentifierMangling
- Sequel::Database::SplitAlterTable
- Sequel::DatabaseConnectionError
- Sequel::DatabaseDisconnectError
- Sequel::DatabaseError
- Sequel::DatabaseQuery
- Sequel::Dataset
- Sequel::Dataset::ArgumentMapper
- Sequel::Dataset::DeprecateModifyHash
- Sequel::Dataset::NullDataset
- Sequel::Dataset::Nullifiable
- Sequel::Dataset::Pagination
- Sequel::Dataset::PreparedStatementMethods
- Sequel::Dataset::Query
- 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::EvalInspect
- 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::Dataset::TYPE_TRANSLATOR
- 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::Postgres::Dataset::PGArrayConverter
- 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::Transactions
- Sequel::LiteralString
- Sequel::LooserTypecasting
- Sequel::MSSQL
- Sequel::MSSQL::DatabaseMethods
- Sequel::MSSQL::DatasetMethods
- Sequel::Metaprogramming
- Sequel::Migration
- Sequel::MigrationAlterTableReverser
- Sequel::MigrationDSL
- Sequel::MigrationReverser
- Sequel::Migrator
- Sequel::Migrator::Error
- Sequel::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::OneToManyAssociationReflection
- Sequel::Model::Associations::OneToOneAssociationReflection
- 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::NotImplemented
- 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::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::AssociationAutoreloading::ClassMethods
- Sequel::Plugins::AssociationAutoreloading::InstanceMethods
- 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::BooleanReaders
- Sequel::Plugins::BooleanReaders::ClassMethods
- Sequel::Plugins::Caching
- Sequel::Plugins::Caching::ClassMethods
- Sequel::Plugins::Caching::InstanceMethods
- Sequel::Plugins::ClassTableInheritance
- Sequel::Plugins::ClassTableInheritance::ClassMethods
- Sequel::Plugins::ClassTableInheritance::InstanceMethods
- Sequel::Plugins::Composition
- Sequel::Plugins::Composition::ClassMethods
- Sequel::Plugins::Composition::InstanceMethods
- Sequel::Plugins::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::IdentityMap
- Sequel::Plugins::IdentityMap::ClassMethods
- Sequel::Plugins::IdentityMap::InstanceMethods
- Sequel::Plugins::InputTransformer
- Sequel::Plugins::InputTransformer::ClassMethods
- Sequel::Plugins::InputTransformer::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::ManyToOnePkLookup
- Sequel::Plugins::ManyToOnePkLookup::ClassMethods
- Sequel::Plugins::ManyToOnePkLookup::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::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::ClassMethods
- Sequel::Plugins::PreparedStatementsAssociations::InstanceMethods
- Sequel::Plugins::PreparedStatementsSafe
- Sequel::Plugins::PreparedStatementsSafe::ClassMethods
- Sequel::Plugins::PreparedStatementsSafe::InstanceMethods
- Sequel::Plugins::PreparedStatementsWithPk
- Sequel::Plugins::PreparedStatementsWithPk::ClassMethods
- Sequel::Plugins::PreparedStatementsWithPk::DatasetMethods
- Sequel::Plugins::RcteTree
- Sequel::Plugins::Schema
- Sequel::Plugins::Schema::ClassMethods
- Sequel::Plugins::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::StaticCache
- Sequel::Plugins::StaticCache::ClassMethods
- Sequel::Plugins::StringStripper
- Sequel::Plugins::StringStripper::ClassMethods
- Sequel::Plugins::Subclasses
- Sequel::Plugins::Subclasses::ClassMethods
- Sequel::Plugins::TacticalEagerLoading
- Sequel::Plugins::TacticalEagerLoading::DatasetMethods
- Sequel::Plugins::TacticalEagerLoading::InstanceMethods
- Sequel::Plugins::Timestamps
- Sequel::Plugins::Timestamps::ClassMethods
- Sequel::Plugins::Timestamps::InstanceMethods
- Sequel::Plugins::Touch
- Sequel::Plugins::Touch::ClassMethods
- Sequel::Plugins::Touch::InstanceMethods
- Sequel::Plugins::Tree
- Sequel::Plugins::Tree::ClassMethods
- Sequel::Plugins::Tree::InstanceMethods
- Sequel::Plugins::Tree::SingleRoot
- Sequel::Plugins::Tree::SingleRoot::ClassMethods
- Sequel::Plugins::Tree::SingleRoot::InstanceMethods
- Sequel::Plugins::Tree::TreeMultipleRootError
- Sequel::Plugins::TypecastOnLoad
- Sequel::Plugins::TypecastOnLoad::ClassMethods
- Sequel::Plugins::TypecastOnLoad::InstanceMethods
- Sequel::Plugins::UnlimitedUpdate
- Sequel::Plugins::UnlimitedUpdate::InstanceMethods
- 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::AutoParameterize
- Sequel::Postgres::AutoParameterize::DatabaseMethods
- Sequel::Postgres::AutoParameterize::DatasetMethods
- Sequel::Postgres::AutoParameterize::StringWithArray
- 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::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::JSONDatabaseMethods
- Sequel::Postgres::JSONHash
- 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::StatementCache
- Sequel::Postgres::StatementCache::AdapterMethods
- Sequel::Postgres::StatementCache::DatabaseMethods
- Sequel::Postgres::StatementCache::Statement
- Sequel::Postgres::StatementCache::StatementCache
- 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::EmulatedFunction
- 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::NoBooleanInputMethods
- 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::SQLArray
- 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::WindowFunction
- 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::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::Dataset

A dataset represents an SQL query, or more generally, an abstract set of rows in the database. Datasets can be used to create, retrieve, update and delete records.

Query results are always retrieved on demand, so a dataset can be kept around and reused indefinitely (datasets never cache results):

    my_posts = DB[:posts].filter(:author => 'david') # no records are retrieved
    my_posts.all # records are retrieved
    my_posts.all # records are retrieved again

Most dataset methods return modified copies of the dataset (functional style), so you can reuse different datasets to access data:

    posts = DB[:posts]
    davids_posts = posts.filter(:author => 'david')
    old_posts = posts.filter('stamp < ?', Date.today - 7)
    davids_old_posts = davids_posts.filter('stamp < ?', Date.today - 7)

Datasets are Enumerable objects, so they can be manipulated using any of the Enumerable methods, such as map, inject, etc.

For more information, see the "Dataset Basics" guide.

### Public Class Methods

introspect_all_columns() click to toggle source

Enable column introspection for every dataset.

    # File lib/sequel/extensions/columns_introspection.rb, line 84
    def self.introspect_all_columns
      Sequel::Deprecation.deprecate('Sequel::Dataset.introspect_all_columns', "Please use Database.extension :columns_introspection to load the extension into all databases")
      include ColumnsIntrospection
      remove_method(:columns) if instance_methods(false).map{|x| x.to_s}.include?('columns')
    end

### Public Instance Methods

each_page(page_size) click to toggle source

Yields a paginated dataset for each page and returns the receiver. Does a count to find the total number of records for this dataset.

    # File lib/sequel/extensions/pagination.rb, line 36
    def each_page(page_size)
      Sequel::Deprecation.deprecate('Loading the pagination extension globally', "Please use Database/Dataset#extension to load the extension into this dataset") unless is_a?(DatasetPagination)
      raise(Error, "You cannot paginate a dataset that already has a limit") if @opts[:limit]
      record_count = count
      total_pages = (record_count / page_size.to_f).ceil
      (1..total_pages).each{|page_no| yield paginate(page_no, page_size, record_count)}
      self
    end

nullify() click to toggle source

Return a cloned nullified dataset.

    # File lib/sequel/extensions/null_dataset.rb, line 90
    def nullify
      clone.nullify!
    end

nullify!() click to toggle source

Nullify the current dataset

    # File lib/sequel/extensions/null_dataset.rb, line 95
    def nullify!
      Sequel::Deprecation.deprecate('Loading the null_dataset extension globally', "Please use Database/Dataset#extension to load the extension into this dataset") unless is_a?(Nullifiable)
      extend NullDataset
    end

paginate(page_no, page_size, record_count=nil) click to toggle source

Returns a paginated dataset. The returned dataset is limited to the page size at the correct offset, and extended with the Pagination module. If a record count is not provided, does a count of total number of records for this dataset.

    # File lib/sequel/extensions/pagination.rb, line 26
    def paginate(page_no, page_size, record_count=nil)
      Sequel::Deprecation.deprecate('Loading the pagination extension globally', "Please use Database/Dataset#extension to load the extension into this dataset") unless is_a?(DatasetPagination)
      raise(Error, "You cannot paginate a dataset that already has a limit") if @opts[:limit]
      paginated = limit(page_size, (page_no - 1) * page_size)
      paginated.extend(Pagination)
      paginated.set_pagination_info(page_no, page_size, record_count || count)
    end

print(*cols) click to toggle source

Pretty prints the records in the dataset as plain-text table.

    # File lib/sequel/extensions/pretty_table.rb, line 30
    def print(*cols)
      Sequel::Deprecation.deprecate('Loading the pretty_table extension globally', "Please use Database/Dataset#extension to load the extension into this dataset") unless is_a?(DatasetPrinter)
      ds = naked
      rows = ds.all
      Sequel::PrettyTable.print(rows, cols.empty? ? ds.columns : cols)
    end

query(&block) click to toggle source

Translates a query block into a dataset. Query blocks are an alternative to Sequel's usual method chaining, by using instance_eval with a proxy object:

    dataset = DB[:items].query do
      select :x, :y, :z
      filter{(x > 1) & (y > 2)}
      reverse :z
    end

Which is the same as:

    dataset = DB[:items].select(:x, :y, :z).filter{(x > 1) & (y > 2)}.reverse(:z)

    # File lib/sequel/extensions/query.rb, line 47
    def query(&block)
      Sequel::Deprecation.deprecate('Loading the query extension globally', "Please use Database/Dataset#extension to load the extension into this dataset") unless is_a?(DatasetQuery)
      query = Query.new(self)
      query.instance_eval(&block)
      query.dataset
    end

select_remove(*cols) click to toggle source

Remove columns from the list of selected columns. If any of the currently selected columns use expressions/aliases, this will remove selected columns with the given aliases. It will also remove entries from the selection that match exactly:

    # Assume columns a, b, and c in items table
    DB[:items] # SELECT * FROM items
    DB[:items].select_remove(:c) # SELECT a, b FROM items
    DB[:items].select(:a, :b___c, :c___b).select_remove(:c) # SELECT a, c AS b FROM items
    DB[:items].select(:a, :b___c, :c___b).select_remove(:c___b) # SELECT a, b AS c FROM items

Note that there are a few cases where this method may not work correctly:

- This dataset joins multiple tables and does not have an existing explicit selection. In this case, the code will currently use unqualified column names for all columns the dataset returns, except for the columns given.

- This dataset has an existing explicit selection containing an item that returns multiple database columns (e.g. Sequel.expr(:table).*, Sequel.lit('column1, column2')). In this case, the behavior is undefined and this method should not be used.

There may be other cases where this method does not work correctly, use it with caution.

    # File lib/sequel/extensions/select_remove.rb, line 40
    def select_remove(*cols)
      Sequel::Deprecation.deprecate('Loading the select_remove extension globally', "Please use Database/Dataset#extension to load the extension into this dataset") unless is_a?(SelectRemove)
      if (sel = @opts[:select]) && !sel.empty?
        select(*(columns.zip(sel).reject{|c, s| cols.include?(c)}.map{|c, s| s} - cols))
      else
        select(*(columns - cols))
      end
    end

to_dot() click to toggle source

Return a string that can be processed by the `dot` program (included with graphviz) in order to see a visualization of the dataset's abstract syntax tree.

    # File lib/sequel/extensions/to_dot.rb, line 152
    def to_dot
      Sequel::Deprecation.deprecate('Loading the to_dot extension globally', "Please use Database/Dataset#extension to load the extension into this dataset") unless is_a?(ToDot::DatasetMethods)
      ToDot.output(self)
    end

## 1 - Methods that return modified datasets ↑ top

These methods all return modified copies of the receiver.

### Constants

COLUMN_CHANGE_OPTS

  The dataset options that require the removal of cached columns if changed.

CONDITIONED_JOIN_TYPES

  These symbols have _join methods created (e.g. inner_join) that call join_table with the symbol, passing along the arguments and block from the method call.

EXTENSIONS

  Hash of extension name symbols to callable objects to load the extension into the Dataset object (usually by extending it with a module defined in the extension).

JOIN_METHODS

  All methods that return modified datasets with a joined table added.

NON_SQL_OPTIONS

  Which options don't affect the SQL generation. Used by simple_select_all? to determine if this is a simple SELECT * FROM table.

QUERY_METHODS

  Methods that return modified datasets

UNCONDITIONED_JOIN_TYPES

  These symbols have _join methods created (e.g. natural_join) that call join_table with the symbol. They only accept a single table argument which is passed to join_table, and they raise an error if called with a block.

### Public Class Methods

register_extension(ext, mod=nil, &block) click to toggle source

Register an extension callback for Dataset objects. ext should be the extension name symbol, and mod should either be a Module that the dataset is extended with, or a callable object called with the database object. If mod is not provided, a block can be provided and is treated as the mod object.

If mod is a module, this also registers a Database extension that will extend all of the database's datasets.

    # File lib/sequel/dataset/query.rb, line 54
    def self.register_extension(ext, mod=nil, &block)
      if mod
        raise(Error, "cannot provide both mod and block to Dataset.register_extension") if block
        if mod.is_a?(Module)
          block = proc{|ds| ds.extend(mod)}
          Sequel::Database.register_extension(ext){|db| db.extend_datasets(mod)}
        else
          block = mod
        end
      end
      Sequel.synchronize{EXTENSIONS[ext] = block}
    end

### Public Instance Methods

and(*cond, &block) click to toggle source

Adds an further filter to an existing filter using AND. If no filter exists an error is raised. This method is identical to filter except it expects an existing filter.

    DB[:table].filter(:a).and(:b) # SELECT * FROM table WHERE a AND b

    # File lib/sequel/dataset/query.rb, line 72
    def and(*cond, &block)
      unless @opts[:having] || @opts[:where]
        Sequel::Deprecation.deprecate('Dataset#and will no longer raise for an unfilered dataset starting in Sequel 4.')
        raise(InvalidOperation, "No existing filter found.")
      end
      if @opts[:having]
        Sequel::Deprecation.deprecate('Dataset#and will no longer modify the HAVING clause starting in Sequel 4.  Switch to using Dataset#having or use the filter_having extension.')
        having(*cond, &block)
      else
        where(*cond, &block)
      end
    end

clone(opts = nil) click to toggle source

Returns a new clone of the dataset with with the given options merged. If the options changed include options in COLUMN_CHANGE_OPTS, the cached columns are deleted. This method should generally not be called directly by user code.

    # File lib/sequel/dataset/query.rb, line 89
    def clone(opts = nil)
      c = super()
      if opts
        c.instance_variable_set(:@opts, @opts.merge(opts))
        c.instance_variable_set(:@columns, nil) if @columns && !opts.each_key{|o| break if COLUMN_CHANGE_OPTS.include?(o)}
      else
        c.instance_variable_set(:@opts, @opts.dup)
      end
      c
    end

distinct(*args) click to toggle source

Returns a copy of the dataset with the SQL DISTINCT clause. The DISTINCT clause is used to remove duplicate rows from the output. If arguments are provided, uses a DISTINCT ON clause, in which case it will only be distinct on those columns, instead of all returned columns. Raises an error if arguments are given and DISTINCT ON is not supported.

    DB[:items].distinct # SQL: SELECT DISTINCT * FROM items
    DB[:items].order(:id).distinct(:id) # SQL: SELECT DISTINCT ON (id) * FROM items ORDER BY id

    # File lib/sequel/dataset/query.rb, line 109
    def distinct(*args)
      raise(InvalidOperation, "DISTINCT ON not supported") if !args.empty? && !supports_distinct_on?
      clone(:distinct => args)
    end

except(dataset, opts={}) click to toggle source

Adds an EXCEPT clause using a second dataset object. An EXCEPT compound dataset returns all rows in the current dataset that are not in the given dataset. Raises an `InvalidOperation` if the operation is not supported. Options:

:alias | Use the given value as the from_self alias
:all | Set to true to use EXCEPT ALL instead of EXCEPT, so duplicate rows can occur
:from_self | Set to false to not wrap the returned dataset in a from_self, use with care.

    DB[:items].except(DB[:other_items])
    # SELECT * FROM (SELECT * FROM items EXCEPT SELECT * FROM other_items) AS t1

    DB[:items].except(DB[:other_items], :all=>true, :from_self=>false)
    # SELECT * FROM items EXCEPT ALL SELECT * FROM other_items

    DB[:items].except(DB[:other_items], :alias=>:i)
    # SELECT * FROM (SELECT * FROM items EXCEPT SELECT * FROM other_items) AS i

    # File lib/sequel/dataset/query.rb, line 131
    def except(dataset, opts={})
      unless opts.is_a?(Hash)
        Sequel::Deprecation.deprecate('Passing a non-hash as the second argument to Dataset#except', "Please switch to an options hash with the :all option")
        opts = {:all=>opts}
      end
      raise(InvalidOperation, "EXCEPT not supported") unless supports_intersect_except?
      raise(InvalidOperation, "EXCEPT ALL not supported") if opts[:all] && !supports_intersect_except_all?
      compound_clone(:except, dataset, opts)
    end

exclude(*cond, &block) click to toggle source

Performs the inverse of Dataset#filter. Note that if you have multiple filter conditions, this is not the same as a negation of all conditions.

    DB[:items].exclude(:category => 'software')
    # SELECT * FROM items WHERE (category != 'software')

    DB[:items].exclude(:category => 'software', :id=>3)
    # SELECT * FROM items WHERE ((category != 'software') OR (id != 3))

    # File lib/sequel/dataset/query.rb, line 149
    def exclude(*cond, &block)
      Sequel::Deprecation.deprecate('Dataset#exclude will no longer modify the HAVING clause starting in Sequel 4.  Switch to using Dataset#exclude_having or use the filter_having extension.') if @opts[:having]
      _filter_or_exclude(true, @opts[:having] ? :having : :where, *cond, &block)
    end

exclude_having(*cond, &block) click to toggle source

Inverts the given conditions and adds them to the HAVING clause.

    DB[:items].select_group(:name).exclude_having{count(name) < 2}
    # SELECT name FROM items GROUP BY name HAVING (count(name) >= 2)

    # File lib/sequel/dataset/query.rb, line 158
    def exclude_having(*cond, &block)
      _filter_or_exclude(true, :having, *cond, &block)
    end

exclude_where(*cond, &block) click to toggle source

Inverts the given conditions and adds them to the WHERE clause.

    DB[:items].select_group(:name).exclude_where(:category => 'software')
    # SELECT * FROM items WHERE (category != 'software')

    DB[:items].select_group(:name).
      exclude_having{count(name) < 2}.
      exclude_where(:category => 'software')
    # SELECT name FROM items WHERE (category != 'software')
    # GROUP BY name HAVING (count(name) >= 2)

    # File lib/sequel/dataset/query.rb, line 172
    def exclude_where(*cond, &block)
      _filter_or_exclude(true, :where, *cond, &block)
    end

extension(*exts) click to toggle source

Return a clone of the dataset loaded with the extensions, see extension!.

    # File lib/sequel/dataset/query.rb, line 177
    def extension(*exts)
      clone.extension!(*exts)
    end

filter(*cond, &block) click to toggle source

Returns a copy of the dataset with the given conditions imposed upon it. If the query already has a HAVING clause, then the conditions are imposed in the HAVING clause. If not, then they are imposed in the WHERE clause.

filter accepts the following argument types:

- Hash - list of equality/inclusion expressions

- Array - depends:

  - If first member is a string, assumes the rest of the arguments are parameters and interpolates them into the string.

  - If all members are arrays of length two, treats the same way as a hash, except it allows for duplicate keys to be specified.

  - Otherwise, treats each argument as a separate condition.

- String - taken literally

- Symbol - taken as a boolean column argument (e.g. WHERE active)

- Sequel::SQL::BooleanExpression - an existing condition expression, probably created using the Sequel expression filter DSL.

filter also takes a block, which should return one of the above argument types, and is treated the same way. This block yields a virtual row object, which is easy to use to create identifiers and functions. For more details on the virtual row support, see the "Virtual Rows" guide

If both a block and regular argument are provided, they get ANDed together.

Examples:

    DB[:items].filter(:id => 3)
    # SELECT * FROM items WHERE (id = 3)

    DB[:items].filter('price < ?', 100)
    # SELECT * FROM items WHERE price < 100

    DB[:items].filter([[:id, [1,2,3]], [:id, 0..10]])
    # SELECT * FROM items WHERE ((id IN (1, 2, 3)) AND ((id >= 0) AND (id <= 10)))

    DB[:items].filter('price < 100')
    # SELECT * FROM items WHERE price < 100

    DB[:items].filter(:active)
    # SELECT * FROM items WHERE :active

    DB[:items].filter{price < 100}
    # SELECT * FROM items WHERE (price < 100)

Multiple filter calls can be chained for scoping:

    software = dataset.filter(:category => 'software').filter{price < 100}
    # SELECT * FROM items WHERE ((category = 'software') AND (price < 100))

See the the "Dataset Filtering" guide for more examples and details.

    # File lib/sequel/dataset/query.rb, line 233
    def filter(*cond, &block)
      Sequel::Deprecation.deprecate('Dataset#filter will no longer modify the HAVING clause starting in Sequel 4.  Switch to using Dataset#having or use the filter_having extension.') if @opts[:having]
      _filter(@opts[:having] ? :having : :where, *cond, &block)
    end

for_update() click to toggle source

Returns a cloned dataset with a :update lock style.

    DB[:table].for_update # SELECT * FROM table FOR UPDATE

    # File lib/sequel/dataset/query.rb, line 241
    def for_update
      lock_style(:update)
    end

from(*source) click to toggle source

Returns a copy of the dataset with the source changed. If no source is given, removes all tables. If multiple sources are given, it is the same as using a CROSS JOIN (cartesian product) between all tables.

    DB[:items].from # SQL: SELECT *
    DB[:items].from(:blah) # SQL: SELECT * FROM blah
    DB[:items].from(:blah, :foo) # SQL: SELECT * FROM blah, foo

    # File lib/sequel/dataset/query.rb, line 252
    def from(*source)
      table_alias_num = 0
      sources = []
      ctes = nil
      source.each do |s|
        case s
        when Hash
          Sequel::Deprecation.deprecate('Dataset#from will no longer treat an input hash as an alias specifier.  Switch to aliasing using Sequel.as or use the hash_aliases extension.')
          s.each{|k,v| sources << SQL::AliasedExpression.new(k,v)}
        when Dataset
          if hoist_cte?(s)
            ctes ||= []
            ctes += s.opts[:with]
            s = s.clone(:with=>nil)
          end
          sources << SQL::AliasedExpression.new(s, dataset_alias(table_alias_num+=1))
        when Symbol
          sch, table, aliaz = split_symbol(s)
          if aliaz
            s = sch ? SQL::QualifiedIdentifier.new(sch, table) : SQL::Identifier.new(table)
            sources << SQL::AliasedExpression.new(s, aliaz.to_sym)
          else
            sources << s
          end
        else
          sources << s
        end
      end
      o = {:from=>sources.empty? ? nil : sources}
      o[:with] = (opts[:with] || []) + ctes if ctes
      o[:num_dataset_sources] = table_alias_num if table_alias_num > 0
      clone(o)
    end

from_self(opts={}) click to toggle source

Returns a dataset selecting from the current dataset. Supplying the :alias option controls the alias of the result.

    ds = DB[:items].order(:name).select(:id, :name)
    # SELECT id,name FROM items ORDER BY name

    ds.from_self
    # SELECT * FROM (SELECT id, name FROM items ORDER BY name) AS t1

    ds.from_self(:alias=>:foo)
    # SELECT * FROM (SELECT id, name FROM items ORDER BY name) AS foo

    # File lib/sequel/dataset/query.rb, line 297
    def from_self(opts={})
      fs = {}
      @opts.keys.each{|k| fs[k] = nil unless NON_SQL_OPTIONS.include?(k)}
      clone(fs).from(opts[:alias] ? as(opts[:alias]) : self)
    end

grep(columns, patterns, opts={}) click to toggle source

Match any of the columns to any of the patterns. The terms can be strings (which use LIKE) or regular expressions (which are only supported on MySQL and PostgreSQL). Note that the total number of pattern matches will be Array(columns).length * Array(terms).length, which could cause performance issues.

Options (all are boolean):

:all_columns | All columns must be matched to any of the given patterns.
:all_patterns | All patterns must match at least one of the columns.
:case_insensitive | Use a case insensitive pattern match (the default is case sensitive if the database supports it).

If both :all_columns and :all_patterns are true, all columns must match all patterns.

Examples:

    dataset.grep(:a, '%test%')
    # SELECT * FROM items WHERE (a LIKE '%test%')

    dataset.grep([:a, :b], %w'%test% foo')
    # SELECT * FROM items WHERE ((a LIKE '%test%') OR (a LIKE 'foo') OR (b LIKE '%test%') OR (b LIKE 'foo'))

    dataset.grep([:a, :b], %w'%foo% %bar%', :all_patterns=>true)
    # SELECT * FROM a WHERE (((a LIKE '%foo%') OR (b LIKE '%foo%')) AND ((a LIKE '%bar%') OR (b LIKE '%bar%')))

    dataset.grep([:a, :b], %w'%foo% %bar%', :all_columns=>true)
    # SELECT * FROM a WHERE (((a LIKE '%foo%') OR (a LIKE '%bar%')) AND ((b LIKE '%foo%') OR (b LIKE '%bar%')))

    dataset.grep([:a, :b], %w'%foo% %bar%', :all_patterns=>true, :all_columns=>true)
    # SELECT * FROM a WHERE ((a LIKE '%foo%') AND (b LIKE '%foo%') AND (a LIKE '%bar%') AND (b LIKE '%bar%'))

    # File lib/sequel/dataset/query.rb, line 334
    def grep(columns, patterns, opts={})
      if opts[:all_patterns]
        conds = Array(patterns).map do |pat|
          SQL::BooleanExpression.new(opts[:all_columns] ? :AND : :OR, *Array(columns).map{|c| SQL::StringExpression.like(c, pat, opts)})
        end
        filter(SQL::BooleanExpression.new(opts[:all_patterns] ? :AND : :OR, *conds))
      else
        conds = Array(columns).map do |c|
          SQL::BooleanExpression.new(:OR, *Array(patterns).map{|pat| SQL::StringExpression.like(c, pat, opts)})
        end
        filter(SQL::BooleanExpression.new(opts[:all_columns] ? :AND : :OR, *conds))
      end
    end

group(*columns, &block) click to toggle source

Returns a copy of the dataset with the results grouped by the value of the given columns. If a block is given, it is treated as a virtual row block, similar to `filter`.

    DB[:items].group(:id) # SELECT * FROM items GROUP BY id
    DB[:items].group(:id, :name) # SELECT * FROM items GROUP BY id, name
    DB[:items].group{[a, sum(b)]} # SELECT * FROM items GROUP BY a, sum(b)

    # File lib/sequel/dataset/query.rb, line 355
    def group(*columns, &block)
      virtual_row_columns(columns, block)
      clone(:group => (columns.compact.empty? ? nil : columns))
    end

group_and_count(*columns, &block) click to toggle source

Returns a dataset grouped by the given column with count by group. Column aliases may be supplied, and will be included in the select clause. If a block is given, it is treated as a virtual row block, similar to `filter`.

Examples:

    DB[:items].group_and_count(:name).all
    # SELECT name, count(*) AS count FROM items GROUP BY name
    # => [{:name=>'a', :count=>1}, ...]

    DB[:items].group_and_count(:first_name, :last_name).all
    # SELECT first_name, last_name, count(*) AS count FROM items GROUP BY first_name, last_name
    # => [{:first_name=>'a', :last_name=>'b', :count=>1}, ...]

    DB[:items].group_and_count(:first_name___name).all
    # SELECT first_name AS name, count(*) AS count FROM items GROUP BY first_name
    # => [{:name=>'a', :count=>1}, ...]

    DB[:items].group_and_count{substr(first_name, 1, 1).as(initial)}.all
    # SELECT substr(first_name, 1, 1) AS initial, count(*) AS count FROM items GROUP BY substr(first_name, 1, 1)
    # => [{:initial=>'a', :count=>1}, ...]

    # File lib/sequel/dataset/query.rb, line 386
    def group_and_count(*columns, &block)
      select_group(*columns, &block).select_more(COUNT_OF_ALL_AS_COUNT)
    end

group_by(*columns, &block) click to toggle source

Alias of group

    # File lib/sequel/dataset/query.rb, line 361
    def group_by(*columns, &block)
      group(*columns, &block)
    end

group_cube() click to toggle source

Adds the appropriate CUBE syntax to GROUP BY.

    # File lib/sequel/dataset/query.rb, line 391
    def group_cube
      raise Error, "GROUP BY CUBE not supported on #{db.database_type}" unless supports_group_cube?
      clone(:group_options=>:cube)
    end

group_rollup() click to toggle source

Adds the appropriate ROLLUP syntax to GROUP BY.

    # File lib/sequel/dataset/query.rb, line 397
    def group_rollup
      raise Error, "GROUP BY ROLLUP not supported on #{db.database_type}" unless supports_group_rollup?
      clone(:group_options=>:rollup)
    end

having(*cond, &block) click to toggle source

Returns a copy of the dataset with the HAVING conditions changed. See filter for argument types.

    DB[:items].group(:sum).having(:sum=>10)
    # SELECT * FROM items GROUP BY sum HAVING (sum = 10)

    # File lib/sequel/dataset/query.rb, line 406
    def having(*cond, &block)
      _filter(:having, *cond, &block)
    end

intersect(dataset, opts={}) click to toggle source

Adds an INTERSECT clause using a second dataset object. An INTERSECT compound dataset returns all rows in both the current dataset and the given dataset. Raises an `InvalidOperation` if the operation is not supported. Options:

:alias | Use the given value as the from_self alias
:all | Set to true to use INTERSECT ALL instead of INTERSECT, so duplicate rows can occur
:from_self | Set to false to not wrap the returned dataset in a from_self, use with care.

    DB[:items].intersect(DB[:other_items])
    # SELECT * FROM (SELECT * FROM items INTERSECT SELECT * FROM other_items) AS t1

    DB[:items].intersect(DB[:other_items], :all=>true, :from_self=>false)
    # SELECT * FROM items INTERSECT ALL SELECT * FROM other_items

    DB[:items].intersect(DB[:other_items], :alias=>:i)
    # SELECT * FROM (SELECT * FROM items INTERSECT SELECT * FROM other_items) AS i

    # File lib/sequel/dataset/query.rb, line 427
    def intersect(dataset, opts={})
      unless opts.is_a?(Hash)
        Sequel::Deprecation.deprecate('Passing a non-hash as the second argument to Dataset#intersect', "Please switch to an options hash with the :all option")
        opts = {:all=>opts}
      end
      raise(InvalidOperation, "INTERSECT not supported") unless supports_intersect_except?
      raise(InvalidOperation, "INTERSECT ALL not supported") if opts[:all] && !supports_intersect_except_all?
      compound_clone(:intersect, dataset, opts)
    end

invert() click to toggle source

Inverts the current filter.

    DB[:items].filter(:category => 'software').invert
    # SELECT * FROM items WHERE (category != 'software')

    DB[:items].filter(:category => 'software', :id=>3).invert
    # SELECT * FROM items WHERE ((category != 'software') OR (id != 3))

    # File lib/sequel/dataset/query.rb, line 444
    def invert
      having, where = @opts[:having], @opts[:where]
      unless having || where
        Sequel::Deprecation.deprecate('Dataset#invert will no longer raise for an unfilered dataset starting in Sequel 4.')
        raise(Error, "No current filter")
      end
      o = {}
      o[:having] = SQL::BooleanExpression.invert(having) if having
      o[:where] = SQL::BooleanExpression.invert(where) if where
      clone(o)
    end

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

Alias of `inner_join`

    # File lib/sequel/dataset/query.rb, line 457
    def join(*args, &block)
      inner_join(*args, &block)
    end

join_table(type, table, expr=nil, options={}, &block) click to toggle source

Returns a joined dataset. Not usually called directly, users should use the appropriate join method (e.g. join, left_join, natural_join, cross_join) which fills in the `type` argument.

Takes the following arguments:

- type - The type of join to do (e.g. :inner)

- table - Depends on type:

  - Dataset - a subselect is performed with an alias of tN for some value of N

  - String, Symbol: table

- expr - specifies conditions, depends on type:

  - Hash, Array of two element arrays - Assumes key (1st arg) is column of joined table (unless already qualified), and value (2nd arg) is column of the last joined or primary table (or the :implicit_qualifier option). To specify multiple conditions on a single joined table column, you must use an array. Uses a JOIN with an ON clause.

  - Array - If all members of the array are symbols, considers them as columns and uses a JOIN with a USING clause. Most databases will remove duplicate columns from the result set if this is used.

  - nil - If a block is not given, doesn't use ON or USING, so the JOIN should be a NATURAL or CROSS join. If a block is given, uses an ON clause based on the block, see below.

  - Everything else - pretty much the same as a using the argument in a call to filter, so strings are considered literal, symbols specify boolean columns, and Sequel expressions can be used. Uses a JOIN with an ON clause.

- options - a hash of options, with any of the following keys:

  - :table_alias - the name of the table's alias when joining, necessary for joining to the same table more than once. No alias is used by default.

  - :implicit_qualifier - The name to use for qualifying implicit conditions. By default, the last joined or primary table is used.

  - :qualify - Can be set to false to not do any implicit qualification. Can be set to :deep to use the Qualifier AST Transformer, which will attempt to qualify subexpressions of the expression tree. Defaults to the value of default_join_table_qualification.

- block - The block argument should only be given if a JOIN with an ON clause is used, in which case it yields the table alias/name for the table currently being joined, the table alias/name for the last joined (or first table), and an array of previous SQL::JoinClause. Unlike `filter`, this block is not treated as a virtual row block.

Examples:

    DB[:a].join_table(:cross, :b)
    # SELECT * FROM a CROSS JOIN b

    DB[:a].join_table(:inner, DB[:b], :c=>d)
    # SELECT * FROM a INNER JOIN (SELECT * FROM b) AS t1 ON (t1.c = a.d)

    DB[:a].join_table(:left, :b___c, [:d])
    # SELECT * FROM a LEFT JOIN b AS c USING (d)

    DB[:a].natural_join(:b).join_table(:inner, :c) do |ta, jta, js|
      (Sequel.qualify(ta, :d) > Sequel.qualify(jta, :e)) & {Sequel.qualify(ta, :f)=>DB.from(js.first.table).select(:g)}
    end
    # SELECT * FROM a NATURAL JOIN b INNER JOIN c
    #   ON ((c.d > b.e) AND (c.f IN (SELECT g FROM b)))

    # File lib/sequel/dataset/query.rb, line 515
    def join_table(type, table, expr=nil, options={}, &block)
      if hoist_cte?(table)
        s, ds = hoist_cte(table)
        return s.join_table(type, ds, expr, options, &block)
      end

      using_join = expr.is_a?(Array) && !expr.empty? && expr.all?{|x| x.is_a?(Symbol)}
      if using_join && !supports_join_using?
        h = {}
        expr.each{|e| h[e] = e}
        return join_table(type, table, h, options)
      end

      case options
      when Hash
        table_alias = options[:table_alias]
        last_alias = options[:implicit_qualifier]
        qualify_type = options[:qualify]
      when Symbol, String, SQL::Identifier
        Sequel::Deprecation.deprecate('Passing a non-hash as the options hash to Dataset#join_table', "Please switch to an options hash with the :table_alias option")
        table_alias = options
        last_alias = nil
      else
        raise Error, "invalid options format for join_table: #{options.inspect}"
      end

      if table.is_a?(Dataset)
        if table_alias.nil?
          table_alias_num = (@opts[:num_dataset_sources] || 0) + 1
          table_alias = dataset_alias(table_alias_num)
        end
        table_name = table_alias
      else
        table, implicit_table_alias = split_alias(table)
        table_alias ||= implicit_table_alias
        table_name = table_alias || table
      end

      join = if expr.nil? and !block
        SQL::JoinClause.new(type, table, table_alias)
      elsif using_join
        raise(Sequel::Error, "can't use a block if providing an array of symbols as expr") if block
        SQL::JoinUsingClause.new(expr, type, table, table_alias)
      else
        last_alias ||= @opts[:last_joined_table] || first_source_alias
        if Sequel.condition_specifier?(expr)
          expr = expr.collect do |k, v|
            qualify_type = default_join_table_qualification if qualify_type.nil?
            case qualify_type
            when false
              nil # Do no qualification
            when :deep
              k = Sequel::Qualifier.new(self, table_name).transform(k)
              v = Sequel::Qualifier.new(self, last_alias).transform(v)
            else
              k = qualified_column_name(k, table_name) if k.is_a?(Symbol)
              v = qualified_column_name(v, last_alias) if v.is_a?(Symbol)
            end
            [k,v]
          end
          expr = SQL::BooleanExpression.from_value_pairs(expr)
        end
        if block
          expr2 = yield(table_name, last_alias, @opts[:join] || [])
          expr = expr ? SQL::BooleanExpression.new(:AND, expr, expr2) : expr2
        end
        SQL::JoinOnClause.new(expr, type, table, table_alias)
      end

      opts = {:join => (@opts[:join] || []) + [join], :last_joined_table => table_name}
      opts[:num_dataset_sources] = table_alias_num if table_alias_num
      clone(opts)
    end

limit(l, o = (no_offset = true; nil)) click to toggle source

If given an integer, the dataset will contain only the first l results. If given a range, it will contain only those at offsets within that range. If a second argument is given, it is used as an offset. To use an offset without a limit, pass nil as the first argument.

    DB[:items].limit(10) # SELECT * FROM items LIMIT 10
    DB[:items].limit(10, 20) # SELECT * FROM items LIMIT 10 OFFSET 20
    DB[:items].limit(10...20) # SELECT * FROM items LIMIT 10 OFFSET 10
    DB[:items].limit(10..20) # SELECT * FROM items LIMIT 11 OFFSET 10
    DB[:items].limit(nil, 20) # SELECT * FROM items OFFSET 20

    # File lib/sequel/dataset/query.rb, line 606
    def limit(l, o = (no_offset = true; nil))
      return from_self.limit(l, o) if @opts[:sql]

      if l.is_a?(Range)
        o = l.first
        l = l.last - l.first + (l.exclude_end? ? 0 : 1)
      end
      l = l.to_i if l.is_a?(String) && !l.is_a?(LiteralString)
      if l.is_a?(Integer)
        raise(Error, 'Limits must be greater than or equal to 1') unless l >= 1
      end
      opts = {:limit => l}
      if o
        o = o.to_i if o.is_a?(String) && !o.is_a?(LiteralString)
        if o.is_a?(Integer)
          raise(Error, 'Offsets must be greater than or equal to 0') unless o >= 0
        end
        opts[:offset] = o
      elsif !no_offset
        opts[:offset] = nil
      end
      clone(opts)
    end

lock_style(style) click to toggle source

Returns a cloned dataset with the given lock style. If style is a string, it will be used directly. You should never pass a string to this method that is derived from user input, as that can lead to SQL injection.

A symbol may be used for database independent locking behavior, but all supported symbols have separate methods (e.g. for_update).

    DB[:items].lock_style('FOR SHARE NOWAIT') # SELECT * FROM items FOR SHARE NOWAIT

    # File lib/sequel/dataset/query.rb, line 639
    def lock_style(style)
      clone(:lock => style)
    end

naked() click to toggle source

Returns a cloned dataset without a row_proc.

    ds = DB[:items]
    ds.row_proc = proc{|r| r.invert}
    ds.all # => [{2=>:id}]
    ds.naked.all # => [{:id=>2}]

    # File lib/sequel/dataset/query.rb, line 649
    def naked
      ds = clone
      ds.row_proc = nil
      ds
    end

or(*cond, &block) click to toggle source

Adds an alternate filter to an existing filter using OR. If no filter exists an `Error` is raised.

    DB[:items].filter(:a).or(:b) # SELECT * FROM items WHERE a OR b

    # File lib/sequel/dataset/query.rb, line 659
    def or(*cond, &block)
      clause = (@opts[:having] ? :having : :where)
      unless @opts[clause]
        Sequel::Deprecation.deprecate('Dataset#or will no longer raise for an unfilered dataset starting in Sequel 4.')
        raise(InvalidOperation, "No existing filter found.")
      end
      Sequel::Deprecation.deprecate('Dataset#or will no longer modify the HAVING clause starting in Sequel 4.  You can use the filter_having extension to continue to use the current behavior.') if clause == :having
      cond = cond.first if cond.size == 1
      if cond.respond_to?(:empty?) && cond.empty? && !block
        clone
      else
        clone(clause => SQL::BooleanExpression.new(:OR, @opts[clause], filter_expr(cond, &block)))
      end
    end

order(*columns, &block) click to toggle source

Returns a copy of the dataset with the order changed. If the dataset has an existing order, it is ignored and overwritten with this order. If a nil is given the returned dataset has no order. This can accept multiple arguments of varying kinds, such as SQL functions. If a block is given, it is treated as a virtual row block, similar to `filter`.

    DB[:items].order(:name) # SELECT * FROM items ORDER BY name
    DB[:items].order(:a, :b) # SELECT * FROM items ORDER BY a, b
    DB[:items].order(Sequel.lit('a + b')) # SELECT * FROM items ORDER BY a + b
    DB[:items].order(:a + :b) # SELECT * FROM items ORDER BY (a + b)
    DB[:items].order(Sequel.desc(:name)) # SELECT * FROM items ORDER BY name DESC
    DB[:items].order(Sequel.asc(:name, :nulls=>:last)) # SELECT * FROM items ORDER BY name ASC NULLS LAST
    DB[:items].order{sum(name).desc} # SELECT * FROM items ORDER BY sum(name) DESC
    DB[:items].order(nil) # SELECT * FROM items

    # File lib/sequel/dataset/query.rb, line 688
    def order(*columns, &block)
      virtual_row_columns(columns, block)
      clone(:order => (columns.compact.empty?) ? nil : columns)
    end

order_append(*columns, &block) click to toggle source

Alias of order_more, for naming consistency with order_prepend.

    # File lib/sequel/dataset/query.rb, line 694
    def order_append(*columns, &block)
      order_more(*columns, &block)
    end

order_by(*columns, &block) click to toggle source

Alias of order

    # File lib/sequel/dataset/query.rb, line 699
    def order_by(*columns, &block)
      order(*columns, &block)
    end

order_more(*columns, &block) click to toggle source

Returns a copy of the dataset with the order columns added to the end of the existing order.

    DB[:items].order(:a).order(:b) # SELECT * FROM items ORDER BY b
    DB[:items].order(:a).order_more(:b) # SELECT * FROM items ORDER BY a, b

    # File lib/sequel/dataset/query.rb, line 708
    def order_more(*columns, &block)
      columns = @opts[:order] + columns if @opts[:order]
      order(*columns, &block)
    end

order_prepend(*columns, &block) click to toggle source

Returns a copy of the dataset with the order columns added to the beginning of the existing order.

    DB[:items].order(:a).order(:b) # SELECT * FROM items ORDER BY b
    DB[:items].order(:a).order_prepend(:b) # SELECT * FROM items ORDER BY b, a

    # File lib/sequel/dataset/query.rb, line 718
    def order_prepend(*columns, &block)
      ds = order(*columns, &block)
      @opts[:order] ? ds.order_more(*@opts[:order]) : ds
    end

qualify(table=first_source) click to toggle source

Qualify to the given table, or first source if no table is given.

    DB[:items].filter(:id=>1).qualify
    # SELECT items.* FROM items WHERE (items.id = 1)

    DB[:items].filter(:id=>1).qualify(:i)
    # SELECT i.* FROM items WHERE (i.id = 1)

    # File lib/sequel/dataset/query.rb, line 730
    def qualify(table=first_source)
      o = @opts
      return clone if o[:sql]
      h = {}
      (o.keys & QUALIFY_KEYS).each do |k|
        h[k] = qualified_expression(o[k], table)
      end
      h[:select] = [SQL::ColumnAll.new(table)] if !o[:select] || o[:select].empty?
      clone(h)
    end

qualify_to(table) click to toggle source

Return a copy of the dataset with unqualified identifiers in the SELECT, WHERE, GROUP, HAVING, and ORDER clauses qualified by the given table. If no columns are currently selected, select all columns of the given table.

    DB[:items].filter(:id=>1).qualify_to(:i)
    # SELECT i.* FROM items WHERE (i.id = 1)

    # File lib/sequel/dataset/query.rb, line 748
    def qualify_to(table)
      Sequel::Deprecation.deprecate('Dataset#qualify_to', 'Switch to Dataset#qualify or use the sequel_3_dataset_methods extension')
      qualify(table)
    end

qualify_to_first_source() click to toggle source

Qualify the dataset to its current first source. This is useful if you have unqualified identifiers in the query that all refer to the first source, and you want to join to another table which has columns with the same name as columns in the current dataset. See `qualify_to`.

    DB[:items].filter(:id=>1).qualify_to_first_source
    # SELECT items.* FROM items WHERE (items.id = 1)

    # File lib/sequel/dataset/query.rb, line 761
    def qualify_to_first_source
      Sequel::Deprecation.deprecate('Dataset#qualify_to_first_source', 'Switch to Dataset#qualify or use the sequel_3_dataset_methods extension')
      qualify
    end

returning(*values) click to toggle source

Modify the RETURNING clause, only supported on a few databases. If returning is used, instead of insert returning the autogenerated primary key or update/delete returning the number of modified rows, results are returned using `fetch_rows`.

    DB[:items].returning # RETURNING *
    DB[:items].returning(nil) # RETURNING NULL
    DB[:items].returning(:id, :name) # RETURNING id, name

    # File lib/sequel/dataset/query.rb, line 774
    def returning(*values)
      clone(:returning=>values)
    end

reverse(*order, &block) click to toggle source

Returns a copy of the dataset with the order reversed. If no order is given, the existing order is inverted.

    DB[:items].reverse(:id) # SELECT * FROM items ORDER BY id DESC
    DB[:items].reverse{foo(bar)} # SELECT * FROM items ORDER BY foo(bar) DESC
    DB[:items].order(:id).reverse # SELECT * FROM items ORDER BY id DESC
    DB[:items].order(:id).reverse(Sequel.desc(:name)) # SELECT * FROM items ORDER BY name ASC

    # File lib/sequel/dataset/query.rb, line 785
    def reverse(*order, &block)
      virtual_row_columns(order, block)
      order(*invert_order(order.empty? ? @opts[:order] : order))
    end

reverse_order(*order, &block) click to toggle source

Alias of `reverse`

    # File lib/sequel/dataset/query.rb, line 791
    def reverse_order(*order, &block)
      reverse(*order, &block)
    end

select(*columns, &block) click to toggle source

Returns a copy of the dataset with the columns selected changed to the given columns. This also takes a virtual row block, similar to `filter`.

    DB[:items].select(:a) # SELECT a FROM items
    DB[:items].select(:a, :b) # SELECT a, b FROM items
    DB[:items].select{[a, sum(b)]} # SELECT a, sum(b) FROM items

    # File lib/sequel/dataset/query.rb, line 802
    def select(*columns, &block)
      virtual_row_columns(columns, block)
      m = []
      columns.each do |i|
        if i.is_a?(Hash)
          Sequel::Deprecation.deprecate('Dataset#select will no longer treat an input hash as an alias specifier.  Switch to aliasing using Sequel.as or use the hash_aliases extension.')
          m.concat(i.map{|k, v| SQL::AliasedExpression.new(k,v)})
        else
          m << i
        end
      end
      clone(:select => m)
    end

select_all(*tables) click to toggle source

Returns a copy of the dataset selecting the wildcard if no arguments are given. If arguments are given, treat them as tables and select all columns (using the wildcard) from each table.

    DB[:items].select(:a).select_all # SELECT * FROM items
    DB[:items].select_all(:items) # SELECT items.* FROM items
    DB[:items].select_all(:items, :foo) # SELECT items.*, foo.* FROM items

    # File lib/sequel/dataset/query.rb, line 823
    def select_all(*tables)
      if tables.empty?
        clone(:select => nil)
      else
        select(*tables.map{|t| i, a = split_alias(t); a || i}.map{|t| SQL::ColumnAll.new(t)})
      end
    end

select_append(*columns, &block) click to toggle source

Returns a copy of the dataset with the given columns added to the existing selected columns. If no columns are currently selected, it will select the columns given in addition to *.

    DB[:items].select(:a).select(:b) # SELECT b FROM items
    DB[:items].select(:a).select_append(:b) # SELECT a, b FROM items
    DB[:items].select_append(:b) # SELECT *, b FROM items

    # File lib/sequel/dataset/query.rb, line 838
    def select_append(*columns, &block)
      cur_sel = @opts[:select]
      if !cur_sel || cur_sel.empty?
        unless supports_select_all_and_column?
          return select_all(*(Array(@opts[:from]) + Array(@opts[:join]))).select_more(*columns, &block)
        end
        cur_sel = [WILDCARD]
      end
      select(*(cur_sel + columns), &block)
    end

select_group(*columns, &block) click to toggle source

Set both the select and group clauses with the given `columns`. Column aliases may be supplied, and will be included in the select clause. This also takes a virtual row block similar to `filter`.

    DB[:items].select_group(:a, :b)
    # SELECT a, b FROM items GROUP BY a, b

    DB[:items].select_group(:c___a){f(c2)}
    # SELECT c AS a, f(c2) FROM items GROUP BY c, f(c2)

    # File lib/sequel/dataset/query.rb, line 858
    def select_group(*columns, &block)
      virtual_row_columns(columns, block)
      select(*columns).group(*columns.map{|c| unaliased_identifier(c)})
    end

select_more(*columns, &block) click to toggle source

Returns a copy of the dataset with the given columns added to the existing selected columns. If no columns are currently selected it will just select the columns given.

    DB[:items].select(:a).select(:b) # SELECT b FROM items
    DB[:items].select(:a).select_more(:b) # SELECT a, b FROM items
    DB[:items].select_more(:b) # SELECT b FROM items

    # File lib/sequel/dataset/query.rb, line 870
    def select_more(*columns, &block)
      if @opts[:select]
        columns = @opts[:select] + columns
      else
        Sequel::Deprecation.deprecate('Dataset#select_more will no longer remove the wildcard selection from the Dataset starting in Sequel 4.  Switch to using Dataset#select if you want that behavior.')
      end
      select(*columns, &block)
    end

server(servr) click to toggle source

Set the server for this dataset to use. Used to pick a specific database shard to run a query against, or to override the default (where SELECT uses :read_only database and all other queries use the :default database). This method is always available but is only useful when database sharding is being used.

    DB[:items].all # Uses the :read_only or :default server
    DB[:items].delete # Uses the :default server
    DB[:items].server(:blah).delete # Uses the :blah server

    # File lib/sequel/dataset/query.rb, line 888
    def server(servr)
      clone(:server=>servr)
    end

set_defaults(hash) click to toggle source

Set the default values for insert and update statements. The values hash passed to insert or update are merged into this hash, so any values in the hash passed to insert or update will override values passed to this method.

    DB[:items].set_defaults(:a=>'a', :c=>'c').insert(:a=>'d', :b=>'b')
    # INSERT INTO items (a, c, b) VALUES ('d', 'c', 'b')

    # File lib/sequel/dataset/query.rb, line 898
    def set_defaults(hash)
      Sequel::Deprecation.deprecate('Dataset#set_defaults', 'Please use the dataset_set_overrides extension if you want to continue using it')
      clone(:defaults=>(@opts[:defaults]||{}).merge(hash))
    end

set_overrides(hash) click to toggle source

Set values that override hash arguments given to insert and update statements. This hash is merged into the hash provided to insert or update, so values will override any values given in the insert/update hashes.

    DB[:items].set_overrides(:a=>'a', :c=>'c').insert(:a=>'d', :b=>'b')
    # INSERT INTO items (a, c, b) VALUES ('a', 'c', 'b')

    # File lib/sequel/dataset/query.rb, line 909
    def set_overrides(hash)
      Sequel::Deprecation.deprecate('Dataset#set_overrides', 'Please use the dataset_set_overrides extension if you want to continue using it')
      clone(:overrides=>hash.merge(@opts[:overrides]||{}))
    end

unbind() click to toggle source

Unbind bound variables from this dataset's filter and return an array of two objects. The first object is a modified dataset where the filter has been replaced with one that uses bound variable placeholders. The second object is the hash of unbound variables. You can then prepare and execute (or just call) the dataset with the bound variables to get results.

    ds, bv = DB[:items].filter(:a=>1).unbind
    ds # SELECT * FROM items WHERE (a = $a)
    bv #  {:a => 1}
    ds.call(:select, bv)

    # File lib/sequel/dataset/query.rb, line 924
    def unbind
      u = Unbinder.new
      ds = clone(:where=>u.transform(opts[:where]), :join=>u.transform(opts[:join]))
      [ds, u.binds]
    end

unfiltered() click to toggle source

Returns a copy of the dataset with no filters (HAVING or WHERE clause) applied.

    DB[:items].group(:a).having(:a=>1).where(:b).unfiltered
    # SELECT * FROM items GROUP BY a

    # File lib/sequel/dataset/query.rb, line 934
    def unfiltered
      clone(:where => nil, :having => nil)
    end

ungrouped() click to toggle source

Returns a copy of the dataset with no grouping (GROUP or HAVING clause) applied.

    DB[:items].group(:a).having(:a=>1).where(:b).ungrouped
    # SELECT * FROM items WHERE b

    # File lib/sequel/dataset/query.rb, line 942
    def ungrouped
      clone(:group => nil, :having => nil)
    end

union(dataset, opts={}) click to toggle source

Adds a UNION clause using a second dataset object. A UNION compound dataset returns all rows in either the current dataset or the given dataset. Options:

:alias | Use the given value as the from_self alias
:all | Set to true to use UNION ALL instead of UNION, so duplicate rows can occur
:from_self | Set to false to not wrap the returned dataset in a from_self, use with care.

    DB[:items].union(DB[:other_items])
    # SELECT * FROM (SELECT * FROM items UNION SELECT * FROM other_items) AS t1

    DB[:items].union(DB[:other_items], :all=>true, :from_self=>false)
    # SELECT * FROM items UNION ALL SELECT * FROM other_items

    DB[:items].union(DB[:other_items], :alias=>:i)
    # SELECT * FROM (SELECT * FROM items UNION SELECT * FROM other_items) AS i

    # File lib/sequel/dataset/query.rb, line 962
    def union(dataset, opts={})
      unless opts.is_a?(Hash)
        Sequel::Deprecation.deprecate('Passing a non-hash as the second argument to Dataset#union', "Please switch to an options hash with the :all option")
        opts = {:all=>opts}
      end
      compound_clone(:union, dataset, opts)
    end

unlimited() click to toggle source

Returns a copy of the dataset with no limit or offset.

    DB[:items].limit(10, 20).unlimited # SELECT * FROM items

    # File lib/sequel/dataset/query.rb, line 973
    def unlimited
      clone(:limit=>nil, :offset=>nil)
    end

unordered() click to toggle source

Returns a copy of the dataset with no order.

    DB[:items].order(:a).unordered # SELECT * FROM items

    # File lib/sequel/dataset/query.rb, line 980
    def unordered
      order(nil)
    end

where(*cond, &block) click to toggle source

Add a condition to the WHERE clause. See `filter` for argument types.

    DB[:items].group(:a).having(:a).filter(:b)
    # SELECT * FROM items GROUP BY a HAVING a AND b

    DB[:items].group(:a).having(:a).where(:b)
    # SELECT * FROM items WHERE b GROUP BY a HAVING a

    # File lib/sequel/dataset/query.rb, line 991
    def where(*cond, &block)
      _filter(:where, *cond, &block)
    end

with(name, dataset, opts={}) click to toggle source

Add a common table expression (CTE) with the given name and a dataset that defines the CTE. A common table expression acts as an inline view for the query. Options:

:args | Specify the arguments/columns for the CTE, should be an array of symbols.
:recursive | Specify that this is a recursive CTE

    DB[:items].with(:items, DB[:syx].filter(:name.like('A%')))
    # WITH items AS (SELECT * FROM syx WHERE (name LIKE 'A%')) SELECT * FROM items

    # File lib/sequel/dataset/query.rb, line 1003
    def with(name, dataset, opts={})
      raise(Error, 'This datatset does not support common table expressions') unless supports_cte?
      if hoist_cte?(dataset)
        s, ds = hoist_cte(dataset)
        s.with(name, ds, opts)
      else
        clone(:with=>(@opts[:with]||[]) + [opts.merge(:name=>name, :dataset=>dataset)])
      end
    end

with_recursive(name, nonrecursive, recursive, opts={}) click to toggle source

Add a recursive common table expression (CTE) with the given name, a dataset that defines the nonrecursive part of the CTE, and a dataset that defines the recursive part of the CTE. Options:

:args | Specify the arguments/columns for the CTE, should be an array of symbols.
:union_all | Set to false to use UNION instead of UNION ALL combining the nonrecursive and recursive parts.

    DB[:t].with_recursive(:t,
      DB[:i1].select(:id, :parent_id).filter(:parent_id=>nil),
      DB[:i1].join(:t, :id=>:parent_id).select(:i1__id, :i1__parent_id),
      :args=>[:id, :parent_id])

    # WITH RECURSIVE "t"("id", "parent_id") AS (
    #   SELECT "id", "parent_id" FROM "i1" WHERE ("parent_id" IS NULL)
    #   UNION ALL
    #   SELECT "i1"."id", "i1"."parent_id" FROM "i1" INNER JOIN "t" ON ("t"."id" = "i1"."parent_id")
    # ) SELECT * FROM "t"

    # File lib/sequel/dataset/query.rb, line 1029
    def with_recursive(name, nonrecursive, recursive, opts={})
      raise(Error, 'This datatset does not support common table expressions') unless supports_cte?
      if hoist_cte?(nonrecursive)
        s, ds = hoist_cte(nonrecursive)
        s.with_recursive(name, ds, recursive, opts)
      elsif hoist_cte?(recursive)
        s, ds = hoist_cte(recursive)
        s.with_recursive(name, nonrecursive, ds, opts)
      else
        clone(:with=>(@opts[:with]||[]) + [opts.merge(:recursive=>true, :name=>name, :dataset=>nonrecursive.union(recursive, {:all=>opts[:union_all] != false, :from_self=>false}))])
      end
    end

with_sql(sql, *args) click to toggle source

Returns a copy of the dataset with the static SQL used. This is useful if you want to keep the same row_proc/graph, but change the SQL used to custom SQL.

    DB[:items].with_sql('SELECT * FROM foo') # SELECT * FROM foo

You can use placeholders in your SQL and provide arguments for those placeholders:

    DB[:items].with_sql('SELECT ? FROM foo', 1) # SELECT 1 FROM foo

You can also provide a method name and arguments to call to get the SQL:

    DB[:items].with_sql(:insert_sql, :b=>1) # INSERT INTO items (b) VALUES (1)

    # File lib/sequel/dataset/query.rb, line 1054
    def with_sql(sql, *args)
      if sql.is_a?(Symbol)
        sql = send(sql, *args)
      else
        sql = SQL::PlaceholderLiteralString.new(sql, args) unless args.empty?
      end
      clone(:sql=>sql)
    end

### Protected Instance Methods

compound_clone(type, dataset, opts) click to toggle source

Add the dataset to the list of compounds

    # File lib/sequel/dataset/query.rb, line 1066
    def compound_clone(type, dataset, opts)
      if hoist_cte?(dataset)
        s, ds = hoist_cte(dataset)
        return s.compound_clone(type, ds, opts)
      end
      ds = compound_from_self.clone(:compounds=>Array(@opts[:compounds]).map{|x| x.dup} + [[type, dataset.compound_from_self, opts[:all]]])
      opts[:from_self] == false ? ds : ds.from_self(opts)
    end

options_overlap(opts) click to toggle source

Return true if the dataset has a non-nil value for any key in opts.

    # File lib/sequel/dataset/query.rb, line 1076
    def options_overlap(opts)
      !(@opts.collect{|k,v| k unless v.nil?}.compact & opts).empty?
    end

simple_select_all?() click to toggle source

Whether this dataset is a simple SELECT * FROM table.

    # File lib/sequel/dataset/query.rb, line 1081
    def simple_select_all?
      o = @opts.reject{|k,v| v.nil? || NON_SQL_OPTIONS.include?(k)}
      o.length == 1 && (f = o[:from]) && f.length == 1 && (f.first.is_a?(Symbol) || f.first.is_a?(SQL::AliasedExpression))
    end

## 2 - Methods that execute code on the database ↑ top

These methods all execute the dataset's SQL on the database. They don't return modified datasets, so if used in a method chain they should be the last method called.

### Constants

ACTION_METHODS

  Action methods defined by Sequel that execute code on the database.

### Public Instance Methods

<<(arg) click to toggle source

Inserts the given argument into the database. Returns self so it can be used safely when chaining:

    DB[:items] << {:id=>0, :name=>'Zero'} << DB[:old_items].select(:id, name)

    # File lib/sequel/dataset/actions.rb, line 23
    def <<(arg)
      insert(arg)
      self
    end

[](*conditions) click to toggle source

Returns the first record matching the conditions. Examples:

    DB[:table][:id=>1] # SELECT * FROM table WHERE (id = 1) LIMIT 1
    # => {:id=1}

    # File lib/sequel/dataset/actions.rb, line 32
    def [](*conditions)
      raise(Error, ARRAY_ACCESS_ERROR_MSG) if (conditions.length == 1 and conditions.first.is_a?(Integer)) or conditions.length == 0
      first(*conditions)
    end

[]=(conditions, values) click to toggle source

Update all records matching the conditions with the values specified. Returns the number of rows affected.

    DB[:table][:id=>1] = {:id=>2} # UPDATE table SET id = 2 WHERE id = 1
    # => 1 # number of rows affected

    # File lib/sequel/dataset/actions.rb, line 42
    def []=(conditions, values)
      Sequel::Deprecation.deprecate('Dataset#[]=', 'Please load the sequel_3_dataset_methods extension to continue using it')
      filter(conditions).update(values)
    end

all(&block) click to toggle source

Returns an array with all records in the dataset. If a block is given, the array is iterated over after all items have been loaded.

    DB[:table].all # SELECT * FROM table
    # => [{:id=>1, ...}, {:id=>2, ...}, ...]

    # Iterate over all rows in the table
    DB[:table].all{|row| p row}

    # File lib/sequel/dataset/actions.rb, line 55
    def all(&block)
      a = []
      each{|r| a << r}
      post_load(a)
      a.each(&block) if block
      a
    end

avg(column=Sequel.virtual_row(&Proc.new)) click to toggle source

Returns the average value for the given column/expression. Uses a virtual row block if no argument is given.

    DB[:table].avg(:number) # SELECT avg(number) FROM table LIMIT 1
    # => 3
    DB[:table].avg{function(column)} # SELECT avg(function(column)) FROM table LIMIT 1
    # => 1

    # File lib/sequel/dataset/actions.rb, line 70
    def avg(column=Sequel.virtual_row(&Proc.new))
      aggregate_dataset.get{avg(column).as(:avg)}
    end

columns() click to toggle source

Returns the columns in the result set in order as an array of symbols. If the columns are currently cached, returns the cached value. Otherwise, a SELECT query is performed to retrieve a single row in order to get the columns.

If you are looking for all columns for a single table and maybe some information about each column (e.g. database type), see `Database#schema`.

    DB[:table].columns
    # => [:id, :name]

    # File lib/sequel/dataset/actions.rb, line 83
    def columns
      return @columns if @columns
      ds = unfiltered.unordered.naked.clone(:distinct => nil, :limit => 1, :offset=>nil)
      ds.each{break}
      @columns = ds.instance_variable_get(:@columns)
      @columns || []
    end

Also aliased as: columns_without_introspection
columns!() click to toggle source

Ignore any cached column information and perform a query to retrieve a row in order to get the columns.

    DB[:table].columns!
    # => [:id, :name]

    # File lib/sequel/dataset/actions.rb, line 96
    def columns!
      @columns = nil
      columns
    end

columns_without_introspection() click to toggle source
Alias for: columns
count(arg=(no_arg=true), &block) click to toggle source

Returns the number of records in the dataset. If an argument is provided, it is used as the argument to count. If a block is provided, it is treated as a virtual row, and the result is used as the argument to count.

    DB[:table].count # SELECT count(*) AS count FROM table LIMIT 1
    # => 3
    DB[:table].count(:column) # SELECT count(column) AS count FROM table LIMIT 1
    # => 2
    DB[:table].count{foo(column)} # SELECT count(foo(column)) AS count FROM table LIMIT 1
    # => 1

    # File lib/sequel/dataset/actions.rb, line 112
    def count(arg=(no_arg=true), &block)
      if no_arg
        if block
          arg = Sequel.virtual_row(&block)
          aggregate_dataset.get{count(arg).as(count)}
        else
          aggregate_dataset.get{count(:*){}.as(count)}.to_i
        end
      elsif block
        raise Error, 'cannot provide both argument and block to Dataset#count'
      else
        aggregate_dataset.get{count(arg).as(count)}
      end
    end

delete(&block) click to toggle source

Deletes the records in the dataset. The returned value should be number of records deleted, but that is adapter dependent.

    DB[:table].delete # DELETE * FROM table
    # => 3

    # File lib/sequel/dataset/actions.rb, line 132
    def delete(&block)
      sql = delete_sql
      if uses_returning?(:delete)
        returning_fetch_rows(sql, &block)
      else
        execute_dui(sql)
      end
    end

each() click to toggle source

Iterates over the records in the dataset as they are yielded from the database adapter, and returns self.

    DB[:table].each{|row| p row} # SELECT * FROM table

Note that this method is not safe to use on many adapters if you are running additional queries inside the provided block. If you are running queries inside the block, you should use `all` instead of `each` for the outer queries, or use a separate thread or shard inside `each`.

    # File lib/sequel/dataset/actions.rb, line 150
    def each
      if @opts[:graph]
        graph_each{|r| yield r}
      elsif row_proc = @row_proc
        fetch_rows(select_sql){|r| yield row_proc.call(r)}
      else
        fetch_rows(select_sql){|r| yield r}
      end
      self
    end

empty?() click to toggle source

Returns true if no records exist in the dataset, false otherwise

    DB[:table].empty? # SELECT 1 AS one FROM table LIMIT 1
    # => false

    # File lib/sequel/dataset/actions.rb, line 165
    def empty?
      get(Sequel::SQL::AliasedExpression.new(1, :one)).nil?
    end

fetch_rows(sql) click to toggle source

Executes a select query and fetches records, yielding each record to the supplied block. The yielded records should be hashes with symbol keys. This method should probably should not be called by user code, use `each` instead.

    # File lib/sequel/dataset/actions.rb, line 173
    def fetch_rows(sql)
      Sequel::Deprecation.deprecate('Dataset#fetch_rows default implementation and Sequel::NotImplemented', 'All dataset instances can be assumed to implement fetch_rows')
      raise NotImplemented, NOTIMPL_MSG
    end

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

If a integer argument is given, it is interpreted as a limit, and then returns all matching records up to that limit. If no argument is passed, it returns the first matching record. If any other type of argument(s) is passed, it is given to filter and the first matching record is returned. If a block is given, it is used to filter the dataset before returning anything.

If there are no records in the dataset, returns nil (or an empty array if an integer argument is given).

Examples:

    DB[:table].first # SELECT * FROM table LIMIT 1
    # => {:id=>7}

    DB[:table].first(2) # SELECT * FROM table LIMIT 2
    # => [{:id=>6}, {:id=>4}]

    DB[:table].first(:id=>2) # SELECT * FROM table WHERE (id = 2) LIMIT 1
    # => {:id=>2}

    DB[:table].first("id = 3") # SELECT * FROM table WHERE (id = 3) LIMIT 1
    # => {:id=>3}

    DB[:table].first("id = ?", 4) # SELECT * FROM table WHERE (id = 4) LIMIT 1
    # => {:id=>4}

    DB[:table].first{id > 2} # SELECT * FROM table WHERE (id > 2) LIMIT 1
    # => {:id=>5}

    DB[:table].first("id > ?", 4){id < 6} # SELECT * FROM table WHERE ((id > 4) AND (id < 6)) LIMIT 1
    # => {:id=>5}

    DB[:table].first(2){id < 2} # SELECT * FROM table WHERE (id < 2) LIMIT 2
    # => [{:id=>1}]

    # File lib/sequel/dataset/actions.rb, line 213
    def first(*args, &block)
      ds = block ? filter(&block) : self

      if args.empty?
        ds.single_record
      else
        args = (args.size == 1) ? args.first : args
        if args.is_a?(Integer)
          ds.limit(args).all
        else
          ds.filter(args).single_record
        end
      end
    end

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

Calls first. If first returns nil (signaling that no row matches), raise a Sequel::NoMatchingRow exception.

    # File lib/sequel/dataset/actions.rb, line 230
    def first!(*args, &block)
      first(*args, &block) || raise(Sequel::NoMatchingRow)
    end

get(column=(no_arg=true; nil), &block) click to toggle source

Return the column value for the first matching record in the dataset. Raises an error if both an argument and block is given.

    DB[:table].get(:id) # SELECT id FROM table LIMIT 1
    # => 3

    ds.get{sum(id)} # SELECT sum(id) FROM table LIMIT 1
    # => 6

You can pass an array of arguments to return multiple arguments, but you must make sure each element in the array has an alias that Sequel can determine:

    DB[:table].get([:id, :name]) # SELECT id, name FROM table LIMIT 1
    # => [3, 'foo']

    DB[:table].get{[sum(id).as(sum), name]} # SELECT sum(id) AS sum, name FROM table LIMIT 1
    # => [6, 'foo']

    # File lib/sequel/dataset/actions.rb, line 252
    def get(column=(no_arg=true; nil), &block)
      ds = naked
      if block
        raise(Error, ARG_BLOCK_ERROR_MSG) unless no_arg
        ds = ds.select(&block)
        column = ds.opts[:select]
        column = nil if column.is_a?(Array) && column.length < 2
      else
        ds = if column.is_a?(Array)
          ds.select(*column)
        else
          ds.select(column)
        end
      end

      if column.is_a?(Array)
       if r = ds.single_record
         r.values_at(*hash_key_symbols(column))
       end
      else
        ds.single_value
      end
    end

import(columns, values, opts={}) click to toggle source

Inserts multiple records into the associated table. This method can be used to efficiently insert a large number of records into a table in a single query if the database supports it. Inserts are automatically wrapped in a transaction.

This method is called with a columns array and an array of value arrays:

    DB[:table].import([:x, :y], [[1, 2], [3, 4]])
    # INSERT INTO table (x, y) VALUES (1, 2)
    # INSERT INTO table (x, y) VALUES (3, 4)

This method also accepts a dataset instead of an array of value arrays:

    DB[:table].import([:x, :y], DB[:table2].select(:a, :b))
    # INSERT INTO table (x, y) SELECT a, b FROM table2

Options:

:commit_every | Open a new transaction for every given number of records. For example, if you provide a value of 50, will commit after every 50 records.
:server | Set the server/shard to use for the transaction and insert queries.
:slice | Same as :commit_every, :commit_every takes precedence.

    # File lib/sequel/dataset/actions.rb, line 299
    def import(columns, values, opts={})
      return @db.transaction{insert(columns, values)} if values.is_a?(Dataset)

      return if values.empty?
      raise(Error, IMPORT_ERROR_MSG) if columns.empty?
      ds = opts[:server] ? server(opts[:server]) : self

      if slice_size = opts[:commit_every] || opts[:slice]
        offset = 0
        rows = []
        while offset < values.length
          rows << ds._import(columns, values[offset, slice_size], opts)
          offset += slice_size
        end
        rows.flatten
      else
        ds._import(columns, values, opts)
      end
    end

insert(*values, &block) click to toggle source

Inserts values into the associated table. The returned value is generally the value of the primary key for the inserted row, but that is adapter dependent.

`insert` handles a number of different argument formats:

no arguments or single empty hash | Uses DEFAULT VALUES
single hash | Most common format, treats keys as columns an values as values
single array | Treats entries as values, with no columns
two arrays | Treats first array as columns, second array as values
single Dataset | Treats as an insert based on a selection from the dataset given, with no columns
array and dataset | Treats as an insert based on a selection from the dataset given, with the columns given by the array.

Examples:

    DB[:items].insert
    # INSERT INTO items DEFAULT VALUES

    DB[:items].insert({})
    # INSERT INTO items DEFAULT VALUES

    DB[:items].insert([1,2,3])
    # INSERT INTO items VALUES (1, 2, 3)

    DB[:items].insert([:a, :b], [1,2])
    # INSERT INTO items (a, b) VALUES (1, 2)

    DB[:items].insert(:a => 1, :b => 2)
    # INSERT INTO items (a, b) VALUES (1, 2)

    DB[:items].insert(DB[:old_items])
    # INSERT INTO items SELECT * FROM old_items

    DB[:items].insert([:a, :b], DB[:old_items])
    # INSERT INTO items (a, b) SELECT * FROM old_items

    # File lib/sequel/dataset/actions.rb, line 354
    def insert(*values, &block)
      sql = insert_sql(*values)
      if uses_returning?(:insert)
        returning_fetch_rows(sql, &block)
      else
        execute_insert(sql)
      end
    end

insert_multiple(array, &block) click to toggle source

Inserts multiple values. If a block is given it is invoked for each item in the given array before inserting it. See `multi_insert` as a possibly faster version that may be able to insert multiple records in one SQL statement (if supported by the database). Returns an array of primary keys of inserted rows.

    DB[:table].insert_multiple([{:x=>1}, {:x=>2}])
    # => [4, 5]
    # INSERT INTO table (x) VALUES (1)
    # INSERT INTO table (x) VALUES (2)

    DB[:table].insert_multiple([{:x=>1}, {:x=>2}]){|row| row[:y] = row[:x] * 2; row }
    # => [6, 7]
    # INSERT INTO table (x, y) VALUES (1, 2)
    # INSERT INTO table (x, y) VALUES (2, 4)

    # File lib/sequel/dataset/actions.rb, line 378
    def insert_multiple(array, &block)
      Sequel::Deprecation.deprecate('Dataset#insert_multiple', 'Please load the sequel_3_dataset_methods extension to continue using it')
      if block
        array.map{|i| insert(block.call(i))}
      else
        array.map{|i| insert(i)}
      end
    end

interval(column=Sequel.virtual_row(&Proc.new)) click to toggle source

Returns the interval between minimum and maximum values for the given column/expression. Uses a virtual row block if no argument is given.

    DB[:table].interval(:id) # SELECT (max(id) - min(id)) FROM table LIMIT 1
    # => 6
    DB[:table].interval{function(column)} # SELECT (max(function(column)) - min(function(column))) FROM table LIMIT 1
    # => 7

    # File lib/sequel/dataset/actions.rb, line 394
    def interval(column=Sequel.virtual_row(&Proc.new))
      aggregate_dataset.get{(max(column) - min(column)).as(:interval)}
    end

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

Reverses the order and then runs first with the given arguments and block. Note that this will not necessarily give you the last record in the dataset, unless you have an unambiguous order. If there is not currently an order for this dataset, raises an `Error`.

    DB[:table].order(:id).last # SELECT * FROM table ORDER BY id DESC LIMIT 1
    # => {:id=>10}

    DB[:table].order(Sequel.desc(:id)).last(2) # SELECT * FROM table ORDER BY id ASC LIMIT 2
    # => [{:id=>1}, {:id=>2}]

    # File lib/sequel/dataset/actions.rb, line 408
    def last(*args, &block)
      raise(Error, 'No order specified') unless @opts[:order]
      reverse.first(*args, &block)
    end

map(column=nil, &block) click to toggle source

Maps column values for each record in the dataset (if a column name is given), or performs the stock mapping functionality of `Enumerable` otherwise. Raises an `Error` if both an argument and block are given.

    DB[:table].map(:id) # SELECT * FROM table
    # => [1, 2, 3, ...]

    DB[:table].map{|r| r[:id] * 2} # SELECT * FROM table
    # => [2, 4, 6, ...]

You can also provide an array of column names:

    DB[:table].map([:id, :name]) # SELECT * FROM table
    # => [[1, 'A'], [2, 'B'], [3, 'C'], ...]

    # File lib/sequel/dataset/actions.rb, line 427
    def map(column=nil, &block)
      if column
        raise(Error, ARG_BLOCK_ERROR_MSG) if block
        return naked.map(column) if row_proc
        if column.is_a?(Array)
          super(){|r| r.values_at(*column)}
        else
          super(){|r| r[column]}
        end
      else
        super(&block)
      end
    end

max(column=Sequel.virtual_row(&Proc.new)) click to toggle source

Returns the maximum value for the given column/expression. Uses a virtual row block if no argument is given.

    DB[:table].max(:id) # SELECT max(id) FROM table LIMIT 1
    # => 10
    DB[:table].max{function(column)} # SELECT max(function(column)) FROM table LIMIT 1
    # => 7

    # File lib/sequel/dataset/actions.rb, line 448
    def max(column=Sequel.virtual_row(&Proc.new))
      aggregate_dataset.get{max(column).as(:max)}
    end

min(column=Sequel.virtual_row(&Proc.new)) click to toggle source

Returns the minimum value for the given column/expression. Uses a virtual row block if no argument is given.

    DB[:table].min(:id) # SELECT min(id) FROM table LIMIT 1
    # => 1
    DB[:table].min{function(column)} # SELECT min(function(column)) FROM table LIMIT 1
    # => 0

    # File lib/sequel/dataset/actions.rb, line 459
    def min(column=Sequel.virtual_row(&Proc.new))
      aggregate_dataset.get{min(column).as(:min)}
    end

multi_insert(hashes, opts={}) click to toggle source

This is a front end for import that allows you to submit an array of hashes instead of arrays of columns and values:

    DB[:table].multi_insert([{:x => 1}, {:x => 2}])
    # INSERT INTO table (x) VALUES (1)
    # INSERT INTO table (x) VALUES (2)

Be aware that all hashes should have the same keys if you use this calling method, otherwise some columns could be missed or set to null instead of to default values.

This respects the same options as import.

    # File lib/sequel/dataset/actions.rb, line 475
    def multi_insert(hashes, opts={})
      return if hashes.empty?
      columns = hashes.first.keys
      import(columns, hashes.map{|h| columns.map{|c| h[c]}}, opts)
    end

paged_each(opts={}) click to toggle source

Yields each row in the dataset, but interally uses multiple queries as needed with limit and offset to process the entire result set without keeping all rows in the dataset in memory, even if the underlying driver buffers all query results in memory.

Because this uses multiple queries internally, in order to remain consistent, it also uses a transaction internally. Additionally, to make sure that all rows in the dataset are yielded and none are yielded twice, the dataset must have an unambiguous order. Sequel requires that datasets using this method have an order, but it cannot ensure that the order is unambiguous.

Options:

:rows_per_fetch | The number of rows to fetch per query. Defaults to 1000.

    # File lib/sequel/dataset/actions.rb, line 494
    def paged_each(opts={})
      unless @opts[:order]
        raise Sequel::Error, "Dataset#paged_each requires the dataset be ordered"
      end

      total_limit = @opts[:limit]
      offset = @opts[:offset] || 0

      if server = @opts[:server]
        opts = opts.merge(:server=>server)
      end

      rows_per_fetch = opts[:rows_per_fetch] || 1000
      num_rows_yielded = rows_per_fetch
      total_rows = 0

      db.transaction(opts) do
        while num_rows_yielded == rows_per_fetch && (total_limit.nil? || total_rows < total_limit)
          if total_limit && total_rows + rows_per_fetch > total_limit
            rows_per_fetch = total_limit - total_rows
          end

          num_rows_yielded = 0
          limit(rows_per_fetch, offset).each do |row|
            num_rows_yielded += 1
            total_rows += 1 if total_limit
            yield row
          end

          offset += rows_per_fetch
        end
      end

      self
    end

range(column=Sequel.virtual_row(&Proc.new)) click to toggle source

Returns a `Range` instance made from the minimum and maximum values for the given column/expression. Uses a virtual row block if no argument is given.

    DB[:table].range(:id) # SELECT max(id) AS v1, min(id) AS v2 FROM table LIMIT 1
    # => 1..10
    DB[:table].interval{function(column)} # SELECT max(function(column)) AS v1, min(function(column)) AS v2 FROM table LIMIT 1
    # => 0..7

    # File lib/sequel/dataset/actions.rb, line 537
    def range(column=Sequel.virtual_row(&Proc.new))
      if r = aggregate_dataset.select{[min(column).as(v1), max(column).as(v2)]}.first
        (r[:v1]..r[:v2])
      end
    end

select_hash(key_column, value_column) click to toggle source

Returns a hash with key_column values as keys and value_column values as values. Similar to to_hash, but only selects the columns given.

    DB[:table].select_hash(:id, :name) # SELECT id, name FROM table
    # => {1=>'a', 2=>'b', ...}

You can also provide an array of column names for either the key_column, the value column, or both:

    DB[:table].select_hash([:id, :foo], [:name, :bar]) # SELECT * FROM table
    # {[1, 3]=>['a', 'c'], [2, 4]=>['b', 'd'], ...}

When using this method, you must be sure that each expression has an alias that Sequel can determine. Usually you can do this by calling the as method on the expression and providing an alias.

    # File lib/sequel/dataset/actions.rb, line 558
    def select_hash(key_column, value_column)
      _select_hash(:to_hash, key_column, value_column)
    end

select_hash_groups(key_column, value_column) click to toggle source

Returns a hash with key_column values as keys and an array of value_column values. Similar to to_hash_groups, but only selects the columns given.

    DB[:table].select_hash(:name, :id) # SELECT id, name FROM table
    # => {'a'=>[1, 4, ...], 'b'=>[2, ...], ...}

You can also provide an array of column names for either the key_column, the value column, or both:

    DB[:table].select_hash([:first, :middle], [:last, :id]) # SELECT * FROM table
    # {['a', 'b']=>[['c', 1], ['d', 2], ...], ...}

When using this method, you must be sure that each expression has an alias that Sequel can determine. Usually you can do this by calling the as method on the expression and providing an alias.

    # File lib/sequel/dataset/actions.rb, line 577
    def select_hash_groups(key_column, value_column)
      _select_hash(:to_hash_groups, key_column, value_column)
    end

select_map(column=nil, &block) click to toggle source

Selects the column given (either as an argument or as a block), and returns an array of all values of that column in the dataset. If you give a block argument that returns an array with multiple entries, the contents of the resulting array are undefined. Raises an Error if called with both an argument and a block.

    DB[:table].select_map(:id) # SELECT id FROM table
    # => [3, 5, 8, 1, ...]

    DB[:table].select_map{id * 2} # SELECT (id * 2) FROM table
    # => [6, 10, 16, 2, ...]

You can also provide an array of column names:

    DB[:table].select_map([:id, :name]) # SELECT id, name FROM table
    # => [[1, 'A'], [2, 'B'], [3, 'C'], ...]

If you provide an array of expressions, you must be sure that each entry in the array has an alias that Sequel can determine. Usually you can do this by calling the as method on the expression and providing an alias.

    # File lib/sequel/dataset/actions.rb, line 601
    def select_map(column=nil, &block)
      _select_map(column, false, &block)
    end

select_order_map(column=nil, &block) click to toggle source

The same as select_map, but in addition orders the array by the column.

    DB[:table].select_order_map(:id) # SELECT id FROM table ORDER BY id
    # => [1, 2, 3, 4, ...]

    DB[:table].select_order_map{id * 2} # SELECT (id * 2) FROM table ORDER BY (id * 2)
    # => [2, 4, 6, 8, ...]

You can also provide an array of column names:

    DB[:table].select_order_map([:id, :name]) # SELECT id, name FROM table ORDER BY id, name
    # => [[1, 'A'], [2, 'B'], [3, 'C'], ...]

If you provide an array of expressions, you must be sure that each entry in the array has an alias that Sequel can determine. Usually you can do this by calling the as method on the expression and providing an alias.

    # File lib/sequel/dataset/actions.rb, line 621
    def select_order_map(column=nil, &block)
      _select_map(column, true, &block)
    end

set(*args) click to toggle source

Alias for update, but not aliased directly so subclasses don't have to override both methods.

    # File lib/sequel/dataset/actions.rb, line 627
    def set(*args)
      Sequel::Deprecation.deprecate('Dataset#set', 'Please switch to Dataset#update or load the sequel_3_dataset_methods extension to continue using it')
      update(*args)
    end

single_record() click to toggle source

Returns the first record in the dataset, or nil if the dataset has no records. Users should probably use `first` instead of this method.

    # File lib/sequel/dataset/actions.rb, line 635
    def single_record
      clone(:limit=>1).each{|r| return r}
      nil
    end

single_value() click to toggle source

Returns the first value of the first record in the dataset. Returns nil if dataset is empty. Users should generally use `get` instead of this method.

    # File lib/sequel/dataset/actions.rb, line 643
    def single_value
      if r = naked.ungraphed.single_record
        r.values.first
      end
    end

sum(column=Sequel.virtual_row(&Proc.new)) click to toggle source

Returns the sum for the given column/expression. Uses a virtual row block if no column is given.

    DB[:table].sum(:id) # SELECT sum(id) FROM table LIMIT 1
    # => 55
    DB[:table].sum{function(column)} # SELECT sum(function(column)) FROM table LIMIT 1
    # => 10

    # File lib/sequel/dataset/actions.rb, line 656
    def sum(column=Sequel.virtual_row(&Proc.new))
      aggregate_dataset.get{sum(column).as(:sum)}
    end

to_csv(include_column_titles = true) click to toggle source

Returns a string in CSV format containing the dataset records. By default the CSV representation includes the column titles in the first line. You can turn that off by passing false as the include_column_titles argument.

This does not use a CSV library or handle quoting of values in any way. If any values in any of the rows could include commas or line endings, you shouldn't use this.

    puts DB[:table].to_csv # SELECT * FROM table
    # id,name
    # 1,Jim
    # 2,Bob

    # File lib/sequel/dataset/actions.rb, line 673
    def to_csv(include_column_titles = true)
      Sequel::Deprecation.deprecate('Dataset#to_csv', 'Please load the sequel_3_dataset_methods extension to continue using it')
      n = naked
      cols = n.columns
      csv = ''
      csv << "#{cols.join(COMMA_SEPARATOR)}\r\n" if include_column_titles
      n.each{|r| csv << "#{cols.collect{|c| r[c]}.join(COMMA_SEPARATOR)}\r\n"}
      csv
    end

to_hash(key_column, value_column = nil) click to toggle source

Returns a hash with one column used as key and another used as value. If rows have duplicate values for the key column, the latter row(s) will overwrite the value of the previous row(s). If the value_column is not given or nil, uses the entire hash as the value.

    DB[:table].to_hash(:id, :name) # SELECT * FROM table
    # {1=>'Jim', 2=>'Bob', ...}

    DB[:table].to_hash(:id) # SELECT * FROM table
    # {1=>{:id=>1, :name=>'Jim'}, 2=>{:id=>2, :name=>'Bob'}, ...}

You can also provide an array of column names for either the key_column, the value column, or both:

    DB[:table].to_hash([:id, :foo], [:name, :bar]) # SELECT * FROM table
    # {[1, 3]=>['Jim', 'bo'], [2, 4]=>['Bob', 'be'], ...}

    DB[:table].to_hash([:id, :name]) # SELECT * FROM table
    # {[1, 'Jim']=>{:id=>1, :name=>'Jim'}, [2, 'Bob'=>{:id=>2, :name=>'Bob'}, ...}

    # File lib/sequel/dataset/actions.rb, line 702
    def to_hash(key_column, value_column = nil)
      h = {}
      if value_column
        return naked.to_hash(key_column, value_column) if row_proc
        if value_column.is_a?(Array)
          if key_column.is_a?(Array)
            each{|r| h[r.values_at(*key_column)] = r.values_at(*value_column)}
          else
            each{|r| h[r[key_column]] = r.values_at(*value_column)}
          end
        else
          if key_column.is_a?(Array)
            each{|r| h[r.values_at(*key_column)] = r[value_column]}
          else
            each{|r| h[r[key_column]] = r[value_column]}
          end
        end
      elsif key_column.is_a?(Array)
        each{|r| h[r.values_at(*key_column)] = r}
      else
        each{|r| h[r[key_column]] = r}
      end
      h
    end

to_hash_groups(key_column, value_column = nil) click to toggle source

Returns a hash with one column used as key and the values being an array of column values. If the value_column is not given or nil, uses the entire hash as the value.

    DB[:table].to_hash(:name, :id) # SELECT * FROM table
    # {'Jim'=>[1, 4, 16, ...], 'Bob'=>[2], ...}

    DB[:table].to_hash(:name) # SELECT * FROM table
    # {'Jim'=>[{:id=>1, :name=>'Jim'}, {:id=>4, :name=>'Jim'}, ...], 'Bob'=>[{:id=>2, :name=>'Bob'}], ...}

You can also provide an array of column names for either the key_column, the value column, or both:

    DB[:table].to_hash([:first, :middle], [:last, :id]) # SELECT * FROM table
    # {['Jim', 'Bob']=>[['Smith', 1], ['Jackson', 4], ...], ...}

    DB[:table].to_hash([:first, :middle]) # SELECT * FROM table
    # {['Jim', 'Bob']=>[{:id=>1, :first=>'Jim', :middle=>'Bob', :last=>'Smith'}, ...], ...}

    # File lib/sequel/dataset/actions.rb, line 745
    def to_hash_groups(key_column, value_column = nil)
      h = {}
      if value_column
        return naked.to_hash_groups(key_column, value_column) if row_proc
        if value_column.is_a?(Array)
          if key_column.is_a?(Array)
            each{|r| (h[r.values_at(*key_column)] ||= []) << r.values_at(*value_column)}
          else
            each{|r| (h[r[key_column]] ||= []) << r.values_at(*value_column)}
          end
        else
          if key_column.is_a?(Array)
            each{|r| (h[r.values_at(*key_column)] ||= []) << r[value_column]}
          else
            each{|r| (h[r[key_column]] ||= []) << r[value_column]}
          end
        end
      elsif key_column.is_a?(Array)
        each{|r| (h[r.values_at(*key_column)] ||= []) << r}
      else
        each{|r| (h[r[key_column]] ||= []) << r}
      end
      h
    end

truncate() click to toggle source

Truncates the dataset. Returns nil.

    DB[:table].truncate # TRUNCATE table
    # => nil

    # File lib/sequel/dataset/actions.rb, line 774
    def truncate
      execute_ddl(truncate_sql)
    end

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

Updates values for the dataset. The returned value is generally the number of rows updated, but that is adapter dependent. `values` should a hash where the keys are columns to set and values are the values to which to set the columns.

    DB[:table].update(:x=>nil) # UPDATE table SET x = NULL
    # => 10

    DB[:table].update(:x=>:x+1, :y=>0) # UPDATE table SET x = (x + 1), y = 0
    # => 10

    # File lib/sequel/dataset/actions.rb, line 788
    def update(values={}, &block)
      sql = update_sql(values)
      if uses_returning?(:update)
        returning_fetch_rows(sql, &block)
      else
        execute_dui(sql)
      end
    end

with_sql_delete(sql) click to toggle source

Execute the given SQL and return the number of rows deleted. This exists solely as an optimization, replacing with_sql(sql).delete. It's significantly faster as it does not require cloning the current dataset.

    # File lib/sequel/dataset/actions.rb, line 800
    def with_sql_delete(sql)
      execute_dui(sql)
    end

### Protected Instance Methods

_import(columns, values, opts) click to toggle source

Internals of import. If primary key values are requested, use separate insert commands for each row. Otherwise, call multi_insert_sql and execute each statement it gives separately.

    # File lib/sequel/dataset/actions.rb, line 809
    def _import(columns, values, opts)
      trans_opts = opts.merge(:server=>@opts[:server])
      if opts[:return] == :primary_key
        @db.transaction(trans_opts){values.map{|v| insert(columns, v)}}
      else
        stmts = multi_insert_sql(columns, values)
        @db.transaction(trans_opts){stmts.each{|st| execute_dui(st)}}
      end
    end

_select_map_multiple(ret_cols) click to toggle source

Return an array of arrays of values given by the symbols in ret_cols.

    # File lib/sequel/dataset/actions.rb, line 820
    def _select_map_multiple(ret_cols)
      map{|r| r.values_at(*ret_cols)}
    end

_select_map_single() click to toggle source

Returns an array of the first value in each row.

    # File lib/sequel/dataset/actions.rb, line 825
    def _select_map_single
      map{|r| r.values.first}
    end

## 3 - User Methods relating to SQL Creation ↑ top

These are methods you can call to see what SQL will be generated by the dataset.

### Public Instance Methods

delete_sql() click to toggle source

Returns a DELETE SQL query string. See `delete`.

    dataset.filter{|o| o.price >= 100}.delete_sql
    # => "DELETE FROM items WHERE (price >= 100)"

    # File lib/sequel/dataset/sql.rb, line 12
    def delete_sql
      return static_sql(opts[:sql]) if opts[:sql]
      check_modification_allowed!
      clause_sql(:delete)
    end

exists() click to toggle source

Returns an EXISTS clause for the dataset as a `LiteralString`.

    DB.select(1).where(DB[:items].exists)
    # SELECT 1 WHERE (EXISTS (SELECT * FROM items))

    # File lib/sequel/dataset/sql.rb, line 22
    def exists
      SQL::PlaceholderLiteralString.new(EXISTS, [self], true)
    end

insert_sql(*values) click to toggle source

Returns an INSERT SQL query string. See `insert`.

    DB[:items].insert_sql(:a=>1)
    # => "INSERT INTO items (a) VALUES (1)"

    # File lib/sequel/dataset/sql.rb, line 30
    def insert_sql(*values)
      return static_sql(@opts[:sql]) if @opts[:sql]

      check_modification_allowed!

      columns = []

      case values.size
      when 0
        return insert_sql({})
      when 1
        case vals = values.at(0)
        when Hash
          vals = @opts[:defaults].merge(vals) if @opts[:defaults]
          vals = vals.merge(@opts[:overrides]) if @opts[:overrides]
          values = []
          vals.each do |k,v|
            columns << k
            values << v
          end
        when Dataset, Array, LiteralString
          values = vals
        end
      when 2
        if (v0 = values.at(0)).is_a?(Array) && ((v1 = values.at(1)).is_a?(Array) || v1.is_a?(Dataset) || v1.is_a?(LiteralString))
          columns, values = v0, v1
          raise(Error, "Different number of values and columns given to insert_sql") if values.is_a?(Array) and columns.length != values.length
        end
      end

      if values.is_a?(Array) && values.empty? && !insert_supports_empty_values?
        columns = [columns().last]
        values = [DEFAULT]
      end
      clone(:columns=>columns, :values=>values)._insert_sql
    end

literal_append(sql, v) click to toggle source

Returns a literal representation of a value to be used as part of an SQL expression.

    DB[:items].literal("abc'def\\") #=> "'abc''def\\\\'"
    DB[:items].literal(:items__id) #=> "items.id"
    DB[:items].literal([1, 2, 3]) => "(1, 2, 3)"
    DB[:items].literal(DB[:items]) => "(SELECT * FROM items)"
    DB[:items].literal(:x + 1 > :y) => "((x + 1) > y)"

If an unsupported object is given, an `Error` is raised.

    # File lib/sequel/dataset/sql.rb, line 77
    def literal_append(sql, v)
      case v
      when Symbol
        literal_symbol_append(sql, v)
      when String
        case v
        when LiteralString
          sql << v
        when SQL::Blob
          literal_blob_append(sql, v)
        else
          literal_string_append(sql, v)
        end
      when Integer
        sql << literal_integer(v)
      when Hash
        literal_hash_append(sql, v)
      when SQL::Expression
        literal_expression_append(sql, v)
      when Float
        sql << literal_float(v)
      when BigDecimal
        sql << literal_big_decimal(v)
      when NilClass
        sql << literal_nil
      when TrueClass
        sql << literal_true
      when FalseClass
        sql << literal_false
      when Array
        literal_array_append(sql, v)
      when Time
        sql << (v.is_a?(SQLTime) ? literal_sqltime(v) : literal_time(v))
      when DateTime
        sql << literal_datetime(v)
      when Date
        sql << literal_date(v)
      when Dataset
        literal_dataset_append(sql, v)
      else
        literal_other_append(sql, v)
      end
    end

multi_insert_sql(columns, values) click to toggle source

Returns an array of insert statements for inserting multiple records. This method is used by `multi_insert` to format insert statements and expects a keys array and and an array of value arrays.

This method should be overridden by descendants if the support inserting multiple records in a single SQL statement.

    # File lib/sequel/dataset/sql.rb, line 127
    def multi_insert_sql(columns, values)
      values.map{|r| insert_sql(columns, r)}
    end

select_sql() click to toggle source

Returns a SELECT SQL query string.

    dataset.select_sql # => "SELECT * FROM items"

    # File lib/sequel/dataset/sql.rb, line 134
    def select_sql
      return static_sql(@opts[:sql]) if @opts[:sql]
      clause_sql(:select)
    end

sql() click to toggle source

Same as `select_sql`, not aliased directly to make subclassing simpler.

    # File lib/sequel/dataset/sql.rb, line 140
    def sql
      select_sql
    end

truncate_sql() click to toggle source

Returns a TRUNCATE SQL query string. See `truncate`

    DB[:items].truncate_sql # => 'TRUNCATE items'

    # File lib/sequel/dataset/sql.rb, line 147
    def truncate_sql
      if opts[:sql]
        static_sql(opts[:sql])
      else
        check_truncation_allowed!
        raise(InvalidOperation, "Can't truncate filtered datasets") if opts[:where] || opts[:having]
        t = ''
        source_list_append(t, opts[:from])
        _truncate_sql(t)
      end
    end

update_sql(values = {}) click to toggle source

Formats an UPDATE statement using the given values. See `update`.

    DB[:items].update_sql(:price => 100, :category => 'software')
    # => "UPDATE items SET price = 100, category = 'software'

Raises an `Error` if the dataset is grouped or includes more than one table.

    # File lib/sequel/dataset/sql.rb, line 166
    def update_sql(values = {})
      return static_sql(opts[:sql]) if opts[:sql]
      check_modification_allowed!
      clone(:values=>values)._update_sql
    end

## 4 - Methods that describe what the dataset supports ↑ top

These methods all return booleans, with most describing whether or not the dataset supports a feature.

### Public Instance Methods

provides_accurate_rows_matched?() click to toggle source

Whether this dataset will provide accurate number of rows matched for delete and update statements. Accurate in this case is the number of rows matched by the dataset's filter.

    # File lib/sequel/dataset/features.rb, line 24
    def provides_accurate_rows_matched?
      true
    end

quote_identifiers?() click to toggle source

Whether this dataset quotes identifiers.

    # File lib/sequel/dataset/features.rb, line 10
    def quote_identifiers?
      if defined?(@quote_identifiers)
        @quote_identifiers
      elsif db.respond_to?(:quote_identifiers?)
        @quote_identifiers = db.quote_identifiers?
      else
        Sequel::Deprecation.deprecate('Calling Dataset#quote_identifiers? for a dataset where the database doesn\t implement quote_identifiers? will raise a NoMethodError in Sequel 4.')
        @quote_identifiers = false
      end
    end

recursive_cte_requires_column_aliases?() click to toggle source

Whether you must use a column alias list for recursive CTEs (false by default).

    # File lib/sequel/dataset/features.rb, line 30
    def recursive_cte_requires_column_aliases?
      false
    end

requires_placeholder_type_specifiers?() click to toggle source

Whether type specifiers are required for prepared statement/bound variable argument placeholders (i.e. :bv__integer)

    # File lib/sequel/dataset/features.rb, line 42
    def requires_placeholder_type_specifiers?
      false
    end

requires_sql_standard_datetimes?() click to toggle source

Whether the dataset requires SQL standard datetimes (false by default, as most allow strings with ISO 8601 format).

    # File lib/sequel/dataset/features.rb, line 36
    def requires_sql_standard_datetimes?
      false
    end

supports_cte?(type=:select) click to toggle source

Whether the dataset supports common table expressions (the WITH clause). If given, `type` can be :select, :insert, :update, or :delete, in which case it determines whether WITH is supported for the respective statement type.

    # File lib/sequel/dataset/features.rb, line 49
    def supports_cte?(type=:select)
      send(:"#{type}_clause_methods").include?(:"#{type}_with_sql")
    end

supports_cte_in_subqueries?() click to toggle source

Whether the dataset supports common table expressions (the WITH clause) in subqueries. If false, applies the WITH clause to the main query, which can cause issues if multiple WITH clauses use the same name.

    # File lib/sequel/dataset/features.rb, line 56
    def supports_cte_in_subqueries?
      false
    end

supports_distinct_on?() click to toggle source

Whether the dataset supports or can emulate the DISTINCT ON clause, false by default.

    # File lib/sequel/dataset/features.rb, line 61
    def supports_distinct_on?
      false
    end

supports_group_cube?() click to toggle source

Whether the dataset supports CUBE with GROUP BY.

    # File lib/sequel/dataset/features.rb, line 66
    def supports_group_cube?
      false
    end

supports_group_rollup?() click to toggle source

Whether the dataset supports ROLLUP with GROUP BY.

    # File lib/sequel/dataset/features.rb, line 71
    def supports_group_rollup?
      false
    end

supports_insert_select?() click to toggle source

Whether this dataset supports the `insert_select` method for returning all columns values directly from an insert query.

    # File lib/sequel/dataset/features.rb, line 77
    def supports_insert_select?
      supports_returning?(:insert)
    end

supports_intersect_except?() click to toggle source

Whether the dataset supports the INTERSECT and EXCEPT compound operations, true by default.

    # File lib/sequel/dataset/features.rb, line 82
    def supports_intersect_except?
      true
    end

supports_intersect_except_all?() click to toggle source

Whether the dataset supports the INTERSECT ALL and EXCEPT ALL compound operations, true by default.

    # File lib/sequel/dataset/features.rb, line 87
    def supports_intersect_except_all?
      true
    end

supports_is_true?() click to toggle source

Whether the dataset supports the IS TRUE syntax.

    # File lib/sequel/dataset/features.rb, line 92
    def supports_is_true?
      true
    end

supports_join_using?() click to toggle source

Whether the dataset supports the JOIN table USING (column1, ...) syntax.

    # File lib/sequel/dataset/features.rb, line 97
    def supports_join_using?
      true
    end

supports_modifying_joins?() click to toggle source

Whether modifying joined datasets is supported.

    # File lib/sequel/dataset/features.rb, line 102
    def supports_modifying_joins?
      false
    end

supports_multiple_column_in?() click to toggle source

Whether the IN/NOT IN operators support multiple columns when an array of values is given.

    # File lib/sequel/dataset/features.rb, line 108
    def supports_multiple_column_in?
      true
    end

supports_ordered_distinct_on?() click to toggle source

Whether the dataset supports or can fully emulate the DISTINCT ON clause, including respecting the ORDER BY clause, false by default

    # File lib/sequel/dataset/features.rb, line 114
    def supports_ordered_distinct_on?
      supports_distinct_on?
    end

supports_regexp?() click to toggle source

Whether the dataset supports pattern matching by regular expressions.

    # File lib/sequel/dataset/features.rb, line 119
    def supports_regexp?
      false
    end

supports_returning?(type) click to toggle source

Whether the RETURNING clause is supported for the given type of query. `type` can be :insert, :update, or :delete.

    # File lib/sequel/dataset/features.rb, line 125
    def supports_returning?(type)
      send(:"#{type}_clause_methods").include?(:"#{type}_returning_sql")
    end

supports_select_all_and_column?() click to toggle source

Whether the database supports SELECT *, column FROM table

    # File lib/sequel/dataset/features.rb, line 130
    def supports_select_all_and_column?
      true
    end

supports_timestamp_timezones?() click to toggle source

Whether the dataset supports timezones in literal timestamps

    # File lib/sequel/dataset/features.rb, line 135
    def supports_timestamp_timezones?
      false
    end

supports_timestamp_usecs?() click to toggle source

Whether the dataset supports fractional seconds in literal timestamps

    # File lib/sequel/dataset/features.rb, line 140
    def supports_timestamp_usecs?
      true
    end

supports_where_true?() click to toggle source

Whether the dataset supports WHERE TRUE (or WHERE 1 for databases that that use 1 for true).

    # File lib/sequel/dataset/features.rb, line 151
    def supports_where_true?
      true
    end

supports_window_functions?() click to toggle source

Whether the dataset supports window functions.

    # File lib/sequel/dataset/features.rb, line 145
    def supports_window_functions?
      false
    end

## 5 - Methods related to dataset graphing ↑ top

Dataset graphing changes the dataset to yield hashes where keys are table name symbols and values are hashes representing the columns related to that table. All of these methods return modified copies of the receiver.

### Public Instance Methods

add_graph_aliases(graph_aliases) click to toggle source

Adds the given graph aliases to the list of graph aliases to use, unlike `set_graph_aliases`, which replaces the list (the equivalent of `select_more` when graphing). See `set_graph_aliases`.

    DB[:table].add_graph_aliases(:some_alias=>[:table, :column])
    # SELECT ..., table.column AS some_alias

    # File lib/sequel/dataset/graph.rb, line 16
    def add_graph_aliases(graph_aliases)
      unless ga = opts[:graph_aliases]
        unless opts[:graph] && (ga = opts[:graph][:column_aliases])
          Sequel::Deprecation.deprecate('Calling Dataset#add_graph_aliases before #graph or #set_graph_aliases', 'Please call it after #graph or #set_graph_aliases')
        end
      end
      columns, graph_aliases = graph_alias_columns(graph_aliases)
      select_more(*columns).clone(:graph_aliases => ga.merge(graph_aliases))
    end

graph(dataset, join_conditions = nil, options = {}, &block) click to toggle source

Similar to Dataset#join_table, but uses unambiguous aliases for selected columns and keeps metadata about the aliases for use in other methods.

Arguments:

dataset | Can be a symbol (specifying a table), another dataset, or an object that responds to `dataset` and returns a symbol or a dataset
join_conditions | Any condition(s) allowed by `join_table`.
block | A block that is passed to `join_table`.

Options:

:from_self_alias | The alias to use when the receiver is not a graphed dataset but it contains multiple FROM tables or a JOIN. In this case, the receiver is wrapped in a from_self before graphing, and this option determines the alias to use.
:implicit_qualifier | The qualifier of implicit conditions, see join_table.
:join_type | The type of join to use (passed to `join_table`). Defaults to :left_outer.
:qualify | The type of qualification to do, see join_table.
:select | An array of columns to select. When not used, selects all columns in the given dataset. When set to false, selects no columns and is like simply joining the tables, though graph keeps some metadata about the join that makes it important to use `graph` instead of `join_table`.
:table_alias | The alias to use for the table. If not specified, doesn't alias the table. You will get an error if the the alias (or table) name is used more than once.

    # File lib/sequel/dataset/graph.rb, line 51
    def graph(dataset, join_conditions = nil, options = {}, &block)
      # Allow the use of a dataset or symbol as the first argument
      # Find the table name/dataset based on the argument
      table_alias = options[:table_alias]
      case dataset
      when Symbol
        table = dataset
        dataset = @db[dataset]
        table_alias ||= table
      when ::Sequel::Dataset
        if dataset.simple_select_all?
          table = dataset.opts[:from].first
          table_alias ||= table
        else
          table = dataset
          table_alias ||= dataset_alias((@opts[:num_dataset_sources] || 0)+1)
        end
      else
        raise Error, "The dataset argument should be a symbol or dataset"
      end

      # Raise Sequel::Error with explanation that the table alias has been used
      raise_alias_error = lambda do
        raise(Error, "this #{options[:table_alias] ? 'alias' : 'table'} has already been been used, please specify "            "#{options[:table_alias] ? 'a different alias' : 'an alias via the :table_alias option'}")
      end

      # Only allow table aliases that haven't been used
      raise_alias_error.call if @opts[:graph] && @opts[:graph][:table_aliases] && @opts[:graph][:table_aliases].include?(table_alias)

      # Use a from_self if this is already a joined table
      ds = (!@opts[:graph] && (@opts[:from].length > 1 || @opts[:join])) ? from_self(:alias=>options[:from_self_alias] || first_source) : self

      # Join the table early in order to avoid cloning the dataset twice
      ds = ds.join_table(options[:join_type] || :left_outer, table, join_conditions, :table_alias=>table_alias, :implicit_qualifier=>options[:implicit_qualifier], :qualify=>options[:qualify], &block)
      opts = ds.opts

      # Whether to include the table in the result set
      add_table = options[:select] == false ? false : true
      # Whether to add the columns to the list of column aliases
      add_columns = !ds.opts.include?(:graph_aliases)

      # Setup the initial graph data structure if it doesn't exist
      if graph = opts[:graph]
        opts[:graph] = graph = graph.dup
        select = opts[:select].dup
        [:column_aliases, :table_aliases, :column_alias_num].each{|k| graph[k] = graph[k].dup}
      else
        master = alias_symbol(ds.first_source_alias)
        raise_alias_error.call if master == table_alias
        # Master hash storing all .graph related information
        graph = opts[:graph] = {}
        # Associates column aliases back to tables and columns
        column_aliases = graph[:column_aliases] = {}
        # Associates table alias (the master is never aliased)
        table_aliases = graph[:table_aliases] = {master=>self}
        # Keep track of the alias numbers used
        ca_num = graph[:column_alias_num] = Hash.new(0)
        # All columns in the master table are never
        # aliased, but are not included if set_graph_aliases
        # has been used.
        if add_columns
          if (select = @opts[:select]) && !select.empty? && !(select.length == 1 && (select.first.is_a?(SQL::ColumnAll)))
            select = select.each do |sel|
              column = case sel
              when Symbol
                _, c, a = split_symbol(sel)
                (a || c).to_sym
              when SQL::Identifier
                sel.value.to_sym
              when SQL::QualifiedIdentifier
                column = sel.column
                column = column.value if column.is_a?(SQL::Identifier)
                column.to_sym
              when SQL::AliasedExpression
                column = sel.aliaz
                column = column.value if column.is_a?(SQL::Identifier)
                column.to_sym
              else
                raise Error, "can't figure out alias to use for graphing for #{sel.inspect}"
              end
              column_aliases[column] = [master, column]
            end
            select = qualified_expression(select, master)
          else
            select = columns.map do |column|
              column_aliases[column] = [master, column]
              SQL::QualifiedIdentifier.new(master, column)
            end
          end
        end
      end

      # Add the table alias to the list of aliases
      # Even if it isn't been used in the result set,
      # we add a key for it with a nil value so we can check if it
      # is used more than once
      table_aliases = graph[:table_aliases]
      table_aliases[table_alias] = add_table ? dataset : nil

      # Add the columns to the selection unless we are ignoring them
      if add_table && add_columns
        column_aliases = graph[:column_aliases]
        ca_num = graph[:column_alias_num]
        # Which columns to add to the result set
        cols = options[:select] || dataset.columns
        # If the column hasn't been used yet, don't alias it.
        # If it has been used, try table_column.
        # If that has been used, try table_column_N
        # using the next value of N that we know hasn't been
        # used
        cols.each do |column|
          col_alias, identifier = if column_aliases[column]
            column_alias = :"#{table_alias}_#{column}"
            if column_aliases[column_alias]
              column_alias_num = ca_num[column_alias]
              column_alias = :"#{column_alias}_#{column_alias_num}"
              ca_num[column_alias] += 1
            end
            [column_alias, SQL::AliasedExpression.new(SQL::QualifiedIdentifier.new(table_alias, column), column_alias)]
          else
            ident = SQL::QualifiedIdentifier.new(table_alias, column)
            [column, ident]
          end
          column_aliases[col_alias] = [table_alias, column]
          select.push(identifier)
        end
      end
      add_columns ? ds.select(*select) : ds
    end

set_graph_aliases(graph_aliases) click to toggle source

This allows you to manually specify the graph aliases to use when using graph. You can use it to only select certain columns, and have those columns mapped to specific aliases in the result set. This is the equivalent of `select` for a graphed dataset, and must be used instead of `select` whenever graphing is used.

graph_aliases

Should be a hash with keys being symbols of column aliases, and values being either symbols or arrays with one to three elements. If the value is a symbol, it is assumed to be the same as a one element array containing that symbol. The first element of the array should be the table alias symbol. The second should be the actual column name symbol. If the array only has a single element the column name symbol will be assumed to be the same as the corresponding hash key. If the array has a third element, it is used as the value returned, instead of table_alias.column_name.

    DB[:artists].graph(:albums, :artist_id=>:id).
      set_graph_aliases(:name=>:artists,
                        :album_name=>[:albums, :name],
                        :forty_two=>[:albums, :fourtwo, 42]).first
    # SELECT artists.name, albums.name AS album_name, 42 AS forty_two ...

    # File lib/sequel/dataset/graph.rb, line 205
    def set_graph_aliases(graph_aliases)
      columns, graph_aliases = graph_alias_columns(graph_aliases)
      ds = select(*columns)
      ds.opts[:graph_aliases] = graph_aliases
      ds
    end

ungraphed() click to toggle source

Remove the splitting of results into subhashes, and all metadata related to the current graph (if any).

    # File lib/sequel/dataset/graph.rb, line 214
    def ungraphed
      clone(:graph=>nil, :graph_aliases=>nil)
    end

## 6 - Miscellaneous methods ↑ top

These methods don't fit cleanly into another section.

### Constants

ARG_BLOCK_ERROR_MSG
ARRAY_ACCESS_ERROR_MSG
IMPORT_ERROR_MSG
NOTIMPL_MSG

### Attributes

db[R]

The database related to this dataset. This is the Database instance that will execute all of this dataset's queries.

opts[R]

The hash of options for this dataset, keys are symbols.

### Public Class Methods

new(db, opts = (no_arg_given=true; nil)) click to toggle source

Constructs a new Dataset instance with an associated database and options. Datasets are usually constructed by invoking the Database#[] method:

    DB[:posts]

Sequel::Dataset is an abstract class that is not useful by itself. Each database adapter provides a subclass of Sequel::Dataset, and has the Database#dataset method return an instance of that subclass.

    # File lib/sequel/dataset/misc.rb, line 49
    def initialize(db, opts = (no_arg_given=true; nil))
      @db = db
      # REMOVE40
      Sequel::Deprecation.deprecate('Passing the opts argument to Database#dataset or Dataset#initialize', 'Clone the dataset afterward to change the opts') unless no_arg_given
      @opts = opts || {}.extend(DeprecateModifyHash)
    end

### Public Instance Methods

==(o) click to toggle source

Define a hash value such that datasets with the same DB, opts, and SQL will be considered equal.

    # File lib/sequel/dataset/misc.rb, line 58
    def ==(o)
      o.is_a?(self.class) && db == o.db && opts == o.opts && sql == o.sql
    end

db=(v) click to toggle source

REMOVE40

    # File lib/sequel/dataset/misc.rb, line 21
    def db=(v)
      Sequel::Deprecation.deprecate('Dataset#db=', 'Please load the sequel_3_dataset_methods extension to continue using it')
      @db = v
    end

each_server() click to toggle source

Yield a dataset for each server in the connection pool that is tied to that server. Intended for use in sharded environments where all servers need to be modified with the same data:

    DB[:configs].where(:key=>'setting').each_server{|ds| ds.update(:value=>'new_value')}

    # File lib/sequel/dataset/misc.rb, line 72
    def each_server
      db.servers.each{|s| yield server(s)}
    end

eql?(o) click to toggle source

Alias for ==

    # File lib/sequel/dataset/misc.rb, line 63
    def eql?(o)
      self == o
    end

escape_like(string) click to toggle source

Returns the string with the LIKE metacharacters (% and _) escaped. Useful for when the LIKE term is a user-provided string where metacharacters should not be recognized. Example:

    ds.escape_like("foo\\%_") # 'foo\\\%\_'

    # File lib/sequel/dataset/misc.rb, line 81
    def escape_like(string)
      string.gsub(/[\\%_]/){|m| "\\#{m}"}
    end

first_source() click to toggle source

Alias of `first_source_alias`

    # File lib/sequel/dataset/misc.rb, line 86
    def first_source
      first_source_alias
    end

first_source_alias() click to toggle source

The first source (primary table) for this dataset. If the dataset doesn't have a table, raises an `Error`. If the table is aliased, returns the aliased name.

    DB[:table].first_source_alias
    # => :table

    DB[:table___t].first_source_alias
    # => :t

    # File lib/sequel/dataset/misc.rb, line 98
    def first_source_alias
      source = @opts[:from]
      if source.nil? || source.empty?
        raise Error, 'No source specified for query'
      end
      case s = source.first
      when SQL::AliasedExpression
        s.aliaz
      when Symbol
        _, _, aliaz = split_symbol(s)
        aliaz ? aliaz.to_sym : s
      else
        s
      end
    end

first_source_table() click to toggle source

The first source (primary table) for this dataset. If the dataset doesn't have a table, raises an error. If the table is aliased, returns the original table, not the alias

    DB[:table].first_source_table
    # => :table

    DB[:table___t].first_source_table
    # => :table

    # File lib/sequel/dataset/misc.rb, line 123
    def first_source_table
      source = @opts[:from]
      if source.nil? || source.empty?
        raise Error, 'No source specified for query'
      end
      case s = source.first
      when SQL::AliasedExpression
        s.expression
      when Symbol
        sch, table, aliaz = split_symbol(s)
        aliaz ? (sch ? SQL::QualifiedIdentifier.new(sch, table) : table.to_sym) : s
      else
        s
      end
    end

hash() click to toggle source

Define a hash value such that datasets with the same DB, opts, and SQL will have the same hash value

    # File lib/sequel/dataset/misc.rb, line 141
    def hash
      [db, opts, sql].hash
    end

identifier_input_method() click to toggle source

The String instance method to call on identifiers before sending them to the database.

    # File lib/sequel/dataset/misc.rb, line 147
    def identifier_input_method
      if defined?(@identifier_input_method)
        @identifier_input_method
      elsif db.respond_to?(:identifier_input_method)
        @identifier_input_method = db.identifier_input_method
      else
        Sequel::Deprecation.deprecate('Calling Dataset#identifier_input_method for a dataset where the database doesn\t implement identifier_input_method will raise a NoMethodError in Sequel 4.')
        @identifier_input_method = nil
      end
    end

identifier_output_method() click to toggle source

The String instance method to call on identifiers before sending them to the database.

    # File lib/sequel/dataset/misc.rb, line 160
    def identifier_output_method
      if defined?(@identifier_output_method)
        @identifier_output_method
      elsif db.respond_to?(:identifier_output_method)
        @identifier_output_method = db.identifier_output_method
      else
        Sequel::Deprecation.deprecate('Calling Dataset#identifier_output_method for a dataset where the database doesn\t implement identifier_output_method will raise a NoMethodError in Sequel 4.')
        @identifier_output_method = nil
      end
    end

inspect() click to toggle source

Returns a string representation of the dataset including the class name and the corresponding SQL select statement.

    # File lib/sequel/dataset/misc.rb, line 173
    def inspect
      c = self.class
      c = c.superclass while c.name.nil? || c.name == ''
      "#<#{c.name}: #{sql.inspect}>"
    end

opts=(v) click to toggle source

    # File lib/sequel/dataset/misc.rb, line 25
    def opts=(v)
      Sequel::Deprecation.deprecate('Dataset#opts=', 'Please load the sequel_3_dataset_methods extension to continue using it')
      @opts = v
    end

row_number_column() click to toggle source

The alias to use for the row_number column, used when emulating OFFSET support and for eager limit strategies

    # File lib/sequel/dataset/misc.rb, line 181
    def row_number_column
      :x_sequel_row_number_x
    end

split_alias(c) click to toggle source

Splits a possible implicit alias in `c`, handling both SQL::AliasedExpressions and Symbols. Returns an array of two elements, with the first being the main expression, and the second being the alias.

    # File lib/sequel/dataset/misc.rb, line 188
    def split_alias(c)
      case c
      when Symbol
        c_table, column, aliaz = split_symbol(c)
        [c_table ? SQL::QualifiedIdentifier.new(c_table, column.to_sym) : column.to_sym, aliaz]
      when SQL::AliasedExpression
        [c.expression, c.aliaz]
      when SQL::JoinClause
        [c.table, c.table_alias]
      else
        [c, nil]
      end
    end

unused_table_alias(table_alias, used_aliases = []) click to toggle source

Creates a unique table alias that hasn't already been used in the dataset. table_alias can be any type of object accepted by alias_symbol. The symbol returned will be the implicit alias in the argument, possibly appended with "_N" if the implicit alias has already been used, where N is an integer starting at 0 and increasing until an unused one is found.

You can provide a second addition array argument containing symbols that should not be considered valid table aliases. The current aliases for the FROM and JOIN tables are automatically included in this array.

    DB[:table].unused_table_alias(:t)
    # => :t

    DB[:table].unused_table_alias(:table)
    # => :table_0

    DB[:table, :table_0].unused_table_alias(:table)
    # => :table_1

    DB[:table, :table_0].unused_table_alias(:table, [:table_1, :table_2])
    # => :table_3

    # File lib/sequel/dataset/misc.rb, line 224
    def unused_table_alias(table_alias, used_aliases = [])
      table_alias = alias_symbol(table_alias)
      used_aliases += opts[:from].map{|t| alias_symbol(t)} if opts[:from]
      used_aliases += opts[:join].map{|j| j.table_alias ? alias_alias_symbol(j.table_alias) : alias_symbol(j.table)} if opts[:join]
      if used_aliases.include?(table_alias)
        i = 0
        loop do
          ta = :"#{table_alias}_#{i}"
          return ta unless used_aliases.include?(ta)
          i += 1
        end
      else
        table_alias
      end
    end

## 7 - Mutation methods ↑ top

These methods modify the receiving dataset and should be used with care.

### Constants

MUTATION_METHODS

  All methods that should have a ! method added that modifies the receiver.

### Attributes

identifier_input_method[W]

Set the method to call on identifiers going into the database for this dataset

identifier_output_method[W]

Set the method to call on identifiers coming the database for this dataset

quote_identifiers[W]

Whether to quote identifiers for this dataset

row_proc[RW]

The row_proc for this database, should be any object that responds to `call` with a single hash argument and returns the object you want each to return.

### Public Class Methods

def_mutation_method(*meths) click to toggle source

Setup mutation (e.g. filter!) methods. These operate the same as the non-! methods, but replace the options of the current dataset with the options of the resulting dataset.

Do not call this method with untrusted input, as that can result in arbitrary code execution.

    # File lib/sequel/dataset/mutation.rb, line 17
    def self.def_mutation_method(*meths)
      options = meths.pop if meths.last.is_a?(Hash)
      mod = options[:module] if options
      mod ||= self
      meths.each do |meth|
        mod.class_eval("def #{meth}!(*args, &block); mutation_method(:#{meth}, *args, &block) end", __FILE__, __LINE__)
      end
    end

### Public Instance Methods

extension!(*exts) click to toggle source

Load an extension into the receiver. In addition to requiring the extension file, this also modifies the dataset to work with the extension (usually extending it with a module defined in the extension file). If no related extension file exists or the extension does not have specific support for Database objects, an Error will be raised. Returns self.

    # File lib/sequel/dataset/mutation.rb, line 47
    def extension!(*exts)
      Sequel.extension(*exts)
      exts.each do |ext|
        if pr = Sequel.synchronize{EXTENSIONS[ext]}
          pr.call(self)
        else
          raise(Error, "Extension #{ext} does not have specific support handling individual datasets")
        end
      end
      self
    end

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

Avoid self-referential dataset by cloning.

    # File lib/sequel/dataset/mutation.rb, line 60
    def from_self!(*args, &block)
      @opts = clone.from_self(*args, &block).opts
      self
    end

naked!() click to toggle source

Remove the row_proc from the current dataset.

    # File lib/sequel/dataset/mutation.rb, line 66
    def naked!
      self.row_proc = nil
      self
    end

## 8 - Methods related to prepared statements or bound variables ↑ top

On some adapters, these use native prepared statements and bound variables, on others support is emulated. For details, see the "Prepared Statements/Bound Variables" guide.

### Constants

PREPARED_ARG_PLACEHOLDER

### Public Instance Methods

bind(bind_vars={}) click to toggle source

Set the bind variables to use for the call. If bind variables have already been set for this dataset, they are updated with the contents of bind_vars.

    DB[:table].filter(:id=>:$id).bind(:id=>1).call(:first)
    # SELECT * FROM table WHERE id = ? LIMIT 1 -- (1)
    # => {:id=>1}

    # File lib/sequel/dataset/prepared_statements.rb, line 217
    def bind(bind_vars={})
      clone(:bind_vars=>@opts[:bind_vars] ? @opts[:bind_vars].merge(bind_vars) : bind_vars)
    end

call(type, bind_variables={}, *values, &block) click to toggle source

For the given type (:select, :first, :insert, :insert_select, :update, or :delete), run the sql with the bind variables specified in the hash. `values` is a hash passed to insert or update (if one of those types is used), which may contain placeholders.

    DB[:table].filter(:id=>:$id).call(:first, :id=>1)
    # SELECT * FROM table WHERE id = ? LIMIT 1 -- (1)
    # => {:id=>1}

    # File lib/sequel/dataset/prepared_statements.rb, line 228
    def call(type, bind_variables={}, *values, &block)
      prepare(type, nil, *values).call(bind_variables, &block)
    end

prepare(type, name=nil, *values) click to toggle source

Prepare an SQL statement for later execution. Takes a type similar to call, and the `name` symbol of the prepared statement. While `name` defaults to `nil`, it should always be provided as a symbol for the name of the prepared statement, as some databases require that prepared statements have names.

This returns a clone of the dataset extended with PreparedStatementMethods, which you can `call` with the hash of bind variables to use. The prepared statement is also stored in the associated database, where it can be called by name. The following usage is identical:

    ps = DB[:table].filter(:name=>:$name).prepare(:first, :select_by_name)

    ps.call(:name=>'Blah')
    # SELECT * FROM table WHERE name = ? -- ('Blah')
    # => {:id=>1, :name=>'Blah'}

    DB.call(:select_by_name, :name=>'Blah') # Same thing

    # File lib/sequel/dataset/prepared_statements.rb, line 250
    def prepare(type, name=nil, *values)
      ps = to_prepared_statement(type, values)
      db.set_prepared_statement(name, ps) if name
      ps
    end

### Protected Instance Methods

to_prepared_statement(type, values=nil) click to toggle source

Return a cloned copy of the current dataset extended with PreparedStatementMethods, setting the type and modify values.

    # File lib/sequel/dataset/prepared_statements.rb, line 260
    def to_prepared_statement(type, values=nil)
      ps = bind
      ps.extend(PreparedStatementMethods)
      ps.orig_dataset = self
      ps.prepared_type = type
      ps.prepared_modify_values = values
      ps
    end

## 9 - Internal Methods relating to SQL Creation ↑ top

These methods, while public, are not designed to be used directly by the end user.

### Constants

ALL
AND_SEPARATOR
APOS
APOS_RE
ARRAY_EMPTY
AS
ASC
BACKSLASH
BOOL_FALSE
BOOL_TRUE
BRACKET_CLOSE
BRACKET_OPEN
CASE_ELSE
CASE_END
CASE_OPEN
CASE_THEN
CASE_WHEN
CAST_OPEN
COLUMN_REF_RE1
COLUMN_REF_RE2
COLUMN_REF_RE3
COMMA
COMMA_SEPARATOR
CONDITION_FALSE
CONDITION_TRUE
COUNT_FROM_SELF_OPTS
COUNT_OF_ALL_AS_COUNT
DATASET_ALIAS_BASE_NAME
DEFAULT
DEFAULT_VALUES
DELETE
DELETE_CLAUSE_METHODS
DESC
DISTINCT
DOT
DOUBLE_APOS
DOUBLE_QUOTE
EMULATED_FUNCTION_MAP

  Map of emulated function names to native function names.

EQUAL
ESCAPE
EXISTS
EXTRACT
FORMAT_DATE
FORMAT_DATE_STANDARD
FORMAT_OFFSET
FORMAT_TIMESTAMP_RE
FORMAT_TIMESTAMP_USEC
FORMAT_USEC
FOR_UPDATE
FRAME_ALL
FRAME_ROWS
FROM
FUNCTION_EMPTY
GROUP_BY
HAVING
INSERT
INSERT_CLAUSE_METHODS
INTO
IS_LITERALS
IS_OPERATORS
LIKE_OPERATORS
LIMIT
NOT_SPACE
NULL
NULLS_FIRST
NULLS_LAST
N_ARITY_OPERATORS
OFFSET
ON
ON_PAREN
ORDER_BY
ORDER_BY_NS
OVER
PAREN_CLOSE
PAREN_OPEN
PAREN_SPACE_OPEN
PARTITION_BY
PRIVATE_APPEND_METHODS
PUBLIC_APPEND_METHODS
QUALIFY_KEYS
QUESTION_MARK
QUESTION_MARK_RE
QUOTE
QUOTE_RE
REGEXP_OPERATORS
RETURNING
SELECT
SELECT_CLAUSE_METHODS
SET
SPACE
SPACE_WITH
SQL_WITH
STANDARD_TIMESTAMP_FORMAT
TILDE
TIMESTAMP_FORMAT
TWO_ARITY_OPERATORS
UNDERSCORE
UPDATE
UPDATE_CLAUSE_METHODS
USING
V190
VALUES
WHERE
WILDCARD

### Public Class Methods

clause_methods(type, clauses) click to toggle source

Given a type (e.g. select) and an array of clauses, return an array of methods to call to build the SQL string.

    # File lib/sequel/dataset/sql.rb, line 179
    def self.clause_methods(type, clauses)
      clauses.map{|clause| :"#{type}_#{clause}_sql"}.freeze
    end

def_append_methods(meths) click to toggle source

For each of the methods in the given array, define a method with that name that returns a string with the SQL fragment that the related *_append method would add.

Do not call this method with untrusted input, as that can result in arbitrary code execution.

    # File lib/sequel/dataset/sql.rb, line 338
    def self.def_append_methods(meths)
      Sequel::Deprecation.deprecate('Dataset.def_append_methods', "There is no replacement planned")
      meths.each do |meth|
        class_eval(          def #{meth}(*args, &block)            s = ''            #{meth}_append(s, *args, &block)            s          end, __FILE__, __LINE__ + 1)
      end
    end

### Public Instance Methods

aliased_expression_sql_append(sql, ae) click to toggle source

SQL fragment for AliasedExpression

    # File lib/sequel/dataset/sql.rb, line 373
    def aliased_expression_sql_append(sql, ae)
      literal_append(sql, ae.expression)
      as_sql_append(sql, ae.aliaz)
    end

array_sql_append(sql, a) click to toggle source

SQL fragment for Array

    # File lib/sequel/dataset/sql.rb, line 379
    def array_sql_append(sql, a)
      if a.empty?
        sql << ARRAY_EMPTY
      else
        sql << PAREN_OPEN
        expression_list_append(sql, a)
        sql << PAREN_CLOSE
      end
    end

boolean_constant_sql_append(sql, constant) click to toggle source

SQL fragment for BooleanConstants

    # File lib/sequel/dataset/sql.rb, line 390
    def boolean_constant_sql_append(sql, constant)
      if (constant == true || constant == false) && !supports_where_true?
        sql << (constant == true ? CONDITION_TRUE : CONDITION_FALSE)
      else
        literal_append(sql, constant)
      end
    end

case_expression_sql_append(sql, ce) click to toggle source

SQL fragment for CaseExpression

    # File lib/sequel/dataset/sql.rb, line 399
    def case_expression_sql_append(sql, ce)
      sql << CASE_OPEN
      if ce.expression?
        sql << SPACE
        literal_append(sql, ce.expression)
      end
      w = CASE_WHEN
      t = CASE_THEN
      ce.conditions.each do |c,r|
        sql << w
        literal_append(sql, c)
        sql << t
        literal_append(sql, r)
      end
      sql << CASE_ELSE
      literal_append(sql, ce.default)
      sql << CASE_END
    end

cast_sql_append(sql, expr, type) click to toggle source

SQL fragment for the SQL CAST expression

    # File lib/sequel/dataset/sql.rb, line 419
    def cast_sql_append(sql, expr, type)
      sql << CAST_OPEN
      literal_append(sql, expr)
      sql << AS << db.cast_type_literal(type).to_s
      sql << PAREN_CLOSE
    end

column_all_sql_append(sql, ca) click to toggle source

SQL fragment for specifying all columns in a given table

    # File lib/sequel/dataset/sql.rb, line 427
    def column_all_sql_append(sql, ca)
      qualified_identifier_sql_append(sql, ca.table, WILDCARD)
    end

complex_expression_sql_append(sql, op, args) click to toggle source

SQL fragment for the complex expression.

    # File lib/sequel/dataset/sql.rb, line 432
    def complex_expression_sql_append(sql, op, args)
      case op
      when *IS_OPERATORS
        r = args.at(1)
        if r.nil? || supports_is_true?
          raise(InvalidOperation, 'Invalid argument used for IS operator') unless val = IS_LITERALS[r]
          sql << PAREN_OPEN
          literal_append(sql, args.at(0))
          sql << SPACE << op.to_s << SPACE
          sql << val << PAREN_CLOSE
        elsif op == :IS
          complex_expression_sql_append(sql, :"=", args)
        else
          complex_expression_sql_append(sql, :OR, [SQL::BooleanExpression.new(:"!=", *args), SQL::BooleanExpression.new(:IS, args.at(0), nil)])
        end
      when :IN, :"NOT IN"
        cols = args.at(0)
        vals = args.at(1)
        col_array = true if cols.is_a?(Array)
        if vals.is_a?(Array)
          val_array = true
          empty_val_array = vals == []
        end
        if empty_val_array
          literal_append(sql, empty_array_value(op, cols))
        elsif col_array
          if !supports_multiple_column_in?
            if val_array
              expr = SQL::BooleanExpression.new(:OR, *vals.to_a.map{|vs| SQL::BooleanExpression.from_value_pairs(cols.to_a.zip(vs).map{|c, v| [c, v]})})
              literal_append(sql, op == :IN ? expr : ~expr)
            else
              old_vals = vals
              vals = vals.naked if vals.is_a?(Sequel::Dataset)
              vals = vals.to_a
              val_cols = old_vals.columns
              complex_expression_sql_append(sql, op, [cols, vals.map!{|x| x.values_at(*val_cols)}])
            end
          else
            # If the columns and values are both arrays, use array_sql instead of
            # literal so that if values is an array of two element arrays, it
            # will be treated as a value list instead of a condition specifier.
            sql << PAREN_OPEN
            literal_append(sql, cols)
            sql << SPACE << op.to_s << SPACE
            if val_array
              array_sql_append(sql, vals)
            else
              literal_append(sql, vals)
            end
            sql << PAREN_CLOSE
          end
        else
          sql << PAREN_OPEN
          literal_append(sql, cols)
          sql << SPACE << op.to_s << SPACE
          literal_append(sql, vals)
          sql << PAREN_CLOSE
        end
      when :LIKE, :'NOT LIKE'
        sql << PAREN_OPEN
        literal_append(sql, args.at(0))
        sql << SPACE << op.to_s << SPACE
        literal_append(sql, args.at(1))
        sql << ESCAPE
        literal_append(sql, BACKSLASH)
        sql << PAREN_CLOSE
      when :ILIKE, :'NOT ILIKE'
        complex_expression_sql_append(sql, (op == :ILIKE ? :LIKE : :"NOT LIKE"), args.map{|v| Sequel.function(:UPPER, v)})
      when *TWO_ARITY_OPERATORS
        if REGEXP_OPERATORS.include?(op) && !supports_regexp?
          raise InvalidOperation, "Pattern matching via regular expressions is not supported on #{db.database_type}"
        end
        sql << PAREN_OPEN
        literal_append(sql, args.at(0))
        sql << SPACE << op.to_s << SPACE
        literal_append(sql, args.at(1))
        sql << PAREN_CLOSE
      when *N_ARITY_OPERATORS
        sql << PAREN_OPEN
        c = false
        op_str = " #{op} "
        args.each do |a|
          sql << op_str if c
          literal_append(sql, a)
          c ||= true
        end
        sql << PAREN_CLOSE
      when :NOT
        sql << NOT_SPACE
        literal_append(sql, args.at(0))
      when :NOOP
        literal_append(sql, args.at(0))
      when :'B~'
        sql << TILDE
        literal_append(sql, args.at(0))
      when :extract
        sql << EXTRACT << args.at(0).to_s << FROM
        literal_append(sql, args.at(1))
        sql << PAREN_CLOSE
      else
        raise(InvalidOperation, "invalid operator #{op}")
      end
    end

constant_sql_append(sql, constant) click to toggle source

SQL fragment for constants

    # File lib/sequel/dataset/sql.rb, line 537
    def constant_sql_append(sql, constant)
      sql << constant.to_s
    end

delayed_evaluation_sql_append(sql, callable) click to toggle source

SQL fragment for delayed evaluations, evaluating the object and literalizing the returned value.

    # File lib/sequel/dataset/sql.rb, line 543
    def delayed_evaluation_sql_append(sql, callable)
      literal_append(sql, callable.call)
    end

emulated_function_sql_append(sql, f) click to toggle source

SQL fragment specifying an emulated SQL function call. By default, assumes just the function name may need to be emulated, adapters should set an EMULATED_FUNCTION_MAP hash mapping emulated functions to native functions in their dataset class to setup the emulation.

    # File lib/sequel/dataset/sql.rb, line 552
    def emulated_function_sql_append(sql, f)
      _function_sql_append(sql, native_function_name(f.f), f.args)
    end

function_sql_append(sql, f) click to toggle source

SQL fragment specifying an SQL function call without emulation.

    # File lib/sequel/dataset/sql.rb, line 557
    def function_sql_append(sql, f)
      _function_sql_append(sql, f.f, f.args)
    end

join_clause_sql_append(sql, jc) click to toggle source

SQL fragment specifying a JOIN clause without ON or USING.

    # File lib/sequel/dataset/sql.rb, line 562
    def join_clause_sql_append(sql, jc)
      table = jc.table
      table_alias = jc.table_alias
      table_alias = nil if table == table_alias
      sql << SPACE << join_type_sql(jc.join_type) << SPACE
      identifier_append(sql, table)
      as_sql_append(sql, table_alias) if table_alias
    end

join_on_clause_sql_append(sql, jc) click to toggle source

SQL fragment specifying a JOIN clause with ON.

    # File lib/sequel/dataset/sql.rb, line 572
    def join_on_clause_sql_append(sql, jc)
      join_clause_sql_append(sql, jc)
      sql << ON
      literal_append(sql, filter_expr(jc.on))
    end

join_using_clause_sql_append(sql, jc) click to toggle source

SQL fragment specifying a JOIN clause with USING.

    # File lib/sequel/dataset/sql.rb, line 579
    def join_using_clause_sql_append(sql, jc)
      join_clause_sql_append(sql, jc)
      sql << USING
      column_list_append(sql, jc.using)
      sql << PAREN_CLOSE
    end

negative_boolean_constant_sql_append(sql, constant) click to toggle source

SQL fragment for NegativeBooleanConstants

    # File lib/sequel/dataset/sql.rb, line 587
    def negative_boolean_constant_sql_append(sql, constant)
      sql << NOT_SPACE
      boolean_constant_sql_append(sql, constant)
    end

ordered_expression_sql_append(sql, oe) click to toggle source

SQL fragment for the ordered expression, used in the ORDER BY clause.

    # File lib/sequel/dataset/sql.rb, line 594
    def ordered_expression_sql_append(sql, oe)
      literal_append(sql, oe.expression)
      sql << (oe.descending ? DESC : ASC)
      case oe.nulls
      when :first
        sql << NULLS_FIRST
      when :last
        sql << NULLS_LAST
      end
    end

placeholder_literal_string_sql_append(sql, pls) click to toggle source

SQL fragment for a literal string with placeholders

    # File lib/sequel/dataset/sql.rb, line 606
    def placeholder_literal_string_sql_append(sql, pls)
      args = pls.args
      str = pls.str
      sql << PAREN_OPEN if pls.parens
      if args.is_a?(Hash)
        re = /:(#{args.keys.map{|k| Regexp.escape(k.to_s)}.join('|')})\b/
        loop do
          previous, q, str = str.partition(re)
          sql << previous
          literal_append(sql, args[($1||q[1..-1].to_s).to_sym]) unless q.empty?
          break if str.empty?
        end
      elsif str.is_a?(Array)
        len = args.length
        str.each_with_index do |s, i|
          sql << s
          literal_append(sql, args[i]) unless i == len
        end
        unless str.length == args.length || str.length == args.length + 1
          Sequel::Deprecation.deprecate("Using a mismatched number of placeholders (#{str.length}) and placeholder arguments (#{args.length}) is deprecated and will raise an Error in Sequel 4.")
        end
      else
        i = -1
        loop do
          previous, q, str = str.partition(QUESTION_MARK)
          sql << previous
          literal_append(sql, args.at(i+=1)) unless q.empty?
          if str.empty?
            unless i + 1 == args.length
              Sequel::Deprecation.deprecate("Using a mismatched number of placeholders (#{i+1}) and placeholder arguments (#{args.length}) is deprecated and will raise an Error in Sequel 4.")
            end
            break
          end
        end
      end
      sql << PAREN_CLOSE if pls.parens
    end

qualified_identifier_sql_append(sql, table, column=(c = table.column; table = table.table; c)) click to toggle source

SQL fragment for the qualifed identifier, specifying a table and a column (or schema and table). If 3 arguments are given, the 2nd should be the table/qualifier and the third should be column/qualified. If 2 arguments are given, the 2nd should be an SQL::QualifiedIdentifier.

    # File lib/sequel/dataset/sql.rb, line 648
    def qualified_identifier_sql_append(sql, table, column=(c = table.column; table = table.table; c))
      identifier_append(sql, table)
      sql << DOT
      identifier_append(sql, column)
    end

quote_identifier_append(sql, name) click to toggle source

Adds quoting to identifiers (columns and tables). If identifiers are not being quoted, returns name as a string. If identifiers are being quoted quote the name with quoted_identifier.

    # File lib/sequel/dataset/sql.rb, line 657
    def quote_identifier_append(sql, name)
      if name.is_a?(LiteralString)
        sql << name
      else
        name = name.value if name.is_a?(SQL::Identifier)
        name = input_identifier(name)
        if quote_identifiers?
          quoted_identifier_append(sql, name)
        else
          sql << name
        end
      end
    end

quote_schema_table_append(sql, table) click to toggle source

Separates the schema from the table and returns a string with them quoted (if quoting identifiers)

    # File lib/sequel/dataset/sql.rb, line 673
    def quote_schema_table_append(sql, table)
      schema, table = schema_and_table(table)
      if schema
        quote_identifier_append(sql, schema)
        sql << DOT
      end
      quote_identifier_append(sql, table)
    end

quoted_identifier_append(sql, name) click to toggle source

This method quotes the given name with the SQL standard double quote. should be overridden by subclasses to provide quoting not matching the SQL standard, such as backtick (used by MySQL and SQLite).

    # File lib/sequel/dataset/sql.rb, line 685
    def quoted_identifier_append(sql, name)
      sql << QUOTE << name.to_s.gsub(QUOTE_RE, DOUBLE_QUOTE) << QUOTE
    end

schema_and_table(table_name, sch=(db._default_schema if db)) click to toggle source

Split the schema information from the table, returning two strings, one for the schema and one for the table. The returned schema may be nil, but the table will always have a string value.

Note that this function does not handle tables with more than one level of qualification (e.g. database.schema.table on Microsoft SQL Server).

    # File lib/sequel/dataset/sql.rb, line 696
    def schema_and_table(table_name, sch=(db._default_schema if db))
      sch = sch.to_s if sch
      case table_name
      when Symbol
        s, t, _ = split_symbol(table_name)
        [s||sch, t]
      when SQL::QualifiedIdentifier
        [table_name.table.to_s, table_name.column.to_s]
      when SQL::Identifier
        [sch, table_name.value.to_s]
      when String
        [sch, table_name]
      else
        raise Error, 'table_name should be a Symbol, SQL::QualifiedIdentifier, SQL::Identifier, or String'
      end
    end

split_qualifiers(table_name, *args) click to toggle source

Splits table_name into an array of strings.

    ds.split_qualifiers(:s) # ['s']
    ds.split_qualifiers(:t__s) # ['t', 's']
    ds.split_qualifiers(Sequel.qualify(:d, :t__s)) # ['d', 't', 's']
    ds.split_qualifiers(Sequel.qualify(:h__d, :t__s)) # ['h', 'd', 't', 's']

    # File lib/sequel/dataset/sql.rb, line 719
    def split_qualifiers(table_name, *args)
      case table_name
      when SQL::QualifiedIdentifier
        split_qualifiers(table_name.table, nil) + split_qualifiers(table_name.column, nil)
      else
        sch, table = schema_and_table(table_name, *args)
        sch ? [sch, table] : [table]
      end
    end

subscript_sql_append(sql, s) click to toggle source

SQL fragment for specifying subscripts (SQL array accesses)

    # File lib/sequel/dataset/sql.rb, line 730
    def subscript_sql_append(sql, s)
      literal_append(sql, s.f)
      sql << BRACKET_OPEN
      expression_list_append(sql, s.sub)
      sql << BRACKET_CLOSE
    end

window_function_sql_append(sql, function, window) click to toggle source

The SQL fragment for the given window function's function and window.

    # File lib/sequel/dataset/sql.rb, line 779
    def window_function_sql_append(sql, function, window)
      literal_append(sql, function)
      sql << OVER
      literal_append(sql, window)
    end

window_sql_append(sql, opts) click to toggle source

The SQL fragment for the given window's options.

    # File lib/sequel/dataset/sql.rb, line 738
    def window_sql_append(sql, opts)
      raise(Error, 'This dataset does not support window functions') unless supports_window_functions?
      sql << PAREN_OPEN
      window, part, order, frame = opts.values_at(:window, :partition, :order, :frame)
      space = false
      space_s = SPACE
      if window
        literal_append(sql, window)
        space = true
      end
      if part
        sql << space_s if space
        sql << PARTITION_BY
        expression_list_append(sql, Array(part))
        space = true
      end
      if order
        sql << space_s if space
        sql << ORDER_BY_NS
        expression_list_append(sql, Array(order))
        space = true
      end
      case frame
        when nil
          # nothing
        when :all
          sql << space_s if space
          sql << FRAME_ALL
        when :rows
          sql << space_s if space
          sql << FRAME_ROWS
        when String
          sql << space_s if space
          sql << frame
        else
          raise Error, "invalid window frame clause, should be :all, :rows, a string, or nil"
      end
      sql << PAREN_CLOSE
    end

### Protected Instance Methods

_insert_sql() click to toggle source

Formats in INSERT statement using the stored columns and values.

    # File lib/sequel/dataset/sql.rb, line 788
    def _insert_sql
      clause_sql(:insert)
    end

_update_sql() click to toggle source

Formats an UPDATE statement using the stored values.

    # File lib/sequel/dataset/sql.rb, line 793
    def _update_sql
      clause_sql(:update)
    end

compound_from_self() click to toggle source

Return a from_self dataset if an order or limit is specified, so it works as expected with UNION, EXCEPT, and INTERSECT clauses.

    # File lib/sequel/dataset/sql.rb, line 799
    def compound_from_self
      (@opts[:limit] || @opts[:order]) ? from_self : self
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.