class Sequel::Dataset
A dataset represents an SQL query. Datasets can be used to select, insert, 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].where(author: 'david') # no records are retrieved my_posts.all # records are retrieved my_posts.all # records are retrieved again
Datasets are frozen and use a functional style where modification methods return modified copies of the the dataset. This allows you to reuse datasets:
posts = DB[:posts] davids_posts = posts.where(author: 'david') old_posts = posts.where{stamp < Date.today - 7} davids_old_posts = davids_posts.where{stamp < Date.today - 7}
Datasets are Enumerable objects, so they can be manipulated using many of
the Enumerable methods, such as map
and inject
.
Note that there are some methods that Dataset
defines that override methods defined in Enumerable and result in different
behavior, such as select
and group_by
.
For more information, see the “Dataset Basics” guide.
Constants
- OPTS
- TRUE_FREEZE
Whether #freeze can actually freeze datasets. True only on ruby 2.4+, as it requires clone(freeze: false)
1 - Methods that return modified datasets
↑ topConstants
- 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.
- EMPTY_ARRAY
- 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).
- EXTENSION_MODULES
Hash of extension name symbols to modules to load to implement 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
- SIMPLE_SELECT_ALL_ALLOWED_FROM
From types allowed to be considered a simple_select_all
- UNCONDITIONED_JOIN_TYPES
These symbols have _join methods created (e.g. natural_join). They accept a table argument and options hash which is passed to #join_table, and they raise an error if called with a block.
Public Class Methods
Register an extension callback for Dataset objects. ext should be the extension name symbol, and mod should be a Module that will be included in the dataset's class. 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)} Sequel.synchronize{EXTENSION_MODULES[ext] = mod} else block = mod end end unless mod.is_a?(Module) Sequel::Deprecation.deprecate("Providing a block or non-module to Sequel::Dataset.register_extension is deprecated and support for it will be removed in Sequel 6.") end Sequel.synchronize{EXTENSIONS[ext] = block} end
Public Instance Methods
Save original clone implementation, as some other methods need to call it internally.
Returns a new clone of the dataset 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 || (return self)) # return self used above because clone is called by almost all # other query methods, and it is the fastest approach c = super(:freeze=>false) c.opts.merge!(opts) unless opts.each_key{|o| break if COLUMN_CHANGE_OPTS.include?(o)} c.clear_columns_cache end c.freeze end
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. If a block is given, it is treated as a virtual row block, similar
to where
. 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 DB[:items].order(:id).distinct{func(:id)} # SQL: SELECT DISTINCT ON (func(id)) * FROM items ORDER BY id
There is support for emulating the DISTINCT ON support in MySQL, but it does not support the ORDER of the dataset, and also doesn't work in many cases if the ONLY_FULL_GROUP_BY sql_mode is used, which is the default on MySQL 5.7.5+.
# File lib/sequel/dataset/query.rb, line 128 def distinct(*args, &block) virtual_row_columns(args, block) if args.empty? return self if opts[:distinct] == EMPTY_ARRAY cached_dataset(:_distinct_ds){clone(:distinct => EMPTY_ARRAY)} else raise(InvalidOperation, "DISTINCT ON not supported") unless supports_distinct_on? clone(:distinct => args.freeze) end end
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 156 def except(dataset, opts=OPTS) 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
Performs the inverse of #where. 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))
Also note that SQL uses 3-valued boolean logic
(true
, false
, NULL
), so the inverse
of a true condition is a false condition, and will still not match rows
that were NULL originally. If you take the earlier example:
DB[:items].exclude(category: 'software') # SELECT * FROM items WHERE (category != 'software')
Note that this does not match rows where category
is
NULL
. This is because NULL
is an unknown value,
and you do not know whether or not the NULL
category is
software
. You can explicitly specify how to handle
NULL
values if you want:
DB[:items].exclude(Sequel.~(category: nil) & {category: 'software'}) # SELECT * FROM items WHERE ((category IS NULL) OR (category != 'software'))
# File lib/sequel/dataset/query.rb, line 186 def exclude(*cond, &block) add_filter(:where, cond, true, &block) end
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)
See documentation for exclude for how inversion is handled in regards to SQL 3-valued boolean logic.
# File lib/sequel/dataset/query.rb, line 197 def exclude_having(*cond, &block) add_filter(:having, cond, true, &block) end
Return a clone of the dataset loaded with the given dataset extensions. If no related extension file exists or the extension does not have specific support for Dataset objects, an error will be raised.
# File lib/sequel/dataset/query.rb, line 205 def extension(*exts) Sequel.extension(*exts) mods = exts.map{|ext| Sequel.synchronize{EXTENSION_MODULES[ext]}} if mods.all? with_extend(*mods) else with_extend(DeprecatedSingletonClassMethods).extension(*exts) end end
Alias for where.
# File lib/sequel/dataset/query.rb, line 225 def filter(*cond, &block) where(*cond, &block) end
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 232 def for_update return self if opts[:lock] == :update cached_dataset(:_for_update_ds){lock_style(:update)} end
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. If a block is
given, it is treated as a virtual row block, similar to where
.
DB[:items].from # SQL: SELECT * DB[:items].from(:blah) # SQL: SELECT * FROM blah DB[:items].from(:blah, :foo) # SQL: SELECT * FROM blah, foo DB[:items].from{fun(arg)} # SQL: SELECT * FROM fun(arg)
# File lib/sequel/dataset/query.rb, line 246 def from(*source, &block) virtual_row_columns(source, block) table_alias_num = 0 ctes = nil source.map! do |s| case s when Dataset if hoist_cte?(s) ctes ||= [] ctes += s.opts[:with] s = s.clone(:with=>nil) end 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) SQL::AliasedExpression.new(s, aliaz.to_sym) else s end else s end end o = {:from=>source.empty? ? nil : source.freeze} o[:with] = ((opts[:with] || EMPTY_ARRAY) + ctes).freeze if ctes o[:num_dataset_sources] = table_alias_num if table_alias_num > 0 clone(o) end
Returns a dataset selecting from the current dataset. Options:
- :alias
-
Controls the alias of the table
- :column_aliases
-
Also aliases columns, using derived column lists. Only used in conjunction with :alias.
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 ds.from_self(alias: :foo, column_aliases: [:c1, :c2]) # SELECT * FROM (SELECT id, name FROM items ORDER BY name) AS foo(c1, c2)
# File lib/sequel/dataset/query.rb, line 294 def from_self(opts=OPTS) fs = {} @opts.keys.each{|k| fs[k] = nil unless non_sql_option?(k)} pr = proc do c = clone(fs).from(opts[:alias] ? as(opts[:alias], opts[:column_aliases]) : self) if cols = _columns c.send(:columns=, cols) end c end opts.empty? ? cached_dataset(:_from_self_ds, &pr) : pr.call end
Match any of the columns to any of the patterns. The terms can be strings (which use LIKE) or regular expressions if the database supports that. 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%' ESCAPE '\') dataset.grep([:a, :b], %w'%test% foo') # SELECT * FROM items WHERE ((a LIKE '%test%' ESCAPE '\') OR (a LIKE 'foo' ESCAPE '\') # OR (b LIKE '%test%' ESCAPE '\') OR (b LIKE 'foo' ESCAPE '\')) dataset.grep([:a, :b], %w'%foo% %bar%', all_patterns: true) # SELECT * FROM a WHERE (((a LIKE '%foo%' ESCAPE '\') OR (b LIKE '%foo%' ESCAPE '\')) # AND ((a LIKE '%bar%' ESCAPE '\') OR (b LIKE '%bar%' ESCAPE '\'))) dataset.grep([:a, :b], %w'%foo% %bar%', all_columns: true) # SELECT * FROM a WHERE (((a LIKE '%foo%' ESCAPE '\') OR (a LIKE '%bar%' ESCAPE '\')) # AND ((b LIKE '%foo%' ESCAPE '\') OR (b LIKE '%bar%' ESCAPE '\'))) dataset.grep([:a, :b], %w'%foo% %bar%', all_patterns: true, all_columns: true) # SELECT * FROM a WHERE ((a LIKE '%foo%' ESCAPE '\') AND (b LIKE '%foo%' ESCAPE '\') # AND (a LIKE '%bar%' ESCAPE '\') AND (b LIKE '%bar%' ESCAPE '\'))
# File lib/sequel/dataset/query.rb, line 343 def grep(columns, patterns, opts=OPTS) column_op = opts[:all_columns] ? :AND : :OR if opts[:all_patterns] conds = Array(patterns).map do |pat| SQL::BooleanExpression.new(column_op, *Array(columns).map{|c| SQL::StringExpression.like(c, pat, opts)}) end where(SQL::BooleanExpression.new(:AND, *conds)) else conds = Array(columns).map do |c| SQL::BooleanExpression.new(:OR, *Array(patterns).map{|pat| SQL::StringExpression.like(c, pat, opts)}) end where(SQL::BooleanExpression.new(column_op, *conds)) end end
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 where
.
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 365 def group(*columns, &block) virtual_row_columns(columns, block) clone(:group => (columns.compact.empty? ? nil : columns.freeze)) end
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
where
.
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(Sequel[:first_name].as(: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 396 def group_and_count(*columns, &block) select_group(*columns, &block).select_append(COUNT_OF_ALL_AS_COUNT) end
Returns a copy of the dataset with the given columns added to the list of existing columns to group on. If no existing columns are present this method simply sets the columns as the initial ones to group on.
DB[:items].group_append(:b) # SELECT * FROM items GROUP BY b DB[:items].group(:a).group_append(:b) # SELECT * FROM items GROUP BY a, b
# File lib/sequel/dataset/query.rb, line 406 def group_append(*columns, &block) columns = @opts[:group] + columns if @opts[:group] group(*columns, &block) end
Alias of group
# File lib/sequel/dataset/query.rb, line 371 def group_by(*columns, &block) group(*columns, &block) end
Adds the appropriate CUBE syntax to GROUP BY.
# File lib/sequel/dataset/query.rb, line 412 def group_cube raise Error, "GROUP BY CUBE not supported on #{db.database_type}" unless supports_group_cube? clone(:group_options=>:cube) end
Adds the appropriate ROLLUP syntax to GROUP BY.
# File lib/sequel/dataset/query.rb, line 418 def group_rollup raise Error, "GROUP BY ROLLUP not supported on #{db.database_type}" unless supports_group_rollup? clone(:group_options=>:rollup) end
Adds the appropriate GROUPING SETS syntax to GROUP BY.
# File lib/sequel/dataset/query.rb, line 424 def grouping_sets raise Error, "GROUP BY GROUPING SETS not supported on #{db.database_type}" unless supports_grouping_sets? clone(:group_options=>:"grouping sets") end
Returns a copy of the dataset with the HAVING conditions changed. See where 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 433 def having(*cond, &block) add_filter(:having, cond, &block) end
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 454 def intersect(dataset, opts=OPTS) 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
Inverts the current WHERE and HAVING clauses. If there is neither a WHERE or HAVING clause, adds a WHERE clause that is always false.
DB[:items].where(category: 'software').invert # SELECT * FROM items WHERE (category != 'software') DB[:items].where(category: 'software', id: 3).invert # SELECT * FROM items WHERE ((category != 'software') OR (id != 3))
See documentation for exclude for how inversion is handled in regards to SQL 3-valued boolean logic.
# File lib/sequel/dataset/query.rb, line 471 def invert cached_dataset(:_invert_ds) do having, where = @opts.values_at(:having, :where) if having.nil? && where.nil? where(false) else o = {} o[:having] = SQL::BooleanExpression.invert(having) if having o[:where] = SQL::BooleanExpression.invert(where) if where clone(o) end end end
Alias of inner_join
# File lib/sequel/dataset/query.rb, line 486 def join(*args, &block) inner_join(*args, &block) end
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
-
table to join into the current dataset. Generally one of the following types:
- String, Symbol
-
identifier used as table or view name
- Dataset
-
a subselect is performed with an alias of tN for some value of N
- SQL::Function
-
set returning function
- SQL::AliasedExpression
-
already aliased expression. Uses given alias unless overridden by the :table_alias option.
- expr
-
conditions used when joining, depends on type:
- Hash, Array of pairs
-
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.
- otherwise
-
Treats the argument as a filter expression, 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 the following keys supported:
- :table_alias
-
Override the table alias used when joining. In general you shouldn't use this option, you should provide the appropriate SQL::AliasedExpression as the table argument.
- :implicit_qualifier
-
The name to use for qualifying implicit conditions. By default, the last joined or primary table is used.
- :join_using
-
Force the using of JOIN USING, even if
expr
is not an array of symbols. - :reset_implicit_qualifier
-
Can set to false to ignore this join when future joins determine qualifier for implicit conditions.
- :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. Can be set to :symbol to only qualify symbols. 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
where
, 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, Sequel[:b].as(: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 550 def join_table(type, table, expr=nil, options=OPTS, &block) if hoist_cte?(table) s, ds = hoist_cte(table) return s.join_table(type, ds, expr, options, &block) end using_join = options[:join_using] || (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 table_alias = options[:table_alias] if table.is_a?(SQL::AliasedExpression) table_expr = if table_alias SQL::AliasedExpression.new(table.expression, table_alias, table.columns) else table end table = table_expr.expression table_name = table_alias = table_expr.alias elsif 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 table_expr = SQL::AliasedExpression.new(table, table_alias) else table, implicit_table_alias = split_alias(table) table_alias ||= implicit_table_alias table_name = table_alias || table table_expr = table_alias ? SQL::AliasedExpression.new(table, table_alias) : table end join = if expr.nil? and !block SQL::JoinClause.new(type, table_expr) 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_expr) else last_alias = options[:implicit_qualifier] || @opts[:last_joined_table] || first_source_alias qualify_type = options[:qualify] if Sequel.condition_specifier?(expr) expr = expr.map 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(table_name).transform(k) v = Sequel::Qualifier.new(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] || EMPTY_ARRAY) expr = expr ? SQL::BooleanExpression.new(:AND, expr, expr2) : expr2 end SQL::JoinOnClause.new(expr, type, table_expr) end opts = {:join => ((@opts[:join] || EMPTY_ARRAY) + [join]).freeze} opts[:last_joined_table] = table_name unless options[:reset_implicit_qualifier] == false opts[:num_dataset_sources] = table_alias_num if table_alias_num clone(opts) end
Marks this dataset as a lateral dataset. If used in another dataset's FROM or JOIN clauses, it will surround the subquery with LATERAL to enable it to deal with previous tables in the query:
DB.from(:a, DB[:b].where(Sequel[:a][:c]=>Sequel[:b][:d]).lateral) # SELECT * FROM a, LATERAL (SELECT * FROM b WHERE (a.c = b.d))
# File lib/sequel/dataset/query.rb, line 644 def lateral return self if opts[:lateral] cached_dataset(:_lateral_ds){clone(:lateral=>true)} end
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 659 def limit(l, o = (no_offset = true; nil)) return from_self.limit(l, o) if @opts[:sql] if l.is_a?(Range) no_offset = false 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 ds = clone(:limit=>l) ds = ds.offset(o) unless no_offset ds end
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 DB[:items].lock_style('FOR UPDATE OF table1 SKIP LOCKED') # SELECT * FROM items FOR UPDATE OF table1 SKIP LOCKED
# File lib/sequel/dataset/query.rb, line 689 def lock_style(style) clone(:lock => style) end
Return a dataset with a WHEN MATCHED THEN DELETE clause added to the MERGE statement. If a block is passed, treat it as a virtual row and use it as additional conditions for the match.
merge_delete # WHEN MATCHED THEN DELETE merge_delete{a > 30} # WHEN MATCHED AND (a > 30) THEN DELETE
# File lib/sequel/dataset/query.rb, line 702 def merge_delete(&block) _merge_when(:type=>:delete, &block) end
Return a dataset with a WHEN NOT MATCHED THEN INSERT clause added to the MERGE statement. If a block is passed, treat it as a virtual row and use it as additional conditions for the match.
The arguments provided can be any arguments that would be accepted by insert.
merge_insert(i1: :i2, a: Sequel[:b]+11) # WHEN NOT MATCHED THEN INSERT (i1, a) VALUES (i2, (b + 11)) merge_insert(:i2, Sequel[:b]+11){a > 30} # WHEN NOT MATCHED AND (a > 30) THEN INSERT VALUES (i2, (b + 11))
# File lib/sequel/dataset/query.rb, line 718 def merge_insert(*values, &block) _merge_when(:type=>:insert, :values=>values, &block) end
Return a dataset with a WHEN MATCHED THEN UPDATE clause added to the MERGE statement. If a block is passed, treat it as a virtual row and use it as additional conditions for the match.
merge_update(i1: Sequel[:i1]+:i2+10, a: Sequel[:a]+:b+20) # WHEN MATCHED THEN UPDATE SET i1 = (i1 + i2 + 10), a = (a + b + 20) merge_update(i1: :i2){a > 30} # WHEN MATCHED AND (a > 30) THEN UPDATE SET i1 = i2
# File lib/sequel/dataset/query.rb, line 731 def merge_update(values, &block) _merge_when(:type=>:update, :values=>values, &block) end
Return a dataset with the source and join condition to use for the MERGE statement.
merge_using(:m2, i1: :i2) # USING m2 ON (i1 = i2)
# File lib/sequel/dataset/query.rb, line 739 def merge_using(source, join_condition) clone(:merge_using => [source, join_condition].freeze) end
Returns a cloned dataset without a row_proc.
ds = DB[:items].with_row_proc(:invert.to_proc) ds.all # => [{2=>:id}] ds.naked.all # => [{:id=>2}]
# File lib/sequel/dataset/query.rb, line 748 def naked return self unless opts[:row_proc] cached_dataset(:_naked_ds){with_row_proc(nil)} end
Returns a copy of the dataset that will raise a DatabaseLockTimeout instead of waiting for rows that are locked by another transaction
DB[:items].for_update.nowait # SELECT * FROM items FOR UPDATE NOWAIT
# File lib/sequel/dataset/query.rb, line 758 def nowait return self if opts[:nowait] cached_dataset(:_nowait_ds) do raise(Error, 'This dataset does not support raises errors instead of waiting for locked rows') unless supports_nowait? clone(:nowait=>true) end end
Returns a copy of the dataset with a specified order. Can be safely combined with limit. If you call limit with an offset, it will override the offset if you've called offset first.
DB[:items].offset(10) # SELECT * FROM items OFFSET 10
# File lib/sequel/dataset/query.rb, line 771 def offset(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 clone(:offset => o) end
Adds an alternate filter to an existing WHERE clause using OR. If there is no WHERE clause, then the default is WHERE true, and OR would be redundant, so return the dataset in that case.
DB[:items].where(:a).or(:b) # SELECT * FROM items WHERE a OR b DB[:items].or(:b) # SELECT * FROM items
# File lib/sequel/dataset/query.rb, line 785 def or(*cond, &block) if @opts[:where].nil? self else add_filter(:where, cond, false, :OR, &block) end end
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
where
.
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(Sequel[: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 807 def order(*columns, &block) virtual_row_columns(columns, block) clone(:order => (columns.compact.empty?) ? nil : columns.freeze) end
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_append(:b) # SELECT * FROM items ORDER BY a, b
# File lib/sequel/dataset/query.rb, line 817 def order_append(*columns, &block) columns = @opts[:order] + columns if @opts[:order] order(*columns, &block) end
Alias of order
# File lib/sequel/dataset/query.rb, line 823 def order_by(*columns, &block) order(*columns, &block) end
Alias of order_append.
# File lib/sequel/dataset/query.rb, line 828 def order_more(*columns, &block) order_append(*columns, &block) end
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 837 def order_prepend(*columns, &block) ds = order(*columns, &block) @opts[:order] ? ds.order_append(*@opts[:order]) : ds end
Qualify to the given table, or first source if no table is given.
DB[:items].where(id: 1).qualify # SELECT items.* FROM items WHERE (items.id = 1) DB[:items].where(id: 1).qualify(:i) # SELECT i.* FROM items WHERE (i.id = 1)
# File lib/sequel/dataset/query.rb, line 849 def qualify(table=(cache=true; first_source)) o = @opts return self if o[:sql] pr = proc do h = {} (o.keys & QUALIFY_KEYS).each do |k| h[k] = qualified_expression(o[k], table) end h[:select] = [SQL::ColumnAll.new(table)].freeze if !o[:select] || o[:select].empty? clone(h) end cache ? cached_dataset(:_qualify_ds, &pr) : pr.call end
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 DB[:items].returning.insert(a: 1) do |hash| # hash for each row inserted, with values for all columns end DB[:items].returning.update(a: 1) do |hash| # hash for each row updated, with values for all columns end DB[:items].returning.delete(a: 1) do |hash| # hash for each row deleted, with values for all columns end
# File lib/sequel/dataset/query.rb, line 883 def returning(*values) if values.empty? return self if opts[:returning] == EMPTY_ARRAY cached_dataset(:_returning_ds) do raise Error, "RETURNING is not supported on #{db.database_type}" unless supports_returning?(:insert) clone(:returning=>EMPTY_ARRAY) end else raise Error, "RETURNING is not supported on #{db.database_type}" unless supports_returning?(:insert) clone(:returning=>values.freeze) end end
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 903 def reverse(*order, &block) if order.empty? && !block cached_dataset(:_reverse_ds){order(*invert_order(@opts[:order]))} else virtual_row_columns(order, block) order(*invert_order(order.empty? ? @opts[:order] : order.freeze)) end end
Alias of reverse
# File lib/sequel/dataset/query.rb, line 913 def reverse_order(*order, &block) reverse(*order, &block) end
Returns a copy of the dataset with the columns selected changed to the
given columns. This also takes a virtual row block, similar to
where
.
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 924 def select(*columns, &block) virtual_row_columns(columns, block) clone(:select => columns.freeze) end
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 936 def select_all(*tables) if tables.empty? return self unless opts[:select] cached_dataset(:_select_all_ds){clone(:select => nil)} else select(*tables.map{|t| i, a = split_alias(t); a || i}.map!{|t| SQL::ColumnAll.new(t)}.freeze) end end
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 952 def select_append(*columns, &block) virtual_row_columns(columns, block) select(*(_current_select(true) + columns)) end
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 where
.
DB[:items].select_group(:a, :b) # SELECT a, b FROM items GROUP BY a, b DB[:items].select_group(Sequel[:c].as(:a)){f(c2)} # SELECT c AS a, f(c2) FROM items GROUP BY c, f(c2)
# File lib/sequel/dataset/query.rb, line 966 def select_group(*columns, &block) virtual_row_columns(columns, block) select(*columns).group(*columns.map{|c| unaliased_identifier(c)}) end
Alias for select_append.
# File lib/sequel/dataset/query.rb, line 972 def select_more(*columns, &block) select_append(*columns, &block) end
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_prepend(:b) # SELECT b, a FROM items DB[:items].select_prepend(:b) # SELECT b, * FROM items
# File lib/sequel/dataset/query.rb, line 983 def select_prepend(*columns, &block) virtual_row_columns(columns, block) select(*(columns + _current_select(false))) end
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 997 def server(servr) clone(:server=>servr) end
If the database uses sharding and the current dataset has not had a server set, return a cloned dataset that uses the given server. Otherwise, return the receiver directly instead of returning a clone.
# File lib/sequel/dataset/query.rb, line 1004 def server?(server) if db.sharded? && !opts[:server] server(server) else self end end
Specify that the check for limits/offsets when updating/deleting be skipped for the dataset.
# File lib/sequel/dataset/query.rb, line 1013 def skip_limit_check return self if opts[:skip_limit_check] cached_dataset(:_skip_limit_check_ds) do clone(:skip_limit_check=>true) end end
Skip locked rows when returning results from this dataset.
# File lib/sequel/dataset/query.rb, line 1021 def skip_locked return self if opts[:skip_locked] cached_dataset(:_skip_locked_ds) do raise(Error, 'This dataset does not support skipping locked rows') unless supports_skip_locked? clone(:skip_locked=>true) end end
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 1033 def unfiltered return self unless opts[:where] || opts[:having] cached_dataset(:_unfiltered_ds){clone(:where => nil, :having => nil)} end
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 1042 def ungrouped return self unless opts[:group] || opts[:having] cached_dataset(:_ungrouped_ds){clone(:group => nil, :having => nil)} end
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 1063 def union(dataset, opts=OPTS) compound_clone(:union, dataset, opts) end
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 1070 def unlimited return self unless opts[:limit] || opts[:offset] cached_dataset(:_unlimited_ds){clone(:limit=>nil, :offset=>nil)} end
Returns a copy of the dataset with no order.
DB[:items].order(:a).unordered # SELECT * FROM items
# File lib/sequel/dataset/query.rb, line 1078 def unordered return self unless opts[:order] cached_dataset(:_unordered_ds){clone(:order=>nil)} end
Returns a copy of the dataset with the given WHERE conditions imposed upon it.
Accepts the following argument types:
- Hash, Array of pairs
-
list of equality/inclusion expressions
- Symbol
-
taken as a boolean column argument (e.g. WHERE active)
- Sequel::SQL::BooleanExpression, Sequel::LiteralString
-
an existing condition expression, probably created using the Sequel expression filter DSL.
where also accepts 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].where(id: 3) # SELECT * FROM items WHERE (id = 3) DB[:items].where(Sequel.lit('price < ?', 100)) # SELECT * FROM items WHERE price < 100 DB[:items].where([[:id, [1,2,3]], [:id, 0..10]]) # SELECT * FROM items WHERE ((id IN (1, 2, 3)) AND ((id >= 0) AND (id <= 10))) DB[:items].where(Sequel.lit('price < 100')) # SELECT * FROM items WHERE price < 100 DB[:items].where(:active) # SELECT * FROM items WHERE :active DB[:items].where{price < 100} # SELECT * FROM items WHERE (price < 100)
Multiple where calls can be chained for scoping:
software = dataset.where(category: 'software').where{price < 100} # SELECT * FROM items WHERE ((category = 'software') AND (price < 100))
See the “Dataset Filtering” guide for more examples and details.
# File lib/sequel/dataset/query.rb, line 1125 def where(*cond, &block) add_filter(:where, cond, &block) end
Return a clone of the dataset with an addition named window that can be referenced in window functions. See Sequel::SQL::Window for a list of options that can be passed in. Example:
DB[:items].window(:w, partition: :c1, order: :c2) # SELECT * FROM items WINDOW w AS (PARTITION BY c1 ORDER BY c2)
# File lib/sequel/dataset/query.rb, line 1135 def window(name, opts) clone(:window=>((@opts[:window]||EMPTY_ARRAY) + [[name, SQL::Window.new(opts)].freeze]).freeze) end
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
- :materialized
-
Set to false to force inlining of the CTE, or true to force not inlining the CTE (PostgreSQL 12+/SQLite 3.35+).
DB[:items].with(:items, DB[:syx].where(Sequel[:name].like('A%'))) # WITH items AS (SELECT * FROM syx WHERE (name LIKE 'A%' ESCAPE '\')) SELECT * FROM items
# File lib/sequel/dataset/query.rb, line 1150 def with(name, dataset, opts=OPTS) raise(Error, 'This dataset 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]||EMPTY_ARRAY) + [Hash[opts].merge!(:name=>name, :dataset=>dataset)]).freeze) end end
Create a subclass of the receiver's class, and include the given modules into it. If a block is provided, a DatasetModule is created using the block and is included into the subclass. Create an instance of the subclass using the same db and opts, so that the returned dataset operates similarly to a clone extended with the given modules. This approach is used to avoid singleton classes, which significantly improves performance.
Note that like Object#extend, when multiple modules are provided as arguments the subclass includes the modules in reverse order.
# File lib/sequel/dataset/query.rb, line 1239 def with_extend(*mods, &block) c = Class.new(self.class) c.include(*mods) unless mods.empty? c.include(DatasetModule.new(&block)) if block o = c.freeze.allocate o.instance_variable_set(:@db, @db) o.instance_variable_set(:@opts, @opts) o.instance_variable_set(:@cache, {}) if cols = cache_get(:_columns) o.send(:columns=, cols) end o.freeze end
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.
PostgreSQL 14+ Options:
- :cycle
-
Stop recursive searching when a cycle is detected. Includes two columns in the result of the CTE, a cycle column indicating whether a cycle was detected for the current row, and a path column for the path traversed to get to the current row. If given, must be a hash with the following keys:
- :columns
-
(required) The column or array of columns to use to detect a cycle. If the value of these columns match columns already traversed, then a cycle is detected, and recursive searching will not traverse beyond the cycle (the CTE will include the row where the cycle was detected).
- :cycle_column
-
The name of the cycle column in the output, defaults to :is_cycle.
- :cycle_value
-
The value of the cycle column in the output if the current row was detected as a cycle, defaults to true.
- :noncycle_value
-
The value of the cycle column in the output if the current row was not detected as a cycle, defaults to false. Only respected if :cycle_value is given.
- :path_column
-
The name of the path column in the output, defaults to :path.
- :search
-
Include an order column in the result of the CTE that allows for breadth or depth first searching. If given, must be a hash with the following keys:
- :by
-
(required) The column or array of columns to search by.
- :order_column
-
The name of the order column in the output, defaults to :ordercol.
- :type
-
Set to :breadth to use breadth-first searching (depth-first searching is the default).
DB[:t].with_recursive(:t, DB[:i1].select(:id, :parent_id).where(parent_id: nil), DB[:i1].join(:t, id: :parent_id).select(Sequel[:i1][:id], Sequel[: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 DB[:t].with_recursive(:t, DB[:i1].where(parent_id: nil), DB[:i1].join(:t, id: :parent_id).select_all(:i1), search: {by: :id, type: :breadth}, cycle: {columns: :id, cycle_value: 1, noncycle_value: 2}) # WITH RECURSIVE t AS ( # SELECT * FROM i1 WHERE (parent_id IS NULL) # UNION ALL # (SELECT i1.* FROM i1 INNER JOIN t ON (t.id = i1.parent_id)) # ) # SEARCH BREADTH FIRST BY id SET ordercol # CYCLE id SET is_cycle TO 1 DEFAULT 2 USING path # SELECT * FROM t
# File lib/sequel/dataset/query.rb, line 1216 def with_recursive(name, nonrecursive, recursive, opts=OPTS) raise(Error, 'This dataset 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]||EMPTY_ARRAY) + [Hash[opts].merge!(:recursive=>true, :name=>name, :dataset=>nonrecursive.union(recursive, {:all=>opts[:union_all] != false, :from_self=>false}))]).freeze) end end
Returns a cloned dataset with the given row_proc.
ds = DB[:items] ds.all # => [{:id=>2}] ds.with_row_proc(:invert.to_proc).all # => [{2=>:id}]
# File lib/sequel/dataset/query.rb, line 1268 def with_row_proc(callable) clone(:row_proc=>callable) end
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)
Note that datasets that specify custom SQL using this method will generally ignore future dataset methods that modify the SQL used, as specifying custom SQL overrides Sequel's SQL generator. You should probably limit yourself to the following dataset methods when using this method, or use the implicit_subquery extension:
-
each
-
all
-
#single_record (if only one record could be returned)
-
#single_value (if only one record could be returned, and a single column is selected)
-
map
-
delete (if a DELETE statement)
-
update (if an UPDATE statement, with no arguments)
-
insert (if an INSERT statement, with no arguments)
-
truncate (if a TRUNCATE statement, with no arguments)
# File lib/sequel/dataset/query.rb, line 1302 def with_sql(sql, *args) if sql.is_a?(Symbol) sql = public_send(sql, *args) else sql = SQL::PlaceholderLiteralString.new(sql, args) unless args.empty? end clone(:sql=>sql) end
Protected Instance Methods
Add the dataset to the list of compounds
# File lib/sequel/dataset/query.rb, line 1314 def compound_clone(type, dataset, opts) if dataset.is_a?(Dataset) && dataset.opts[:with] && !supports_cte_in_compounds? s, ds = hoist_cte(dataset) return s.compound_clone(type, ds, opts) end ds = compound_from_self.clone(:compounds=>(Array(@opts[:compounds]).map(&:dup) + [[type, dataset.compound_from_self, opts[:all]].freeze]).freeze) opts[:from_self] == false ? ds : ds.from_self(opts) end
Return true if the dataset has a non-nil value for any key in opts.
# File lib/sequel/dataset/query.rb, line 1324 def options_overlap(opts) !(@opts.map{|k,v| k unless v.nil?}.compact & opts).empty? end
Whether this dataset is a simple select from an underlying table, such as:
SELECT * FROM table SELECT table.* FROM table
# File lib/sequel/dataset/query.rb, line 1335 def simple_select_all? return false unless (f = @opts[:from]) && f.length == 1 o = @opts.reject{|k,v| v.nil? || non_sql_option?(k)} from = f.first from = from.expression if from.is_a?(SQL::AliasedExpression) if SIMPLE_SELECT_ALL_ALLOWED_FROM.any?{|x| from.is_a?(x)} case o.length when 1 true when 2 (s = o[:select]) && s.length == 1 && s.first.is_a?(SQL::ColumnAll) else false end else false end end
Private Instance Methods
A frozen array for the currently selected columns.
# File lib/sequel/dataset/query.rb, line 1375 def _current_select(allow_plain_wildcard) cur_sel = @opts[:select] if !cur_sel || cur_sel.empty? cur_sel = if allow_plain_wildcard && supports_select_all_and_column? [WILDCARD].freeze else _current_select_column_all end elsif !allow_plain_wildcard && cur_sel.include?(WILDCARD) cur_sel = cur_sel.dup index = cur_sel.index(WILDCARD) cur_sel.delete(WILDCARD) _current_select_column_all.each_with_index do |ca, i| cur_sel.insert(index+i, ca) end cur_sel.freeze end cur_sel end
An array of SQL::ColumnAll objects for all FROM and JOIN tables. Used for #select_append and select_prepend.
# File lib/sequel/dataset/query.rb, line 1399 def _current_select_column_all tables = Array(@opts[:from]) + Array(@opts[:join]) tables.map{|t| i, a = split_alias(t); a || i}.map!{|t| SQL::ColumnAll.new(t)}.freeze end
Load the extensions into the receiver, without checking if the receiver is frozen.
# File lib/sequel/dataset/query.rb, line 1360 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 (try: Sequel.extension #{ext.inspect})") end end self end
If invert is true, invert the condition.
# File lib/sequel/dataset/query.rb, line 1405 def _invert_filter(cond, invert) if invert SQL::BooleanExpression.invert(cond) else cond end end
Append to the current MERGE WHEN clauses. Mutates the hash to add the conditions, if a virtual row block is passed.
# File lib/sequel/dataset/query.rb, line 1415 def _merge_when(hash, &block) hash[:conditions] = Sequel.virtual_row(&block) if block if merge_when = @opts[:merge_when] clone(:merge_when => (merge_when.dup << hash.freeze).freeze) else clone(:merge_when => [hash.freeze].freeze) end end
Add the given filter condition. Arguments:
- clause
-
Symbol or which SQL clause to effect, should be :where or :having
- cond
-
The filter condition to add
- invert
-
Whether the condition should be inverted (true or false)
- combine
-
How to combine the condition with an existing condition, should be :AND or :OR
# File lib/sequel/dataset/query.rb, line 1430 def add_filter(clause, cond, invert=false, combine=:AND, &block) if cond == EMPTY_ARRAY && !block raise Error, "must provide an argument to a filtering method if not passing a block" end cond = cond.first if cond.size == 1 empty = cond == OPTS || cond == EMPTY_ARRAY if empty && !block self else if cond == nil cond = Sequel::NULL end if empty && block cond = nil end cond = _invert_filter(filter_expr(cond, &block), invert) cond = SQL::BooleanExpression.new(combine, @opts[clause], cond) if @opts[clause] if cond.nil? cond = Sequel::NULL end clone(clause => cond) end end
The default :qualify option to use for join tables if one is not specified.
# File lib/sequel/dataset/query.rb, line 1461 def default_join_table_qualification :symbol end
Return self if the dataset already has a server, or a cloned dataset with the default server otherwise.
# File lib/sequel/dataset/query.rb, line 1536 def default_server server?(:default) end
SQL expression object based on the expr type. See
where
.
# File lib/sequel/dataset/query.rb, line 1466 def filter_expr(expr = nil, &block) expr = nil if expr == EMPTY_ARRAY if block cond = filter_expr(Sequel.virtual_row(&block)) cond = SQL::BooleanExpression.new(:AND, filter_expr(expr), cond) if expr return cond end case expr when Hash SQL::BooleanExpression.from_value_pairs(expr) when Array if Sequel.condition_specifier?(expr) SQL::BooleanExpression.from_value_pairs(expr) else raise Error, "Invalid filter expression: #{expr.inspect}" end when LiteralString LiteralString.new("(#{expr})") when Numeric, SQL::NumericExpression, SQL::StringExpression, Proc, String raise Error, "Invalid filter expression: #{expr.inspect}" when TrueClass, FalseClass if supports_where_true? SQL::BooleanExpression.new(:NOOP, expr) elsif expr SQL::Constants::SQLTRUE else SQL::Constants::SQLFALSE end when PlaceholderLiteralizer::Argument expr.transform{|v| filter_expr(v)} when SQL::PlaceholderLiteralString expr.with_parens else expr end end
Return two datasets, the first a clone of the receiver with the WITH clause from the given dataset added to it, and the second a clone of the given dataset with the WITH clause removed.
# File lib/sequel/dataset/query.rb, line 1508 def hoist_cte(ds) [clone(:with => ((opts[:with] || EMPTY_ARRAY) + ds.opts[:with]).freeze), ds.clone(:with => nil)] end
Whether CTEs need to be hoisted from the given ds into the current ds.
# File lib/sequel/dataset/query.rb, line 1513 def hoist_cte?(ds) ds.is_a?(Dataset) && ds.opts[:with] && !supports_cte_in_subqueries? end
Inverts the given order by breaking it into a list of column references and inverting them.
DB[:items].invert_order([Sequel.desc(:id)]]) #=> [Sequel.asc(:id)] DB[:items].invert_order([:category, Sequel.desc(:price)]) #=> [Sequel.desc(:category), Sequel.asc(:price)]
# File lib/sequel/dataset/query.rb, line 1522 def invert_order(order) return unless order order.map do |f| case f when SQL::OrderedExpression f.invert else SQL::OrderedExpression.new(f) end end end
Whether the given option key does not affect the generated SQL.
# File lib/sequel/dataset/query.rb, line 1541 def non_sql_option?(key) NON_SQL_OPTIONS.include?(key) end
Treat the block
as a virtual_row block if not nil
and add the resulting columns to the columns
array (modifies
columns
).
# File lib/sequel/dataset/query.rb, line 1547 def virtual_row_columns(columns, block) if block v = Sequel.virtual_row(&block) if v.is_a?(Array) columns.concat(v) else columns << v end end end
2 - Methods that execute code on the database
↑ topConstants
- ACTION_METHODS
Action methods defined by Sequel that execute code on the database.
- COLUMNS_CLONE_OPTIONS
The clone options to use when retrieving columns for a dataset.
- COUNT_SELECT
- EMPTY_SELECT
Public Instance Methods
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 27 def <<(arg) insert(arg) self end
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 36 def [](*conditions) raise(Error, 'You cannot call Dataset#[] with an integer or with no arguments') if (conditions.length == 1 and conditions.first.is_a?(Integer)) or conditions.length == 0 first(*conditions) end
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 49 def all(&block) _all(block){|a| each{|r| a << r}} end
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].as_hash(:id, :name) # SELECT * FROM table # {1=>'Jim', 2=>'Bob', ...} DB[:table].as_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].as_hash([:id, :foo], [:name, :bar]) # SELECT * FROM table # {[1, 3]=>['Jim', 'bo'], [2, 4]=>['Bob', 'be'], ...} DB[:table].as_hash([:id, :name]) # SELECT * FROM table # {[1, 'Jim']=>{:id=>1, :name=>'Jim'}, [2, 'Bob']=>{:id=>2, :name=>'Bob'}, ...}
Options:
- :all
-
Use all instead of each to retrieve the objects
- :hash
-
The object into which the values will be placed. If this is not given, an empty hash is used. This can be used to use a hash with a default value or default proc.
# File lib/sequel/dataset/actions.rb, line 846 def as_hash(key_column, value_column = nil, opts = OPTS) h = opts[:hash] || {} meth = opts[:all] ? :all : :each if value_column return naked.as_hash(key_column, value_column, opts) if row_proc if value_column.is_a?(Array) if key_column.is_a?(Array) public_send(meth){|r| h[r.values_at(*key_column)] = r.values_at(*value_column)} else public_send(meth){|r| h[r[key_column]] = r.values_at(*value_column)} end else if key_column.is_a?(Array) public_send(meth){|r| h[r.values_at(*key_column)] = r[value_column]} else public_send(meth){|r| h[r[key_column]] = r[value_column]} end end elsif key_column.is_a?(Array) public_send(meth){|r| h[key_column.map{|k| r[k]}] = r} else public_send(meth){|r| h[r[key_column]] = r} end h end
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 60 def avg(arg=(no_arg = true), &block) arg = Sequel.virtual_row(&block) if no_arg _aggregate(:avg, arg) end
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 74 def columns _columns || columns! end
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 83 def columns! ds = clone(COLUMNS_CLONE_OPTIONS) ds.each{break} if cols = ds.cache[:_columns] self.columns = cols else [] end end
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 107 def count(arg=(no_arg=true), &block) if no_arg && !block cached_dataset(:_count_ds) do aggregate_dataset.select(COUNT_SELECT).single_value_ds end.single_value!.to_i else if block if no_arg arg = Sequel.virtual_row(&block) else raise Error, 'cannot provide both argument and block to Dataset#count' end end _aggregate(:count, arg) end end
Deletes the records in the dataset, returning the number of records deleted.
DB[:table].delete # DELETE * FROM table # => 3
Some databases support using multiple tables in a DELETE query. This requires multiple FROM tables (JOINs can also be used). As multiple FROM tables use an implicit CROSS JOIN, you should make sure your WHERE condition uses the appropriate filters for the FROM tables:
DB.from(:a, :b).join(:c, :d=>Sequel[:b][:e]).where{{a[:f]=>b[:g], a[:id]=>c[:h]}}. delete # DELETE FROM a # USING b # INNER JOIN c ON (c.d = b.e) # WHERE ((a.f = b.g) AND (a.id = c.h))
# File lib/sequel/dataset/actions.rb, line 141 def delete(&block) sql = delete_sql if uses_returning?(:delete) returning_fetch_rows(sql, &block) else execute_dui(sql) end end
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 159 def each if rp = row_proc fetch_rows(select_sql){|r| yield rp.call(r)} else fetch_rows(select_sql){|r| yield r} end self end
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 174 def empty? cached_dataset(:_empty_ds) do (@opts[:sql] ? from_self : self).single_value_ds.unordered.select(EMPTY_SELECT) end.single_value!.nil? end
Returns the first matching record if no arguments are given. If a integer argument is given, it is interpreted as a limit, and then returns all matching records up to that limit. If any other type of argument(s) is passed, it is treated as a 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(Sequel.lit("id = 3")) # SELECT * FROM table WHERE (id = 3) LIMIT 1 # => {:id=>3} DB[:table].first(Sequel.lit("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(Sequel.lit("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 215 def first(*args, &block) case args.length when 0 unless block return single_record end when 1 arg = args[0] if arg.is_a?(Integer) res = if block if loader = cached_placeholder_literalizer(:_first_integer_cond_loader) do |pl| where(pl.arg).limit(pl.arg) end loader.all(filter_expr(&block), arg) else where(&block).limit(arg).all end else if loader = cached_placeholder_literalizer(:_first_integer_loader) do |pl| limit(pl.arg) end loader.all(arg) else limit(arg).all end end return res end where_args = args args = arg end if loader = cached_where_placeholder_literalizer(where_args||args, block, :_first_cond_loader) do |pl| _single_record_ds.where(pl.arg) end loader.first(filter_expr(args, &block)) else _single_record_ds.where(args, &block).single_record! end end
Calls first. If first returns nil (signaling that no row matches), raise a Sequel::NoMatchingRow exception.
# File lib/sequel/dataset/actions.rb, line 262 def first!(*args, &block) first(*args, &block) || raise(Sequel::NoMatchingRow.new(self)) end
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) AS v 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 284 def get(column=(no_arg=true; nil), &block) ds = naked if block raise(Error, 'Must call Dataset#get with an argument or a block, not both') unless no_arg ds = ds.select(&block) column = ds.opts[:select] column = nil if column.is_a?(Array) && column.length < 2 else case column when Array ds = ds.select(*column) when LiteralString, Symbol, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression if loader = cached_placeholder_literalizer(:_get_loader) do |pl| ds.single_value_ds.select(pl.arg) end return loader.get(column) end ds = ds.select(column) else if loader = cached_placeholder_literalizer(:_get_alias_loader) do |pl| ds.single_value_ds.select(Sequel.as(pl.arg, :v)) end return loader.get(column) end ds = ds.select(Sequel.as(column, :v)) 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
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 if necessary.
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)
or, if the database supports it:
# INSERT INTO table (x, y) VALUES (1, 2), (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. When a transaction is not required, this option controls the maximum number of values to insert with a single statement; it does not force the use of a transaction.
- :return
-
When this is set to :primary_key, returns an array of autoincremented primary key values for the rows inserted. This does not have an effect if
values
is a Dataset. - :server
-
Set the server/shard to use for the transaction and insert queries.
- :skip_transaction
-
Do not use a transaction even when using multiple INSERT queries.
- :slice
-
Same as :commit_every, :commit_every takes precedence.
# File lib/sequel/dataset/actions.rb, line 361 def import(columns, values, opts=OPTS) return insert(columns, values) if values.is_a?(Dataset) return if values.empty? raise(Error, 'Using Sequel::Dataset#import with an empty column array is not allowed') if columns.empty? ds = opts[:server] ? server(opts[:server]) : self if slice_size = opts.fetch(:commit_every, opts.fetch(:slice, default_import_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
Inserts values into the associated table. The returned value is generally the value of the autoincremented primary key for the inserted row, assuming that a single row is inserted and the table has an autoincrementing primary key.
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 and 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 417 def insert(*values, &block) sql = insert_sql(*values) if uses_returning?(:insert) returning_fetch_rows(sql, &block) else execute_insert(sql) end end
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 436 def last(*args, &block) raise(Error, 'No order specified') unless @opts[:order] reverse.first(*args, &block) end
Maps column values for each record in the dataset (if an argument 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 455 def map(column=nil, &block) if column raise(Error, 'Must call Dataset#map with either an argument or a block, not both') 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
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 476 def max(arg=(no_arg = true), &block) arg = Sequel.virtual_row(&block) if no_arg _aggregate(:max, arg) end
Execute a MERGE statement, which allows for INSERT, UPDATE, and DELETE behavior in a single query, based on whether rows from a source table match rows in the current table, based on the join conditions.
Unless the dataset uses static SQL, to use merge, you must first have called merge_using to specify the merge source and join conditions. You will then likely to call one or more of the following methods to specify MERGE behavior by adding WHEN [NOT] MATCHED clauses:
The WHEN [NOT] MATCHED clauses are added to the SQL in the order these methods were called on the dataset. If none of these methods are called, an error is raised.
Example:
DB[:m1] merge_using(:m2, i1: :i2). merge_insert(i1: :i2, a: Sequel[:b]+11). merge_delete{a > 30}. merge_update(i1: Sequel[:i1]+:i2+10, a: Sequel[:a]+:b+20). merge
SQL:
MERGE INTO m1 USING m2 ON (i1 = i2) WHEN NOT MATCHED THEN INSERT (i1, a) VALUES (i2, (b + 11)) WHEN MATCHED AND (a > 30) THEN DELETE WHEN MATCHED THEN UPDATE SET i1 = (i1 + i2 + 10), a = (a + b + 20)
On PostgreSQL, two additional merge methods are supported, for the PostgreSQL-specific DO NOTHING syntax.
-
merge_do_nothing_when_matched
-
merge_do_nothing_when_not_matched
This method is supported on Oracle, but Oracle's MERGE support is non-standard, and has the following issues:
-
DELETE clause requires UPDATE clause
-
DELETE clause requires a condition
-
DELETE clause only affects rows updated by UPDATE clause
# File lib/sequel/dataset/actions.rb, line 526 def merge execute_ddl(merge_sql) end
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 537 def min(arg=(no_arg = true), &block) arg = Sequel.virtual_row(&block) if no_arg _aggregate(:min, arg) end
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 554 def multi_insert(hashes, opts=OPTS) return if hashes.empty? columns = hashes.first.keys import(columns, hashes.map{|h| columns.map{|c| h[c]}}, opts) end
Yields each row in the dataset, but internally uses multiple queries as needed 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 work correctly, the dataset must have unambiguous order. Using an ambiguous order can result in an infinite loop, as well as subtler bugs such as yielding duplicate rows or rows being skipped.
Sequel checks that the datasets using this method have an order, but it cannot ensure that the order is unambiguous.
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, use a separate thread or shard inside
paged_each
.
Options:
- :rows_per_fetch
-
The number of rows to fetch per query. Defaults to 1000.
- :strategy
-
The strategy to use for paging of results. By default this is :offset, for using an approach with a limit and offset for every page. This can be set to :filter, which uses a limit and a filter that excludes rows from previous pages. In order for this strategy to work, you must be selecting the columns you are ordering by, and none of the columns can contain NULLs. Note that some Sequel adapters have optimized implementations that will use cursors or streaming regardless of the :strategy option used.
- :filter_values
-
If the strategy: :filter option is used, this option should be a proc that accepts the last retrieved row for the previous page and an array of ORDER BY expressions, and returns an array of values relating to those expressions for the last retrieved row. You will need to use this option if your ORDER BY expressions are not simple columns, if they contain qualified identifiers that would be ambiguous unqualified, if they contain any identifiers that are aliased in SELECT, and potentially other cases.
- :skip_transaction
-
Do not use a transaction. This can be useful if you want to prevent a lock on the database table, at the expense of consistency.
Examples:
DB[:table].order(:id).paged_each{|row| } # SELECT * FROM table ORDER BY id LIMIT 1000 # SELECT * FROM table ORDER BY id LIMIT 1000 OFFSET 1000 # ... DB[:table].order(:id).paged_each(rows_per_fetch: 100){|row| } # SELECT * FROM table ORDER BY id LIMIT 100 # SELECT * FROM table ORDER BY id LIMIT 100 OFFSET 100 # ... DB[:table].order(:id).paged_each(strategy: :filter){|row| } # SELECT * FROM table ORDER BY id LIMIT 1000 # SELECT * FROM table WHERE id > 1001 ORDER BY id LIMIT 1000 # ... DB[:table].order(:id).paged_each(strategy: :filter, filter_values: lambda{|row, exprs| [row[:id]]}){|row| } # SELECT * FROM table ORDER BY id LIMIT 1000 # SELECT * FROM table WHERE id > 1001 ORDER BY id LIMIT 1000 # ...
# File lib/sequel/dataset/actions.rb, line 617 def paged_each(opts=OPTS) unless @opts[:order] raise Sequel::Error, "Dataset#paged_each requires the dataset be ordered" end unless defined?(yield) return enum_for(:paged_each, opts) end total_limit = @opts[:limit] offset = @opts[:offset] if server = @opts[:server] opts = Hash[opts] opts[:server] = server end rows_per_fetch = opts[:rows_per_fetch] || 1000 strategy = if offset || total_limit :offset else opts[:strategy] || :offset end db.transaction(opts) do case strategy when :filter filter_values = opts[:filter_values] || proc{|row, exprs| exprs.map{|e| row[hash_key_symbol(e)]}} base_ds = ds = limit(rows_per_fetch) while ds last_row = nil ds.each do |row| last_row = row yield row end ds = (base_ds.where(ignore_values_preceding(last_row, &filter_values)) if last_row) end else offset ||= 0 num_rows_yielded = rows_per_fetch total_rows = 0 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 end self end
Returns a hash with key_column values as keys and value_column values as values. Similar to #as_hash, but only selects the columns given. Like #as_hash, it accepts an optional :hash parameter, into which entries will be merged.
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 id, foo, name, bar 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.
# File lib/sequel/dataset/actions.rb, line 695 def select_hash(key_column, value_column, opts = OPTS) _select_hash(:as_hash, key_column, value_column, opts) end
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. Like #to_hash_groups, it accepts an optional :hash parameter, into which entries will be merged.
DB[:table].select_hash_groups(: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_groups([:first, :middle], [:last, :id]) # SELECT first, middle, last, id 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.
# File lib/sequel/dataset/actions.rb, line 716 def select_hash_groups(key_column, value_column, opts = OPTS) _select_hash(:to_hash_groups, key_column, value_column, opts) end
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.
# File lib/sequel/dataset/actions.rb, line 739 def select_map(column=nil, &block) _select_map(column, false, &block) end
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.
# File lib/sequel/dataset/actions.rb, line 758 def select_order_map(column=nil, &block) _select_map(column, true, &block) end
Limits the dataset to one record, and returns the first record in the
dataset, or nil if the dataset has no records. Users should probably use
first
instead of this method. Example:
DB[:test].single_record # SELECT * FROM test LIMIT 1 # => {:column_name=>'value'}
# File lib/sequel/dataset/actions.rb, line 768 def single_record _single_record_ds.single_record! end
Returns the first record in dataset, without limiting the dataset. Returns
nil if the dataset has no records. Users should probably use
first
instead of this method. This should only be used if you
know the dataset is already limited to a single record. This method may be
desirable to use for performance reasons, as it does not clone the
receiver. Example:
DB[:test].single_record! # SELECT * FROM test # => {:column_name=>'value'}
# File lib/sequel/dataset/actions.rb, line 780 def single_record! with_sql_first(select_sql) end
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. Example:
DB[:test].single_value # SELECT * FROM test LIMIT 1 # => 'value'
# File lib/sequel/dataset/actions.rb, line 790 def single_value single_value_ds.each do |r| r.each{|_, v| return v} end nil end
Returns the first value of the first record in the dataset, without
limiting the dataset. Returns nil if the dataset is empty. Users should
generally use get
instead of this method. Should not be used
on graphed datasets or datasets that have row_procs that don't return
hashes. This method may be desirable to use for performance reasons, as it
does not clone the receiver.
DB[:test].single_value! # SELECT * FROM test # => 'value'
# File lib/sequel/dataset/actions.rb, line 805 def single_value! with_sql_single_value(select_sql) end
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 816 def sum(arg=(no_arg = true), &block) arg = Sequel.virtual_row(&block) if no_arg _aggregate(:sum, arg) end
Alias of #as_hash for backwards compatibility.
# File lib/sequel/dataset/actions.rb, line 873 def to_hash(*a) as_hash(*a) end
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_groups(:name, :id) # SELECT * FROM table # {'Jim'=>[1, 4, 16, ...], 'Bob'=>[2], ...} DB[:table].to_hash_groups(: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_groups([:first, :middle], [:last, :id]) # SELECT * FROM table # {['Jim', 'Bob']=>[['Smith', 1], ['Jackson', 4], ...], ...} DB[:table].to_hash_groups([:first, :middle]) # SELECT * FROM table # {['Jim', 'Bob']=>[{:id=>1, :first=>'Jim', :middle=>'Bob', :last=>'Smith'}, ...], ...}
Options:
- :all
-
Use all instead of each to retrieve the objects
- :hash
-
The object into which the values will be placed. If this is not given, an empty hash is used. This can be used to use a hash with a default value or default proc.
# File lib/sequel/dataset/actions.rb, line 901 def to_hash_groups(key_column, value_column = nil, opts = OPTS) h = opts[:hash] || {} meth = opts[:all] ? :all : :each if value_column return naked.to_hash_groups(key_column, value_column, opts) if row_proc if value_column.is_a?(Array) if key_column.is_a?(Array) public_send(meth){|r| (h[r.values_at(*key_column)] ||= []) << r.values_at(*value_column)} else public_send(meth){|r| (h[r[key_column]] ||= []) << r.values_at(*value_column)} end else if key_column.is_a?(Array) public_send(meth){|r| (h[r.values_at(*key_column)] ||= []) << r[value_column]} else public_send(meth){|r| (h[r[key_column]] ||= []) << r[value_column]} end end elsif key_column.is_a?(Array) public_send(meth){|r| (h[key_column.map{|k| r[k]}] ||= []) << r} else public_send(meth){|r| (h[r[key_column]] ||= []) << r} end h end
Truncates the dataset. Returns nil.
DB[:table].truncate # TRUNCATE table # => nil
# File lib/sequel/dataset/actions.rb, line 931 def truncate execute_ddl(truncate_sql) end
Updates values for the dataset. The returned value is the number of rows
updated. values
should be 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: Sequel[:x]+1, y: 0) # UPDATE table SET x = (x + 1), y = 0 # => 10
Some databases support using multiple tables in an UPDATE query. This requires multiple FROM tables (JOINs can also be used). As multiple FROM tables use an implicit CROSS JOIN, you should make sure your WHERE condition uses the appropriate filters for the FROM tables:
DB.from(:a, :b).join(:c, :d=>Sequel[:b][:e]).where{{a[:f]=>b[:g], a[:id]=>10}}. update(:f=>Sequel[:c][:h]) # UPDATE a # SET f = c.h # FROM b # INNER JOIN c ON (c.d = b.e) # WHERE ((a.f = b.g) AND (a.id = 10))
# File lib/sequel/dataset/actions.rb, line 957 def update(values=OPTS, &block) sql = update_sql(values) if uses_returning?(:update) returning_fetch_rows(sql, &block) else execute_dui(sql) end end
Return an array of all rows matching the given filter condition, also yielding each row to the given block. Basically the same as where(cond).all(&block), except it can be optimized to not create an intermediate dataset.
DB[:table].where_all(id: [1,2,3]) # SELECT * FROM table WHERE (id IN (1, 2, 3))
# File lib/sequel/dataset/actions.rb, line 972 def where_all(cond, &block) if loader = _where_loader([cond], nil) loader.all(filter_expr(cond), &block) else where(cond).all(&block) end end
Iterate over all rows matching the given filter condition, yielding each row to the given block. Basically the same as where(cond).each(&block), except it can be optimized to not create an intermediate dataset.
DB[:table].where_each(id: [1,2,3]){|row| p row} # SELECT * FROM table WHERE (id IN (1, 2, 3))
# File lib/sequel/dataset/actions.rb, line 986 def where_each(cond, &block) if loader = _where_loader([cond], nil) loader.each(filter_expr(cond), &block) else where(cond).each(&block) end end
Filter the datasets using the given filter condition, then return a single value. This assumes that the dataset has already been setup to limit the selection to a single column. Basically the same as where(cond).single_value, except it can be optimized to not create an intermediate dataset.
DB[:table].select(:name).where_single_value(id: 1) # SELECT name FROM table WHERE (id = 1) LIMIT 1
# File lib/sequel/dataset/actions.rb, line 1001 def where_single_value(cond) if loader = cached_where_placeholder_literalizer([cond], nil, :_where_single_value_loader) do |pl| single_value_ds.where(pl.arg) end loader.get(filter_expr(cond)) else where(cond).single_value end end
Run the given SQL and return an array of all rows. If a block is given, each row is yielded to the block after all rows are loaded. See with_sql_each.
# File lib/sequel/dataset/actions.rb, line 1014 def with_sql_all(sql, &block) _all(block){|a| with_sql_each(sql){|r| a << r}} end
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 1021 def with_sql_delete(sql) execute_dui(sql) end
Run the given SQL and yield each returned row to the block.
# File lib/sequel/dataset/actions.rb, line 1027 def with_sql_each(sql) if rp = row_proc _with_sql_dataset.fetch_rows(sql){|r| yield rp.call(r)} else _with_sql_dataset.fetch_rows(sql){|r| yield r} end self end
Run the given SQL and return the first row, or nil if no rows were returned. See with_sql_each.
# File lib/sequel/dataset/actions.rb, line 1038 def with_sql_first(sql) with_sql_each(sql){|r| return r} nil end
Execute the given SQL and (on most databases) return the primary key of the inserted row.
# File lib/sequel/dataset/actions.rb, line 1054 def with_sql_insert(sql) execute_insert(sql) end
Run the given SQL and return the first value in the first row, or nil if no rows were returned. For this to make sense, the SQL given should select only a single value. See with_sql_each.
# File lib/sequel/dataset/actions.rb, line 1046 def with_sql_single_value(sql) if r = with_sql_first(sql) r.each{|_, v| return v} end end
Protected Instance Methods
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. A transaction is only used if there are multiple statements to execute.
# File lib/sequel/dataset/actions.rb, line 1064 def _import(columns, values, opts) trans_opts = Hash[opts] trans_opts[:server] = @opts[:server] if opts[:return] == :primary_key _import_transaction(values, trans_opts){values.map{|v| insert(columns, v)}} else stmts = multi_insert_sql(columns, values) _import_transaction(stmts, trans_opts){stmts.each{|st| execute_dui(st)}} end end
Return an array of arrays of values given by the symbols in ret_cols.
# File lib/sequel/dataset/actions.rb, line 1076 def _select_map_multiple(ret_cols) map{|r| r.values_at(*ret_cols)} end
Returns an array of the first value in each row.
# File lib/sequel/dataset/actions.rb, line 1081 def _select_map_single k = nil map{|r| r[k||=r.keys.first]} end
A dataset for returning single values from the current dataset.
# File lib/sequel/dataset/actions.rb, line 1087 def single_value_ds clone(:limit=>1).ungraphed.naked end
Private Instance Methods
Cached placeholder literalizer for methods that return values using aggregate functions.
# File lib/sequel/dataset/actions.rb, line 1103 def _aggregate(function, arg) if loader = cached_placeholder_literalizer(:"_#{function}_loader") do |pl| aggregate_dataset.limit(1).select(SQL::Function.new(function, pl.arg).as(function)) end loader.get(arg) else aggregate_dataset.get(SQL::Function.new(function, arg).as(function)) end end
Internals of all and #with_sql_all
# File lib/sequel/dataset/actions.rb, line 1094 def _all(block) a = [] yield a post_load(a) a.each(&block) if block a end
Return a plain symbol given a potentially qualified or aliased symbol, specifying the symbol that is likely to be used as the hash key for the column when records are returned. Return nil if no hash key can be determined
# File lib/sequel/dataset/actions.rb, line 1211 def _hash_key_symbol(s, recursing=false) case s when Symbol _, c, a = split_symbol(s) (a || c).to_sym when SQL::Identifier, SQL::Wrapper _hash_key_symbol(s.value, true) when SQL::QualifiedIdentifier _hash_key_symbol(s.column, true) when SQL::AliasedExpression _hash_key_symbol(s.alias, true) when String s.to_sym if recursing end end
Use a transaction when yielding to the block if multiple values/statements are provided. When only a single value or statement is provided, then yield without using a transaction.
# File lib/sequel/dataset/actions.rb, line 1116 def _import_transaction(values, trans_opts, &block) # OK to mutate trans_opts as it is generated by _import trans_opts[:skip_transaction] = true if values.length <= 1 @db.transaction(trans_opts, &block) end
Internals of select_hash
and select_hash_groups
# File lib/sequel/dataset/actions.rb, line 1123 def _select_hash(meth, key_column, value_column, opts=OPTS) select(*(key_column.is_a?(Array) ? key_column : [key_column]) + (value_column.is_a?(Array) ? value_column : [value_column])). public_send(meth, hash_key_symbols(key_column), hash_key_symbols(value_column), opts) end
Internals of select_map
and select_order_map
# File lib/sequel/dataset/actions.rb, line 1129 def _select_map(column, order, &block) ds = ungraphed.naked columns = Array(column) virtual_row_columns(columns, block) select_cols = order ? columns.map{|c| c.is_a?(SQL::OrderedExpression) ? c.expression : c} : columns ds = ds.order(*columns.map{|c| unaliased_identifier(c)}) if order if column.is_a?(Array) || (columns.length > 1) ds.select(*select_cols)._select_map_multiple(hash_key_symbols(select_cols)) else ds.select(auto_alias_expression(select_cols.first))._select_map_single end end
A cached dataset for a single record for this dataset.
# File lib/sequel/dataset/actions.rb, line 1143 def _single_record_ds cached_dataset(:_single_record_ds){clone(:limit=>1)} end
Loader used for #where_all and where_each.
# File lib/sequel/dataset/actions.rb, line 1148 def _where_loader(where_args, where_block) cached_where_placeholder_literalizer(where_args, where_block, :_where_loader) do |pl| where(pl.arg) end end
Cached dataset to use for with_sql_#{all,each,first,single_value}. This is used so that the columns returned by the given SQL do not affect the receiver of the with_sql_* method.
# File lib/sequel/dataset/actions.rb, line 1329 def _with_sql_dataset if @opts[:_with_sql_ds] self else cached_dataset(:_with_sql_ds) do clone(:_with_sql_ds=>true) end end end
Automatically alias the given expression if it does not have an identifiable alias.
# File lib/sequel/dataset/actions.rb, line 1155 def auto_alias_expression(v) case v when LiteralString, Symbol, SQL::Identifier, SQL::QualifiedIdentifier, SQL::AliasedExpression v else SQL::AliasedExpression.new(v, :v) end end
The default number of rows that can be inserted in a single INSERT statement via import. The default is for no limit.
# File lib/sequel/dataset/actions.rb, line 1166 def default_import_slice nil end
Set the server to use to :default unless it is already set in the passed opts
# File lib/sequel/dataset/actions.rb, line 1171 def default_server_opts(opts) if @db.sharded? && !opts.has_key?(:server) opts = Hash[opts] opts[:server] = @opts[:server] || :default end opts end
Execute the given select SQL on the database using execute. Use the :read_only server unless a specific server is set.
# File lib/sequel/dataset/actions.rb, line 1181 def execute(sql, opts=OPTS, &block) db = @db if db.sharded? && !opts.has_key?(:server) opts = Hash[opts] opts[:server] = @opts[:server] || (@opts[:lock] ? :default : :read_only) opts end db.execute(sql, opts, &block) end
Execute the given SQL on the database using execute_ddl.
# File lib/sequel/dataset/actions.rb, line 1192 def execute_ddl(sql, opts=OPTS, &block) @db.execute_ddl(sql, default_server_opts(opts), &block) nil end
Execute the given SQL on the database using execute_dui.
# File lib/sequel/dataset/actions.rb, line 1198 def execute_dui(sql, opts=OPTS, &block) @db.execute_dui(sql, default_server_opts(opts), &block) end
Execute the given SQL on the database using execute_insert.
# File lib/sequel/dataset/actions.rb, line 1203 def execute_insert(sql, opts=OPTS, &block) @db.execute_insert(sql, default_server_opts(opts), &block) end
Return a plain symbol given a potentially qualified or aliased symbol, specifying the symbol that is likely to be used as the hash key for the column when records are returned. Raise Error if the hash key symbol cannot be returned.
# File lib/sequel/dataset/actions.rb, line 1231 def hash_key_symbol(s) if v = _hash_key_symbol(s) v else raise(Error, "#{s.inspect} is not supported, should be a Symbol, SQL::Identifier, SQL::QualifiedIdentifier, or SQL::AliasedExpression") end end
If s is an array, return an array with the given hash key symbols. Otherwise, return a hash key symbol for the given expression If a hash key symbol cannot be determined, raise an error.
# File lib/sequel/dataset/actions.rb, line 1242 def hash_key_symbols(s) s.is_a?(Array) ? s.map{|c| hash_key_symbol(c)} : hash_key_symbol(s) end
Returns an expression that will ignore values preceding the given row, using the receiver's current order. This yields the row and the array of order expressions to the block, which should return an array of values to use.
# File lib/sequel/dataset/actions.rb, line 1249 def ignore_values_preceding(row) @opts[:order].map{|v| v.is_a?(SQL::OrderedExpression) ? v.expression : v} order_exprs = @opts[:order].map do |v| if v.is_a?(SQL::OrderedExpression) descending = v.descending v = v.expression else descending = false end [v, descending] end row_values = yield(row, order_exprs.map(&:first)) last_expr = [] cond = order_exprs.zip(row_values).map do |(v, descending), value| expr = last_expr + [SQL::BooleanExpression.new(descending ? :< : :>, v, value)] last_expr += [SQL::BooleanExpression.new(:'=', v, value)] Sequel.&(*expr) end Sequel.|(*cond) end
Downcase identifiers by default when outputing them from the database.
# File lib/sequel/dataset/actions.rb, line 1274 def output_identifier(v) v = 'untitled' if v == '' v.to_s.downcase.to_sym end
This is run inside .all, after all of the records have been loaded via .each, but before any block passed to all is called. It is called with a single argument, an array of all returned records. Does nothing by default, added to make the model eager loading code simpler.
# File lib/sequel/dataset/actions.rb, line 1283 def post_load(all_records) end
Called by insert/update/delete when returning is used. Yields each row as a plain hash to the block if one is given, or returns an array of plain hashes for all rows if a block is not given
# File lib/sequel/dataset/actions.rb, line 1289 def returning_fetch_rows(sql, &block) if block default_server.fetch_rows(sql, &block) nil else rows = [] default_server.fetch_rows(sql){|r| rows << r} rows end end
Return the unaliased part of the identifier. Handles both implicit aliases in symbols, as well as SQL::AliasedExpression objects. Other objects are returned as is.
# File lib/sequel/dataset/actions.rb, line 1303 def unaliased_identifier(c) case c when Symbol table, column, aliaz = split_symbol(c) if aliaz table ? SQL::QualifiedIdentifier.new(table, column) : Sequel.identifier(column) else c end when SQL::AliasedExpression c.expression when SQL::OrderedExpression case expr = c.expression when Symbol, SQL::AliasedExpression SQL::OrderedExpression.new(unaliased_identifier(expr), c.descending, :nulls=>c.nulls) else c end else c end end
3 - User Methods relating to SQL Creation
↑ topPublic Instance Methods
Returns an EXISTS clause for the dataset as an SQL::PlaceholderLiteralString.
DB.select(1).where(DB[:items].exists) # SELECT 1 WHERE (EXISTS (SELECT * FROM items))
# File lib/sequel/dataset/sql.rb, line 13 def exists SQL::PlaceholderLiteralString.new(EXISTS, [self], true) end
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 21 def insert_sql(*values) return static_sql(@opts[:sql]) if @opts[:sql] check_insert_allowed! columns, values = _parse_insert_sql_args(values) if values.is_a?(Array) && values.empty? && !insert_supports_empty_values? columns, values = insert_empty_columns_values elsif values.is_a?(Dataset) && hoist_cte?(values) && supports_cte?(:insert) ds, values = hoist_cte(values) return ds.clone(:columns=>columns, :values=>values).send(:_insert_sql) end clone(:columns=>columns, :values=>values).send(:_insert_sql) end
Append a literal representation of a value to the given SQL string.
If an unsupported object is given, an Error
is raised.
# File lib/sequel/dataset/sql.rb, line 39 def literal_append(sql, v) case v when Symbol if skip_symbol_cache? literal_symbol_append(sql, v) else unless l = db.literal_symbol(v) l = String.new literal_symbol_append(l, v) db.literal_symbol_set(v, l) end sql << l end 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 v.is_a?(SQLTime) ? literal_sqltime_append(sql, v) : literal_time_append(sql, v) when DateTime literal_datetime_append(sql, v) when Date literal_date_append(sql, v) when Dataset literal_dataset_append(sql, v) else literal_other_append(sql, v) end end
Literalize a date or time value, as a SQL string
value with no typecasting. If raw
is true, remove the
surrounding single quotes. This is designed for usage by bound argument
code that can work even if the auto_cast_date_and_time extension is used
(either manually or implicitly in the related adapter).
# File lib/sequel/dataset/sql.rb, line 122 def literal_date_or_time(dt, raw=false) value = case dt when SQLTime literal_sqltime(dt) when Time literal_time(dt) when DateTime literal_datetime(dt) when Date literal_date(dt) else raise TypeError, "unsupported type: #{dt.inspect}" end if raw value.sub!(/\A'/, '') value.sub!(/'\z/, '') end value end
The SQL to use for the MERGE statement.
# File lib/sequel/dataset/sql.rb, line 93 def merge_sql raise Error, "This database doesn't support MERGE" unless supports_merge? if sql = opts[:sql] return static_sql(sql) end if sql = cache_get(:_merge_sql) return sql end source, join_condition = @opts[:merge_using] raise Error, "No USING clause for MERGE" unless source sql = @opts[:append_sql] || sql_string_origin select_with_sql(sql) sql << "MERGE INTO " source_list_append(sql, @opts[:from]) sql << " USING " identifier_append(sql, source) sql << " ON " literal_append(sql, join_condition) _merge_when_sql(sql) cache_set(:_merge_sql, sql) if cache_sql? sql end
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.
# File lib/sequel/dataset/sql.rb, line 147 def multi_insert_sql(columns, values) case multi_insert_sql_strategy when :values sql = LiteralString.new('VALUES ') expression_list_append(sql, values.map{|r| Array(r)}) [insert_sql(columns, sql)] when :union c = false sql = LiteralString.new u = ' UNION ALL SELECT ' f = empty_from_sql values.each do |v| if c sql << u else sql << 'SELECT ' c = true end expression_list_append(sql, v) sql << f if f end [insert_sql(columns, sql)] else values.map{|r| insert_sql(columns, r)} end end
Same as select_sql
, not aliased directly to make subclassing
simpler.
# File lib/sequel/dataset/sql.rb, line 175 def sql select_sql end
Returns a TRUNCATE SQL query string. See
truncate
DB[:items].truncate_sql # => 'TRUNCATE items'
# File lib/sequel/dataset/sql.rb, line 182 def truncate_sql if opts[:sql] static_sql(opts[:sql]) else check_truncation_allowed! check_not_limited!(:truncate) raise(InvalidOperation, "Can't truncate filtered datasets") if opts[:where] || opts[:having] t = String.new source_list_append(t, opts[:from]) _truncate_sql(t) end end
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 202 def update_sql(values = OPTS) return static_sql(opts[:sql]) if opts[:sql] check_update_allowed! check_not_limited!(:update) case values when LiteralString # nothing when String raise Error, "plain string passed to Dataset#update is not supported, use Sequel.lit to use a literal string" end clone(:values=>values).send(:_update_sql) end
4 - Methods that describe what the dataset supports
↑ topPublic Instance Methods
Whether this dataset will provide accurate number of rows matched for delete and update statements, true by default. Accurate in this case is the number of rows matched by the dataset's filter.
# File lib/sequel/dataset/features.rb, line 18 def provides_accurate_rows_matched? true end
Whether this dataset quotes identifiers.
# File lib/sequel/dataset/features.rb, line 11 def quote_identifiers? @opts.fetch(:quote_identifiers, true) end
Whether you must use a column alias list for recursive CTEs, false by default.
# File lib/sequel/dataset/features.rb, line 23 def recursive_cte_requires_column_aliases? false end
Whether type specifiers are required for prepared statement/bound variable argument placeholders (i.e. :bv__integer), false by default.
# File lib/sequel/dataset/features.rb, line 40 def requires_placeholder_type_specifiers? false end
Whether the dataset requires SQL standard datetimes. False by default, as most allow strings with ISO 8601 format. Only for backwards compatibility, no longer used internally, do not use in new code.
# File lib/sequel/dataset/features.rb, line 32 def requires_sql_standard_datetimes? # SEQUEL6: Remove false end
Whether the dataset supports common table expressions, false by default. 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 47 def supports_cte?(type=:select) false end
Whether the dataset supports common table expressions in subqueries, false by default. 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 54 def supports_cte_in_subqueries? false end
Whether deleting from joined datasets is supported, false by default.
# File lib/sequel/dataset/features.rb, line 59 def supports_deleting_joins? supports_modifying_joins? end
Whether the database supports derived column lists (e.g. “table_expr AS table_alias(column_alias1, column_alias2, …)”), true by default.
# File lib/sequel/dataset/features.rb, line 66 def supports_derived_column_lists? true end
Whether the dataset supports or can emulate the DISTINCT ON clause, false by default.
# File lib/sequel/dataset/features.rb, line 71 def supports_distinct_on? false end
Whether the dataset supports CUBE with GROUP BY, false by default.
# File lib/sequel/dataset/features.rb, line 76 def supports_group_cube? false end
Whether the dataset supports ROLLUP with GROUP BY, false by default.
# File lib/sequel/dataset/features.rb, line 81 def supports_group_rollup? false end
Whether the dataset supports GROUPING SETS with GROUP BY, false by default.
# File lib/sequel/dataset/features.rb, line 86 def supports_grouping_sets? false end
Whether this dataset supports the insert_select
method for
returning all columns values directly from an insert query, false by
default.
# File lib/sequel/dataset/features.rb, line 92 def supports_insert_select? supports_returning?(:insert) end
Whether the dataset supports the INTERSECT and EXCEPT compound operations, true by default.
# File lib/sequel/dataset/features.rb, line 97 def supports_intersect_except? true end
Whether the dataset supports the INTERSECT ALL and EXCEPT ALL compound operations, true by default.
# File lib/sequel/dataset/features.rb, line 102 def supports_intersect_except_all? true end
Whether the dataset supports the IS TRUE syntax, true by default.
# File lib/sequel/dataset/features.rb, line 107 def supports_is_true? true end
Whether the dataset supports the JOIN table USING (column1, …) syntax, true by default. If false, support is emulated using JOIN table ON (table.column1 = other_table.column1).
# File lib/sequel/dataset/features.rb, line 113 def supports_join_using? true end
Whether the dataset supports LATERAL for subqueries in the FROM or JOIN clauses, false by default.
# File lib/sequel/dataset/features.rb, line 118 def supports_lateral_subqueries? false end
Whether the MERGE statement is supported, false by default.
# File lib/sequel/dataset/features.rb, line 133 def supports_merge? false end
Whether modifying joined datasets is supported, false by default.
# File lib/sequel/dataset/features.rb, line 138 def supports_modifying_joins? false end
Whether the IN/NOT IN operators support multiple columns when an array of values is given, true by default.
# File lib/sequel/dataset/features.rb, line 144 def supports_multiple_column_in? true end
Whether the dataset supports skipping raising an error instead of waiting for locked rows when returning data, false by default.
# File lib/sequel/dataset/features.rb, line 128 def supports_nowait? false end
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 155 def supports_ordered_distinct_on? supports_distinct_on? end
Whether placeholder literalizers are supported, true by default.
# File lib/sequel/dataset/features.rb, line 160 def supports_placeholder_literalizer? true end
Whether the dataset supports pattern matching by regular expressions, false by default.
# File lib/sequel/dataset/features.rb, line 165 def supports_regexp? false end
Whether the dataset supports REPLACE syntax, false by default.
# File lib/sequel/dataset/features.rb, line 170 def supports_replace? false end
Whether the RETURNING clause is supported for the given type of query,
false by default. type
can be :insert, :update, or :delete.
# File lib/sequel/dataset/features.rb, line 176 def supports_returning?(type) false end
Whether the database supports SELECT *, column FROM table
,
true by default.
# File lib/sequel/dataset/features.rb, line 186 def supports_select_all_and_column? true end
Whether the dataset supports skipping locked rows when returning data, false by default.
# File lib/sequel/dataset/features.rb, line 181 def supports_skip_locked? false end
Whether the dataset supports timezones in literal timestamps, false by default.
# File lib/sequel/dataset/features.rb, line 193 def supports_timestamp_timezones? # SEQUEL6: Remove false end
Whether the dataset supports fractional seconds in literal timestamps, true by default.
# File lib/sequel/dataset/features.rb, line 200 def supports_timestamp_usecs? true end
Whether updating joined datasets is supported, false by default.
# File lib/sequel/dataset/features.rb, line 205 def supports_updating_joins? supports_modifying_joins? end
Whether the dataset supports WHERE TRUE (or WHERE 1 for databases that that use 1 for true), true by default.
# File lib/sequel/dataset/features.rb, line 234 def supports_where_true? true end
Whether the dataset supports the WINDOW clause to define windows used by multiple window functions, false by default.
# File lib/sequel/dataset/features.rb, line 211 def supports_window_clause? false end
Whether the dataset supports the given window function option. True by default. This should only be called if supports_window_functions? is true. Possible options are :rows, :range, :groups, :offset, :exclude.
# File lib/sequel/dataset/features.rb, line 223 def supports_window_function_frame_option?(option) case option when :rows, :range, :offset true else false end end
Whether the dataset supports window functions, false by default.
# File lib/sequel/dataset/features.rb, line 216 def supports_window_functions? false end
Private Instance Methods
Whether insert(nil) or insert({}) must be emulated by using at least one value.
# File lib/sequel/dataset/features.rb, line 242 def insert_supports_empty_values? true end
Whether ORDER BY col NULLS FIRST/LAST must be emulated.
# File lib/sequel/dataset/features.rb, line 252 def requires_emulating_nulls_first? false end
Whether the dataset needs ESCAPE for LIKE for correct behavior.
# File lib/sequel/dataset/features.rb, line 247 def requires_like_escape? true end
Whether common table expressions are supported in UNION/INTERSECT/EXCEPT clauses.
# File lib/sequel/dataset/features.rb, line 257 def supports_cte_in_compounds? supports_cte_in_subqueries? end
Whether the dataset supports the FILTER clause for aggregate functions. If not, support is emulated using CASE.
# File lib/sequel/dataset/features.rb, line 263 def supports_filtered_aggregates? false end
Whether the database supports quoting function names.
# File lib/sequel/dataset/features.rb, line 268 def supports_quoted_function_names? false end
Whether the RETURNING clause is used for the given dataset.
type
can be :insert, :update, or :delete.
# File lib/sequel/dataset/features.rb, line 274 def uses_returning?(type) opts[:returning] && !@opts[:sql] && supports_returning?(type) end
Whether the dataset uses WITH ROLLUP/CUBE instead of ROLLUP()/CUBE().
# File lib/sequel/dataset/features.rb, line 279 def uses_with_rollup? false end
6 - Miscellaneous methods
↑ topAttributes
The database related to this dataset. This is the Database instance that will execute all of this dataset's queries.
The hash of options for this dataset, keys are symbols.
Public Class Methods
Constructs a new Dataset instance with an associated database and options. Datasets are usually constructed by invoking the Sequel::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 Sequel::Database#dataset method return an instance of that subclass.
# File lib/sequel/dataset/misc.rb, line 24 def initialize(db) @db = db @opts = OPTS @cache = {} freeze end
Public Instance Methods
Define a hash value such that datasets with the same class, DB, and opts will be considered equal.
# File lib/sequel/dataset/misc.rb, line 33 def ==(o) o.is_a?(self.class) && db == o.db && opts == o.opts end
An object representing the current date or time, should be an instance of Sequel.datetime_class.
# File lib/sequel/dataset/misc.rb, line 39 def current_datetime Sequel.datetime_class.now end
Return self, as datasets are always frozen.
# File lib/sequel/dataset/misc.rb, line 49 def dup self end
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 58 def each_server db.servers.each{|s| yield server(s)} end
Alias for ==
# File lib/sequel/dataset/misc.rb, line 44 def eql?(o) self == o end
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 67 def escape_like(string) string.gsub(/[\\%_]/){|m| "\\#{m}"} end
Alias of first_source_alias
# File lib/sequel/dataset/misc.rb, line 90 def first_source first_source_alias end
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[Sequel[:table].as(:t)].first_source_alias # => :t
# File lib/sequel/dataset/misc.rb, line 102 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.alias when Symbol _, _, aliaz = split_symbol(s) aliaz ? aliaz.to_sym : s else s end end
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[Sequel[:table].as(:t)].first_source_table # => :table
# File lib/sequel/dataset/misc.rb, line 127 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
Freeze the opts when freezing the dataset.
# File lib/sequel/dataset/misc.rb, line 73 def freeze @opts.freeze super end
Define a hash value such that datasets with the same class, DB, and opts, will have the same hash value.
# File lib/sequel/dataset/misc.rb, line 145 def hash [self.class, db, opts].hash end
Returns a string representation of the dataset including the class name and the corresponding SQL select statement.
# File lib/sequel/dataset/misc.rb, line 151 def inspect "#<#{visible_class_name}: #{sql.inspect}>" end
Whether this dataset is a joined dataset (multiple FROM tables or any JOINs).
# File lib/sequel/dataset/misc.rb, line 156 def joined_dataset? !!((opts[:from].is_a?(Array) && opts[:from].size > 1) || opts[:join]) end
The class to use for placeholder literalizers for the current dataset.
# File lib/sequel/dataset/misc.rb, line 161 def placeholder_literalizer_class ::Sequel::Dataset::PlaceholderLiteralizer end
A placeholder literalizer loader for the current dataset.
# File lib/sequel/dataset/misc.rb, line 166 def placeholder_literalizer_loader(&block) placeholder_literalizer_class.loader(self, &block) end
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 172 def row_number_column :x_sequel_row_number_x end
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 185 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.alias] when SQL::JoinClause [c.table, c.table_alias] else [c, nil] end end
This returns an SQL::Identifier or SQL::AliasedExpression containing an SQL identifier that represents the unqualified column for the given value. The given value should be a Symbol, SQL::Identifier, SQL::QualifiedIdentifier, or SQL::AliasedExpression containing one of those. In other cases, this returns nil.
# File lib/sequel/dataset/misc.rb, line 204 def unqualified_column_for(v) unless v.is_a?(String) _unqualified_column_for(v) end end
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 232 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 while true ta = :"#{table_alias}_#{i}" return ta unless used_aliases.include?(ta) i += 1 end else table_alias end end
Return a modified dataset with quote_identifiers set.
# File lib/sequel/dataset/misc.rb, line 249 def with_quote_identifiers(v) clone(:quote_identifiers=>v, :skip_symbol_cache=>true) end
Protected Instance Methods
The cached columns for the current dataset.
# File lib/sequel/dataset/misc.rb, line 280 def _columns cache_get(:_columns) end
Retreive a value from the dataset's cache in a thread safe manner.
# File lib/sequel/dataset/misc.rb, line 262 def cache_get(k) Sequel.synchronize{@cache[k]} end
Set a value in the dataset's cache in a thread safe manner.
# File lib/sequel/dataset/misc.rb, line 267 def cache_set(k, v) Sequel.synchronize{@cache[k] = v} end
Clear the columns hash for the current dataset. This is not a thread safe operation, so it should only be used if the dataset could not be used by another thread (such as one that was just created via clone).
# File lib/sequel/dataset/misc.rb, line 275 def clear_columns_cache @cache.delete(:_columns) end
Private Instance Methods
Internal recursive version of #unqualified_column_for, handling Strings inside of other objects.
# File lib/sequel/dataset/misc.rb, line 354 def _unqualified_column_for(v) case v when Symbol _, c, a = Sequel.split_symbol(v) c = Sequel.identifier(c) a ? c.as(a) : c when String Sequel.identifier(v) when SQL::Identifier v when SQL::QualifiedIdentifier _unqualified_column_for(v.column) when SQL::AliasedExpression if expr = unqualified_column_for(v.expression) SQL::AliasedExpression.new(expr, v.alias) end end end
Check the cache for the given key, returning the value. Otherwise, yield to get the dataset and cache the dataset under the given key.
# File lib/sequel/dataset/misc.rb, line 288 def cached_dataset(key) unless ds = cache_get(key) ds = yield cache_set(key, ds) end ds end
Return a cached placeholder literalizer for the given key if there is one for this dataset. If there isn't one, increment the counter for the number of calls for the key, and if the counter is at least three, then create a placeholder literalizer by yielding to the block, and cache it.
# File lib/sequel/dataset/misc.rb, line 302 def cached_placeholder_literalizer(key) if loader = cache_get(key) return loader unless loader.is_a?(Integer) loader += 1 if loader >= 3 loader = placeholder_literalizer_loader{|pl, _| yield pl} cache_set(key, loader) else cache_set(key, loader + 1) loader = nil end elsif cache_sql? && supports_placeholder_literalizer? cache_set(key, 1) end loader end
Return a cached placeholder literalizer for the key, unless where_block is nil and where_args is an empty array or hash. This is designed to guard against placeholder literalizer use when passing arguments to where in the uncached case and #filter_expr if a cached placeholder literalizer is used.
# File lib/sequel/dataset/misc.rb, line 326 def cached_where_placeholder_literalizer(where_args, where_block, key, &block) where_args = where_args[0] if where_args.length == 1 unless where_block return if where_args == OPTS || where_args == EMPTY_ARRAY end cached_placeholder_literalizer(key, &block) end
Set the columns for the current dataset.
# File lib/sequel/dataset/misc.rb, line 336 def columns=(v) cache_set(:_columns, v) end
Set the db, opts, and cache for the copy of the dataset.
# File lib/sequel/dataset/misc.rb, line 341 def initialize_clone(c, _=nil) @db = c.db @opts = Hash[c.opts] if cols = c.cache_get(:_columns) @cache = {:_columns=>cols} else @cache = {} end end
Return the class name for this dataset, but skip anonymous classes
# File lib/sequel/dataset/misc.rb, line 374 def visible_class_name c = self.class c = c.superclass while c.name.nil? || c.name == '' c.name end
9 - Internal Methods relating to SQL Creation
↑ topConstants
- BITWISE_METHOD_MAP
- COUNT_FROM_SELF_OPTS
- COUNT_OF_ALL_AS_COUNT
- DEFAULT
- EXISTS
- IS_LITERALS
- IS_OPERATORS
- LIKE_OPERATORS
- MERGE_TYPE_SQL
Mapping of merge types to related SQL
- N_ARITY_OPERATORS
- QUALIFY_KEYS
- REGEXP_OPERATORS
- TWO_ARITY_OPERATORS
- WILDCARD
Public Class Methods
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 224 def self.clause_methods(type, clauses) clauses.map{|clause| :"#{type}_#{clause}_sql"}.freeze end
Define a dataset literalization method for the given type in the given module, using the given clauses.
Arguments:
- mod
-
Module in which to define method
- type
-
Type of SQL literalization method to create, either :select, :insert, :update, or :delete
- clauses
-
array of clauses that make up the SQL query for the type. This can either be a single array of symbols/strings, or it can be an array of pairs, with the first element in each pair being an if/elsif/else code fragment, and the second element in each pair being an array of symbol/strings for the appropriate branch.
# File lib/sequel/dataset/sql.rb, line 238 def self.def_sql_method(mod, type, clauses) priv = type == :update || type == :insert cacheable = type == :select || type == :delete lines = [] lines << 'private' if priv lines << "def #{'_' if priv}#{type}_sql" lines << 'if sql = opts[:sql]; return static_sql(sql) end' unless priv lines << "if sql = cache_get(:_#{type}_sql); return sql end" if cacheable lines << 'check_delete_allowed!' << 'check_not_limited!(:delete)' if type == :delete lines << 'sql = @opts[:append_sql] || sql_string_origin' if clauses.all?{|c| c.is_a?(Array)} clauses.each do |i, cs| lines << i lines.concat(clause_methods(type, cs).map{|x| "#{x}(sql)"}) end lines << 'end' else lines.concat(clause_methods(type, clauses).map{|x| "#{x}(sql)"}) end lines << "cache_set(:_#{type}_sql, sql) if cache_sql?" if cacheable lines << 'sql' lines << 'end' mod.class_eval lines.join("\n"), __FILE__, __LINE__ end
Public Instance Methods
Append literalization of aliased expression to SQL string.
# File lib/sequel/dataset/sql.rb, line 299 def aliased_expression_sql_append(sql, ae) literal_append(sql, ae.expression) as_sql_append(sql, ae.alias, ae.columns) end
Append literalization of array to SQL string.
# File lib/sequel/dataset/sql.rb, line 305 def array_sql_append(sql, a) if a.empty? sql << '(NULL)' else sql << '(' expression_list_append(sql, a) sql << ')' end end
Append literalization of boolean constant to SQL string.
# File lib/sequel/dataset/sql.rb, line 316 def boolean_constant_sql_append(sql, constant) if (constant == true || constant == false) && !supports_where_true? sql << (constant == true ? '(1 = 1)' : '(1 = 0)') else literal_append(sql, constant) end end
Append literalization of case expression to SQL string.
# File lib/sequel/dataset/sql.rb, line 325 def case_expression_sql_append(sql, ce) sql << '(CASE' if ce.expression? sql << ' ' literal_append(sql, ce.expression) end w = " WHEN " t = " THEN " ce.conditions.each do |c,r| sql << w literal_append(sql, c) sql << t literal_append(sql, r) end sql << " ELSE " literal_append(sql, ce.default) sql << " END)" end
Append literalization of cast expression to SQL string.
# File lib/sequel/dataset/sql.rb, line 345 def cast_sql_append(sql, expr, type) sql << 'CAST(' literal_append(sql, expr) sql << ' AS ' << db.cast_type_literal(type).to_s sql << ')' end
Append literalization of column all selection to SQL string.
# File lib/sequel/dataset/sql.rb, line 353 def column_all_sql_append(sql, ca) qualified_identifier_sql_append(sql, ca.table, WILDCARD) end
Append literalization of complex expression to SQL string.
# File lib/sequel/dataset/sql.rb, line 358 def complex_expression_sql_append(sql, op, args) case op when *IS_OPERATORS r = args[1] if r.nil? || supports_is_true? raise(InvalidOperation, 'Invalid argument used for IS operator') unless val = IS_LITERALS[r] sql << '(' literal_append(sql, args[0]) sql << ' ' << op.to_s << ' ' sql << val << ')' 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[0], nil)]) end when :IN, :"NOT IN" cols = args[0] vals = args[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 << '(' literal_append(sql, cols) sql << ' ' << op.to_s << ' ' if val_array array_sql_append(sql, vals) else literal_append(sql, vals) end sql << ')' end else sql << '(' literal_append(sql, cols) sql << ' ' << op.to_s << ' ' literal_append(sql, vals) sql << ')' end when :LIKE, :'NOT LIKE' sql << '(' literal_append(sql, args[0]) sql << ' ' << op.to_s << ' ' literal_append(sql, args[1]) if requires_like_escape? sql << " ESCAPE " literal_append(sql, "\\") end sql << ')' when :ILIKE, :'NOT ILIKE' complex_expression_sql_append(sql, (op == :ILIKE ? :LIKE : :"NOT LIKE"), args.map{|v| Sequel.function(:UPPER, v)}) when :** function_sql_append(sql, Sequel.function(:power, *args)) 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 << '(' literal_append(sql, args[0]) sql << ' ' << op.to_s << ' ' literal_append(sql, args[1]) sql << ')' when *N_ARITY_OPERATORS sql << '(' c = false op_str = " #{op} " args.each do |a| sql << op_str if c literal_append(sql, a) c ||= true end sql << ')' when :NOT sql << 'NOT ' literal_append(sql, args[0]) when :NOOP literal_append(sql, args[0]) when :'B~' sql << '~' literal_append(sql, args[0]) when :extract sql << 'extract(' << args[0].to_s << ' FROM ' literal_append(sql, args[1]) sql << ')' else raise(InvalidOperation, "invalid operator #{op}") end end
Append literalization of constant to SQL string.
# File lib/sequel/dataset/sql.rb, line 467 def constant_sql_append(sql, constant) sql << constant.to_s end
Append literalization of delayed evaluation to SQL string, causing the delayed evaluation proc to be evaluated.
# File lib/sequel/dataset/sql.rb, line 473 def delayed_evaluation_sql_append(sql, delay) # Delayed evaluations are used specifically so the SQL # can differ in subsequent calls, so we definitely don't # want to cache the sql in this case. disable_sql_caching! if recorder = @opts[:placeholder_literalizer] recorder.use(sql, lambda{delay.call(self)}, nil) else literal_append(sql, delay.call(self)) end end
Append literalization of function call to SQL string.
# File lib/sequel/dataset/sql.rb, line 487 def function_sql_append(sql, f) name = f.name opts = f.opts if opts[:emulate] if emulate_function?(name) emulate_function_sql_append(sql, f) return end name = native_function_name(name) end sql << 'LATERAL ' if opts[:lateral] case name when SQL::Identifier if supports_quoted_function_names? && opts[:quoted] literal_append(sql, name) else sql << name.value.to_s end when SQL::QualifiedIdentifier if supports_quoted_function_names? && opts[:quoted] != false literal_append(sql, name) else sql << split_qualifiers(name).join('.') end else if supports_quoted_function_names? && opts[:quoted] quote_identifier_append(sql, name) else sql << name.to_s end end sql << '(' if filter = opts[:filter] filter = filter_expr(filter, &opts[:filter_block]) end if opts[:*] if filter && !supports_filtered_aggregates? literal_append(sql, Sequel.case({filter=>1}, nil)) filter = nil else sql << '*' end else sql << "DISTINCT " if opts[:distinct] if filter && !supports_filtered_aggregates? expression_list_append(sql, f.args.map{|arg| Sequel.case({filter=>arg}, nil)}) filter = nil else expression_list_append(sql, f.args) end if order = opts[:order] sql << " ORDER BY " expression_list_append(sql, order) end end sql << ')' if group = opts[:within_group] sql << " WITHIN GROUP (ORDER BY " expression_list_append(sql, group) sql << ')' end if filter sql << " FILTER (WHERE " literal_append(sql, filter) sql << ')' end if window = opts[:over] sql << ' OVER ' window_sql_append(sql, window.opts) end if opts[:with_ordinality] sql << " WITH ORDINALITY" end end
Append literalization of JOIN clause without ON or USING to SQL string.
# File lib/sequel/dataset/sql.rb, line 572 def join_clause_sql_append(sql, jc) table = jc.table table_alias = jc.table_alias table_alias = nil if table == table_alias && !jc.column_aliases sql << ' ' << join_type_sql(jc.join_type) << ' ' identifier_append(sql, table) as_sql_append(sql, table_alias, jc.column_aliases) if table_alias end
Append literalization of JOIN ON clause to SQL string.
# File lib/sequel/dataset/sql.rb, line 582 def join_on_clause_sql_append(sql, jc) join_clause_sql_append(sql, jc) sql << ' ON ' literal_append(sql, filter_expr(jc.on)) end
Append literalization of JOIN USING clause to SQL string.
# File lib/sequel/dataset/sql.rb, line 589 def join_using_clause_sql_append(sql, jc) join_clause_sql_append(sql, jc) join_using_clause_using_sql_append(sql, jc.using) end
Append literalization of negative boolean constant to SQL string.
# File lib/sequel/dataset/sql.rb, line 595 def negative_boolean_constant_sql_append(sql, constant) sql << 'NOT ' boolean_constant_sql_append(sql, constant) end
Append literalization of ordered expression to SQL string.
# File lib/sequel/dataset/sql.rb, line 601 def ordered_expression_sql_append(sql, oe) if emulate = requires_emulating_nulls_first? case oe.nulls when :first null_order = 0 when :last null_order = 2 end if null_order literal_append(sql, Sequel.case({{oe.expression=>nil}=>null_order}, 1)) sql << ", " end end literal_append(sql, oe.expression) sql << (oe.descending ? ' DESC' : ' ASC') unless emulate case oe.nulls when :first sql << " NULLS FIRST" when :last sql << " NULLS LAST" end end end
Append literalization of placeholder literal string to SQL string.
# File lib/sequel/dataset/sql.rb, line 630 def placeholder_literal_string_sql_append(sql, pls) args = pls.args str = pls.str sql << '(' if pls.parens if args.is_a?(Hash) if args.empty? sql << str else re = /:(#{args.keys.map{|k| Regexp.escape(k.to_s)}.join('|')})\b/ while true 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 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 raise Error, "Mismatched number of placeholders (#{str.length}) and placeholder arguments (#{args.length}) when using placeholder array" end else i = -1 match_len = args.length - 1 while true previous, q, str = str.partition('?') sql << previous literal_append(sql, args.at(i+=1)) unless q.empty? if str.empty? unless i == match_len raise Error, "Mismatched number of placeholders (#{i+1}) and placeholder arguments (#{args.length}) when using placeholder string" end break end end end sql << ')' if pls.parens end
Append literalization of qualified identifier to SQL string. 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 676 def qualified_identifier_sql_append(sql, table, column=(c = table.column; table = table.table; c)) identifier_append(sql, table) sql << '.' identifier_append(sql, column) end
Append literalization of unqualified identifier to SQL string. 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 686 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
Append literalization of identifier or unqualified identifier to SQL string.
# File lib/sequel/dataset/sql.rb, line 701 def quote_schema_table_append(sql, table) schema, table = schema_and_table(table) if schema quote_identifier_append(sql, schema) sql << '.' end quote_identifier_append(sql, table) end
Append literalization of quoted identifier to SQL string. 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 714 def quoted_identifier_append(sql, name) sql << '"' << name.to_s.gsub('"', '""') << '"' end
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 725 def schema_and_table(table_name, sch=nil) 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
Splits table_name into an array of strings.
ds.split_qualifiers(:s) # ['s'] ds.split_qualifiers(Sequel[:t][:s]) # ['t', 's'] ds.split_qualifiers(Sequel[:d][:t][:s]) # ['d', 't', 's'] ds.split_qualifiers(Sequel.qualify(Sequel[:h][:d], Sequel[:t][:s])) # ['h', 'd', 't', 's']
# File lib/sequel/dataset/sql.rb, line 748 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
Append literalization of subscripts (SQL array accesses) to SQL string.
# File lib/sequel/dataset/sql.rb, line 759 def subscript_sql_append(sql, s) case s.expression when Symbol, SQL::Subscript, SQL::Identifier, SQL::QualifiedIdentifier # nothing else wrap_expression = true sql << '(' end literal_append(sql, s.expression) if wrap_expression sql << ')[' else sql << '[' end sub = s.sub if sub.length == 1 && (range = sub.first).is_a?(Range) literal_append(sql, range.begin) sql << ':' e = range.end e -= 1 if range.exclude_end? && e.is_a?(Integer) literal_append(sql, e) else expression_list_append(sql, s.sub) end sql << ']' end
Append literalization of windows (for window functions) to SQL string.
# File lib/sequel/dataset/sql.rb, line 787 def window_sql_append(sql, opts) raise(Error, 'This dataset does not support window functions') unless supports_window_functions? space = false space_s = ' ' sql << '(' if window = opts[:window] literal_append(sql, window) space = true end if part = opts[:partition] sql << space_s if space sql << "PARTITION BY " expression_list_append(sql, Array(part)) space = true end if order = opts[:order] sql << space_s if space sql << "ORDER BY " expression_list_append(sql, Array(order)) space = true end if frame = opts[:frame] sql << space_s if space if frame.is_a?(String) sql << frame else case frame when :all frame_type = :rows frame_start = :preceding frame_end = :following when :rows, :range, :groups frame_type = frame frame_start = :preceding frame_end = :current when Hash frame_type = frame[:type] unless frame_type == :rows || frame_type == :range || frame_type == :groups raise Error, "invalid window :frame :type option: #{frame_type.inspect}" end unless frame_start = frame[:start] raise Error, "invalid window :frame :start option: #{frame_start.inspect}" end frame_end = frame[:end] frame_exclude = frame[:exclude] else raise Error, "invalid window :frame option: #{frame.inspect}" end sql << frame_type.to_s.upcase << " " sql << 'BETWEEN ' if frame_end window_frame_boundary_sql_append(sql, frame_start, :preceding) if frame_end sql << " AND " window_frame_boundary_sql_append(sql, frame_end, :following) end if frame_exclude sql << " EXCLUDE " case frame_exclude when :current sql << "CURRENT ROW" when :group sql << "GROUP" when :ties sql << "TIES" when :no_others sql << "NO OTHERS" else raise Error, "invalid window :frame :exclude option: #{frame_exclude.inspect}" end end end end sql << ')' end
Protected Instance Methods
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 876 def compound_from_self (@opts[:sql] || @opts[:limit] || @opts[:order] || @opts[:offset]) ? from_self : self end
Private Instance Methods
Internals of the check_*_allowed! methods
# File lib/sequel/dataset/sql.rb, line 1057 def _check_modification_allowed!(modifying_joins_supported) raise(InvalidOperation, "Grouped datasets cannot be modified") if opts[:group] raise(InvalidOperation, "Joined datasets cannot be modified") if !modifying_joins_supported && joined_dataset? end
# File lib/sequel/dataset/sql.rb, line 1267 def _insert_columns_sql(sql, columns) if columns && !columns.empty? sql << ' (' identifier_list_append(sql, columns) sql << ')' end end
# File lib/sequel/dataset/sql.rb, line 1289 def _insert_values_sql(sql, values) case values when Array if values.empty? sql << " DEFAULT VALUES" else sql << " VALUES " literal_append(sql, values) end when Dataset sql << ' ' subselect_sql_append(sql, values) when LiteralString sql << ' ' << values else raise Error, "Unsupported INSERT values type, should be an Array or Dataset: #{values.inspect}" end end
# File lib/sequel/dataset/sql.rb, line 895 def _merge_delete_sql(sql, data) sql << " THEN DELETE" end
Append the INSERT sql used in a MERGE
# File lib/sequel/dataset/sql.rb, line 883 def _merge_insert_sql(sql, data) sql << " THEN INSERT" columns, values = _parse_insert_sql_args(data[:values]) _insert_columns_sql(sql, columns) _insert_values_sql(sql, values) end
# File lib/sequel/dataset/sql.rb, line 890 def _merge_update_sql(sql, data) sql << " THEN UPDATE SET " update_sql_values_hash(sql, data[:values]) end
Append MERGE WHEN conditions, if there are conditions provided.
# File lib/sequel/dataset/sql.rb, line 921 def _merge_when_conditions_sql(sql, data) if data.has_key?(:conditions) sql << " AND " literal_append(sql, data[:conditions]) end end
Add the WHEN clauses to the MERGE SQL
# File lib/sequel/dataset/sql.rb, line 910 def _merge_when_sql(sql) raise Error, "no WHEN [NOT] MATCHED clauses provided for MERGE" unless merge_when = @opts[:merge_when] merge_when.each do |data| type = data[:type] sql << MERGE_TYPE_SQL[type] _merge_when_conditions_sql(sql, data) send(:"_merge_#{type}_sql", sql, data) end end
Parse the values passed to #insert_sql, returning columns and values to use for the INSERT. Returned columns is always an array, but can be empty for an INSERT without explicit column references. Returned values can be an array, dataset, or literal string.
# File lib/sequel/dataset/sql.rb, line 932 def _parse_insert_sql_args(values) columns = [] case values.size when 0 values = [] when 1 case vals = values[0] when Hash values = [] vals.each do |k,v| columns << k values << v end when Dataset, Array, LiteralString values = vals end when 2 if (v0 = values[0]).is_a?(Array) && ((v1 = values[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 [columns, values] end
Formats the truncate statement. Assumes the table given has already been literalized.
# File lib/sequel/dataset/sql.rb, line 961 def _truncate_sql(table) "TRUNCATE TABLE #{table}" end
Whether to use #from_self for an aggregate dataset.
# File lib/sequel/dataset/sql.rb, line 1010 def aggreate_dataset_use_from_self? options_overlap(COUNT_FROM_SELF_OPTS) end
Clone of this dataset usable in aggregate operations. Does a #from_self if dataset contains any parameters that would affect normal aggregation, or just removes an existing order if not. Also removes the #row_proc, which isn't needed for aggregate calculations.
# File lib/sequel/dataset/sql.rb, line 1005 def aggregate_dataset (aggreate_dataset_use_from_self? ? from_self : unordered).naked end
Returns an appropriate symbol for the alias represented by s.
# File lib/sequel/dataset/sql.rb, line 966 def alias_alias_symbol(s) case s when Symbol s when String s.to_sym when SQL::Identifier s.value.to_s.to_sym else raise Error, "Invalid alias for alias_alias_symbol: #{s.inspect}" end end
Returns an appropriate alias symbol for the given object, which can be a Symbol, String, SQL::Identifier, SQL::QualifiedIdentifier, or SQL::AliasedExpression.
# File lib/sequel/dataset/sql.rb, line 982 def alias_symbol(sym) case sym when Symbol s, t, a = split_symbol(sym) a || s ? (a || t).to_sym : sym when String sym.to_sym when SQL::Identifier sym.value.to_s.to_sym when SQL::QualifiedIdentifier alias_symbol(sym.column) when SQL::AliasedExpression alias_alias_symbol(sym.alias) else raise Error, "Invalid alias for alias_symbol: #{sym.inspect}" end end
Append aliasing expression to SQL string.
# File lib/sequel/dataset/sql.rb, line 1015 def as_sql_append(sql, aliaz, column_aliases=nil) sql << ' AS ' quote_identifier_append(sql, aliaz) if column_aliases raise Error, "#{db.database_type} does not support derived column lists" unless supports_derived_column_lists? sql << '(' identifier_list_append(sql, column_aliases) sql << ')' end end
Don't allow caching SQL if specifically marked not to.
# File lib/sequel/dataset/sql.rb, line 1027 def cache_sql? !@opts[:no_cache_sql] && !cache_get(:_no_cache_sql) end
Check whether it is allowed to delete from this dataset.
# File lib/sequel/dataset/sql.rb, line 1047 def check_delete_allowed! _check_modification_allowed!(supports_deleting_joins?) end
Check whether it is allowed to insert into this dataset.
# File lib/sequel/dataset/sql.rb, line 1041 def check_insert_allowed! _check_modification_allowed!(false) end
Raise an InvalidOperation exception if modification is not allowed for this dataset. Check whether it is allowed to insert into this dataset. Only for backwards compatibility with older external adapters.
# File lib/sequel/dataset/sql.rb, line 1034 def check_modification_allowed! # SEQUEL6: Remove Sequel::Deprecation.deprecate("Dataset#check_modification_allowed!", "Use check_{insert,delete,update,truncation}_allowed! instead") _check_modification_allowed!(supports_modifying_joins?) end
Raise error if the dataset uses limits or offsets.
# File lib/sequel/dataset/sql.rb, line 1063 def check_not_limited!(type) return if @opts[:skip_limit_check] && type != :truncate raise InvalidOperation, "Dataset##{type} not supported on datasets with limits or offsets" if opts[:limit] || opts[:offset] end
Check whether it is allowed to update this dataset.
# File lib/sequel/dataset/sql.rb, line 1052 def check_update_allowed! _check_modification_allowed!(supports_updating_joins?) end
Append column list to SQL string. If the column list is empty, a wildcard (*) is appended.
# File lib/sequel/dataset/sql.rb, line 1070 def column_list_append(sql, columns) if (columns.nil? || columns.empty?) sql << '*' else expression_list_append(sql, columns) end end
Yield each pair of arguments to the block, which should return an object representing the SQL expression for those two arguments. For more than two arguments, the first argument to the block will be result of the previous block call.
# File lib/sequel/dataset/sql.rb, line 1082 def complex_expression_arg_pairs(args) case args.length when 1 args[0] when 2 yield args[0], args[1] else args.inject{|m, a| yield(m, a)} end end
Append the literalization of the args using #complex_expression_arg_pairs to the given SQL string, used when database operator/function is 2-ary where Sequel expression is N-ary.
# File lib/sequel/dataset/sql.rb, line 1096 def complex_expression_arg_pairs_append(sql, args, &block) literal_append(sql, complex_expression_arg_pairs(args, &block)) end
Append literalization of complex expression to SQL string, for operators unsupported by some databases. Used by adapters for databases that don't support the operators natively.
# File lib/sequel/dataset/sql.rb, line 1103 def complex_expression_emulate_append(sql, op, args) # :nocov: case op # :nocov: when :% complex_expression_arg_pairs_append(sql, args){|a, b| Sequel.function(:MOD, a, b)} when :>> complex_expression_arg_pairs_append(sql, args){|a, b| Sequel./(a, Sequel.function(:power, 2, b))} when :<< complex_expression_arg_pairs_append(sql, args){|a, b| Sequel.*(a, Sequel.function(:power, 2, b))} when :&, :|, :^ f = BITWISE_METHOD_MAP[op] complex_expression_arg_pairs_append(sql, args){|a, b| Sequel.function(f, a, b)} when :'B~' sql << "((0 - " literal_append(sql, args[0]) sql << ") - 1)" end end
Append literalization of dataset used in UNION/INTERSECT/EXCEPT clause to SQL string.
# File lib/sequel/dataset/sql.rb, line 1124 def compound_dataset_sql_append(sql, ds) subselect_sql_append(sql, ds) end
The alias to use for datasets, takes a number to make sure the name is unique.
# File lib/sequel/dataset/sql.rb, line 1129 def dataset_alias(number) :"t#{number}" end
The strftime format to use when literalizing time (Sequel::SQLTime) values.
# File lib/sequel/dataset/sql.rb, line 1134 def default_time_format "'%H:%M:%S.%6N'" end
The strftime format to use when literalizing timestamp (Time/DateTime) values.
# File lib/sequel/dataset/sql.rb, line 1139 def default_timestamp_format "'%Y-%m-%d %H:%M:%S.%6N'" end
# File lib/sequel/dataset/sql.rb, line 1143 def delete_delete_sql(sql) sql << 'DELETE' end
# File lib/sequel/dataset/sql.rb, line 1147 def delete_from_sql(sql) if f = @opts[:from] sql << ' FROM ' source_list_append(sql, f) end end
Disable caching of SQL for the current dataset
# File lib/sequel/dataset/sql.rb, line 1155 def disable_sql_caching! cache_set(:_no_cache_sql, true) end
An expression for how to handle an empty array lookup.
# File lib/sequel/dataset/sql.rb, line 1199 def empty_array_value(op, cols) {1 => ((op == :IN) ? 0 : 1)} end
An SQL FROM clause to use in SELECT statements where the dataset has no from tables.
# File lib/sequel/dataset/sql.rb, line 1161 def empty_from_sql nil end
Whether to emulate the function with the given name. This should only be true if the emulation goes beyond choosing a function with a different name.
# File lib/sequel/dataset/sql.rb, line 1167 def emulate_function?(name) false end
Append literalization of array of expressions to SQL string, separating them with commas.
# File lib/sequel/dataset/sql.rb, line 1173 def expression_list_append(sql, columns) c = false co = ', ' columns.each do |col| sql << co if c literal_append(sql, col) c ||= true end end
Format the timestamp based on the default_timestamp_format.
# File lib/sequel/dataset/sql.rb, line 1204 def format_timestamp(v) db.from_application_timestamp(v).strftime(default_timestamp_format) end
Return the SQL timestamp fragment to use for the fractional time part. Should start with the decimal point. Uses 6 decimal places by default.
# File lib/sequel/dataset/sql.rb, line 1212 def format_timestamp_usec(usec, ts=timestamp_precision) # SEQUEL6: Remove unless ts == 6 usec = usec/(10 ** (6 - ts)) end sprintf(".%0#{ts}d", usec) end
Append literalization of array of grouping elements to SQL string, seperating them with commas.
# File lib/sequel/dataset/sql.rb, line 1184 def grouping_element_list_append(sql, columns) c = false co = ', ' columns.each do |col| sql << co if c if col.is_a?(Array) && col.empty? sql << '()' else literal_append(sql, Array(col)) end c ||= true end end
Append literalization of identifier to SQL string, considering regular strings as SQL identifiers instead of SQL strings.
# File lib/sequel/dataset/sql.rb, line 1223 def identifier_append(sql, v) if v.is_a?(String) case v when LiteralString sql << v when SQL::Blob literal_append(sql, v) else quote_identifier_append(sql, v) end else literal_append(sql, v) end end
Append literalization of array of identifiers to SQL string.
# File lib/sequel/dataset/sql.rb, line 1239 def identifier_list_append(sql, args) c = false comma = ', ' args.each do |a| sql << comma if c identifier_append(sql, a) c ||= true end end
Upcase identifiers by default when inputting them into the database.
# File lib/sequel/dataset/sql.rb, line 1250 def input_identifier(v) v.to_s.upcase end
# File lib/sequel/dataset/sql.rb, line 1263 def insert_columns_sql(sql) _insert_columns_sql(sql, opts[:columns]) end
The columns and values to use for an empty insert if the database doesn't support INSERT with DEFAULT VALUES.
# File lib/sequel/dataset/sql.rb, line 1277 def insert_empty_columns_values [[columns.last], [DEFAULT]] end
# File lib/sequel/dataset/sql.rb, line 1281 def insert_insert_sql(sql) sql << "INSERT" end
# File lib/sequel/dataset/sql.rb, line 1254 def insert_into_sql(sql) sql << " INTO " if (f = @opts[:from]) && f.length == 1 identifier_append(sql, unaliased_identifier(f.first)) else source_list_append(sql, f) end end
# File lib/sequel/dataset/sql.rb, line 1308 def insert_returning_sql(sql) if opts.has_key?(:returning) sql << " RETURNING " column_list_append(sql, Array(opts[:returning])) end end
# File lib/sequel/dataset/sql.rb, line 1285 def insert_values_sql(sql) _insert_values_sql(sql, opts[:values]) end
SQL fragment specifying a JOIN type, converts underscores to spaces and upcases.
# File lib/sequel/dataset/sql.rb, line 1319 def join_type_sql(join_type) "#{join_type.to_s.gsub('_', ' ').upcase} JOIN" end
Append USING clause for JOIN USING
# File lib/sequel/dataset/sql.rb, line 1324 def join_using_clause_using_sql_append(sql, using_columns) sql << ' USING (' column_list_append(sql, using_columns) sql << ')' end
Append a literalization of the array to SQL string. Treats as an expression if an array of all two pairs, or as a SQL array otherwise.
# File lib/sequel/dataset/sql.rb, line 1332 def literal_array_append(sql, v) if Sequel.condition_specifier?(v) literal_expression_append(sql, SQL::BooleanExpression.from_value_pairs(v)) else array_sql_append(sql, v) end end
SQL fragment for BigDecimal
# File lib/sequel/dataset/sql.rb, line 1341 def literal_big_decimal(v) d = v.to_s("F") v.nan? || v.infinite? ? "'#{d}'" : d end
Append literalization of dataset to SQL string. Does a subselect inside parantheses.
# File lib/sequel/dataset/sql.rb, line 1352 def literal_dataset_append(sql, v) sql << 'LATERAL ' if v.opts[:lateral] sql << '(' subselect_sql_append(sql, v) sql << ')' end
SQL fragment for Date, using the ISO8601 format.
# File lib/sequel/dataset/sql.rb, line 1360 def literal_date(v) v.strftime("'%Y-%m-%d'") end
Append literalization of date to SQL string.
# File lib/sequel/dataset/sql.rb, line 1365 def literal_date_append(sql, v) sql << literal_date(v) end
SQL fragment for DateTime
# File lib/sequel/dataset/sql.rb, line 1370 def literal_datetime(v) format_timestamp(v) end
Append literalization of DateTime to SQL string.
# File lib/sequel/dataset/sql.rb, line 1375 def literal_datetime_append(sql, v) sql << literal_datetime(v) end
Append literalization of SQL::Expression to SQL string.
# File lib/sequel/dataset/sql.rb, line 1380 def literal_expression_append(sql, v) v.to_s_append(self, sql) end
SQL fragment for false
# File lib/sequel/dataset/sql.rb, line 1385 def literal_false "'f'" end
SQL fragment for Float
# File lib/sequel/dataset/sql.rb, line 1390 def literal_float(v) v.to_s end
SQL fragment for Integer
# File lib/sequel/dataset/sql.rb, line 1400 def literal_integer(v) v.to_s end
SQL fragment for nil
# File lib/sequel/dataset/sql.rb, line 1405 def literal_nil "NULL" end
Append a literalization of the object to the given SQL string. Calls sql_literal_append
if
object responds to it, otherwise calls sql_literal
if object
responds to it, otherwise raises an error. If a database specific type is
allowed, this should be overriden in a subclass.
# File lib/sequel/dataset/sql.rb, line 1413 def literal_other_append(sql, v) # We can't be sure if v will always literalize to the same SQL, so # don't cache SQL for a dataset that uses this. disable_sql_caching! if v.respond_to?(:sql_literal_append) v.sql_literal_append(self, sql) elsif v.respond_to?(:sql_literal) sql << v.sql_literal(self) else raise Error, "can't express #{v.inspect} as a SQL literal" end end
SQL fragment for Sequel::SQLTime, containing just the time part
# File lib/sequel/dataset/sql.rb, line 1428 def literal_sqltime(v) v.strftime(default_time_format) end
Append literalization of Sequel::SQLTime to SQL string.
# File lib/sequel/dataset/sql.rb, line 1433 def literal_sqltime_append(sql, v) sql << literal_sqltime(v) end
Append literalization of string to SQL string.
# File lib/sequel/dataset/sql.rb, line 1438 def literal_string_append(sql, v) sql << "'" << v.gsub("'", "''") << "'" end
Append literalization of symbol to SQL string.
# File lib/sequel/dataset/sql.rb, line 1443 def literal_symbol_append(sql, v) c_table, column, c_alias = split_symbol(v) if c_table quote_identifier_append(sql, c_table) sql << '.' end quote_identifier_append(sql, column) as_sql_append(sql, c_alias) if c_alias end
SQL fragment for Time
# File lib/sequel/dataset/sql.rb, line 1454 def literal_time(v) format_timestamp(v) end
Append literalization of Time to SQL string.
# File lib/sequel/dataset/sql.rb, line 1459 def literal_time_append(sql, v) sql << literal_time(v) end
SQL fragment for true
# File lib/sequel/dataset/sql.rb, line 1464 def literal_true "'t'" end
What strategy to use for import/multi_insert. While SQL-92 defaults to allowing multiple rows in a VALUES clause, there are enough databases that don't allow that that it can't be the default. Use separate queries by default, which works everywhere.
# File lib/sequel/dataset/sql.rb, line 1472 def multi_insert_sql_strategy :separate end
Get the native function name given the emulated function name.
# File lib/sequel/dataset/sql.rb, line 1478 def native_function_name(emulated_function) emulated_function end
Returns a qualified column name (including a table name) if the column name isn't already qualified.
# File lib/sequel/dataset/sql.rb, line 1484 def qualified_column_name(column, table) if column.is_a?(Symbol) c_table, column, _ = split_symbol(column) unless c_table case table when Symbol schema, table, t_alias = split_symbol(table) t_alias ||= Sequel::SQL::QualifiedIdentifier.new(schema, table) if schema when Sequel::SQL::AliasedExpression t_alias = table.alias end c_table = t_alias || table end ::Sequel::SQL::QualifiedIdentifier.new(c_table, column) else column end end
Qualify the given expression to the given table.
# File lib/sequel/dataset/sql.rb, line 1504 def qualified_expression(e, table) Qualifier.new(table).transform(e) end
# File lib/sequel/dataset/sql.rb, line 1508 def select_columns_sql(sql) sql << ' ' column_list_append(sql, @opts[:select]) end
Modify the sql to add a dataset to the via an EXCEPT, INTERSECT, or UNION clause. This uses a subselect for the compound datasets used, because using parantheses doesn't work on all databases.
# File lib/sequel/dataset/sql.rb, line 1527 def select_compounds_sql(sql) return unless c = @opts[:compounds] c.each do |type, dataset, all| sql << ' ' << type.to_s.upcase sql << ' ALL' if all sql << ' ' compound_dataset_sql_append(sql, dataset) end end
# File lib/sequel/dataset/sql.rb, line 1513 def select_distinct_sql(sql) if distinct = @opts[:distinct] sql << " DISTINCT" unless distinct.empty? sql << " ON (" expression_list_append(sql, distinct) sql << ')' end end end
# File lib/sequel/dataset/sql.rb, line 1537 def select_from_sql(sql) if f = @opts[:from] sql << ' FROM ' source_list_append(sql, f) elsif f = empty_from_sql sql << f end end
# File lib/sequel/dataset/sql.rb, line 1546 def select_group_sql(sql) if group = @opts[:group] sql << " GROUP BY " if go = @opts[:group_options] if go == :"grouping sets" sql << go.to_s.upcase << '(' grouping_element_list_append(sql, group) sql << ')' elsif uses_with_rollup? expression_list_append(sql, group) sql << " WITH " << go.to_s.upcase else sql << go.to_s.upcase << '(' expression_list_append(sql, group) sql << ')' end else expression_list_append(sql, group) end end end
# File lib/sequel/dataset/sql.rb, line 1568 def select_having_sql(sql) if having = @opts[:having] sql << " HAVING " literal_append(sql, having) end end
# File lib/sequel/dataset/sql.rb, line 1575 def select_join_sql(sql) if js = @opts[:join] js.each{|j| literal_append(sql, j)} end end
# File lib/sequel/dataset/sql.rb, line 1581 def select_limit_sql(sql) if l = @opts[:limit] sql << " LIMIT " literal_append(sql, l) if o = @opts[:offset] sql << " OFFSET " literal_append(sql, o) end elsif @opts[:offset] select_only_offset_sql(sql) end end
# File lib/sequel/dataset/sql.rb, line 1594 def select_lock_sql(sql) case l = @opts[:lock] when :update sql << ' FOR UPDATE' when String sql << ' ' << l end end
Used only if there is an offset and no limit, making it easier to override in the adapter, as many databases do not support just a plain offset with no limit.
# File lib/sequel/dataset/sql.rb, line 1606 def select_only_offset_sql(sql) sql << " OFFSET " literal_append(sql, @opts[:offset]) end
# File lib/sequel/dataset/sql.rb, line 1611 def select_order_sql(sql) if o = @opts[:order] sql << " ORDER BY " expression_list_append(sql, o) end end
# File lib/sequel/dataset/sql.rb, line 1620 def select_select_sql(sql) sql << 'SELECT' end
# File lib/sequel/dataset/sql.rb, line 1624 def select_where_sql(sql) if w = @opts[:where] sql << " WHERE " literal_append(sql, w) end end
# File lib/sequel/dataset/sql.rb, line 1633 def select_window_sql(sql) if ws = @opts[:window] sql << " WINDOW " c = false co = ', ' as = ' AS ' ws.map do |name, window| sql << co if c literal_append(sql, name) sql << as literal_append(sql, window) c ||= true end end end
# File lib/sequel/dataset/sql.rb, line 1649 def select_with_sql(sql) return unless supports_cte? ctes = opts[:with] return if !ctes || ctes.empty? sql << select_with_sql_base c = false comma = ', ' ctes.each do |cte| sql << comma if c select_with_sql_cte(sql, cte) c ||= true end sql << ' ' end
# File lib/sequel/dataset/sql.rb, line 1667 def select_with_sql_base "WITH " end
# File lib/sequel/dataset/sql.rb, line 1671 def select_with_sql_cte(sql, cte) select_with_sql_prefix(sql, cte) literal_dataset_append(sql, cte[:dataset]) end
# File lib/sequel/dataset/sql.rb, line 1676 def select_with_sql_prefix(sql, w) quote_identifier_append(sql, w[:name]) if args = w[:args] sql << '(' identifier_list_append(sql, args) sql << ')' end sql << ' AS ' case w[:materialized] when true sql << "MATERIALIZED " when false sql << "NOT MATERIALIZED " end end
Whether the symbol cache should be skipped when literalizing the dataset
# File lib/sequel/dataset/sql.rb, line 1694 def skip_symbol_cache? @opts[:skip_symbol_cache] end
Append literalization of array of sources/tables to SQL string, raising an Error if there are no sources.
# File lib/sequel/dataset/sql.rb, line 1700 def source_list_append(sql, sources) raise(Error, 'No source specified for query') if sources.nil? || sources == [] identifier_list_append(sql, sources) end
Delegate to Sequel.split_symbol.
# File lib/sequel/dataset/sql.rb, line 1706 def split_symbol(sym) Sequel.split_symbol(sym) end
The string that is appended to to create the SQL query, the empty string by default.
# File lib/sequel/dataset/sql.rb, line 1712 def sql_string_origin String.new end
The precision to use for SQLTime instances (time column values without dates). Defaults to timestamp_precision.
# File lib/sequel/dataset/sql.rb, line 1718 def sqltime_precision timestamp_precision end
SQL to use if this dataset uses static SQL. Since static SQL can be a PlaceholderLiteralString in addition to a String, we literalize nonstrings. If there is an append_sql for this dataset, append to that SQL instead of returning the value.
# File lib/sequel/dataset/sql.rb, line 1726 def static_sql(sql) if append_sql = @opts[:append_sql] if sql.is_a?(String) append_sql << sql else literal_append(append_sql, sql) end else if sql.is_a?(String) sql else literal(sql) end end end
Append literalization of the subselect to SQL string.
# File lib/sequel/dataset/sql.rb, line 1743 def subselect_sql_append(sql, ds) sds = subselect_sql_dataset(sql, ds) subselect_sql_append_sql(sql, sds) unless sds.send(:cache_sql?) # If subquery dataset does not allow caching SQL, # then this dataset should not allow caching SQL. disable_sql_caching! end end
# File lib/sequel/dataset/sql.rb, line 1757 def subselect_sql_append_sql(sql, ds) ds.sql end
# File lib/sequel/dataset/sql.rb, line 1753 def subselect_sql_dataset(sql, ds) ds.clone(:append_sql=>sql) end
The number of decimal digits of precision to use in timestamps.
# File lib/sequel/dataset/sql.rb, line 1762 def timestamp_precision supports_timestamp_usecs? ? 6 : 0 end
# File lib/sequel/dataset/sql.rb, line 1772 def update_set_sql(sql) sql << ' SET ' values = @opts[:values] if values.is_a?(Hash) update_sql_values_hash(sql, values) else sql << values end end
# File lib/sequel/dataset/sql.rb, line 1782 def update_sql_values_hash(sql, values) c = false eq = ' = ' values.each do |k, v| sql << ', ' if c if k.is_a?(String) && !k.is_a?(LiteralString) quote_identifier_append(sql, k) else literal_append(sql, k) end sql << eq literal_append(sql, v) c ||= true end end
# File lib/sequel/dataset/sql.rb, line 1766 def update_table_sql(sql) sql << ' ' source_list_append(sql, @opts[:from]) select_join_sql(sql) if supports_modifying_joins? end
# File lib/sequel/dataset/sql.rb, line 1798 def update_update_sql(sql) sql << 'UPDATE' end
# File lib/sequel/dataset/sql.rb, line 1802 def window_frame_boundary_sql_append(sql, boundary, direction) case boundary when :current sql << "CURRENT ROW" when :preceding sql << "UNBOUNDED PRECEDING" when :following sql << "UNBOUNDED FOLLOWING" else if boundary.is_a?(Array) offset, direction = boundary unless boundary.length == 2 && (direction == :preceding || direction == :following) raise Error, "invalid window :frame boundary (:start or :end) option: #{boundary.inspect}" end else offset = boundary end case offset when Numeric, String, SQL::Cast # nothing else raise Error, "invalid window :frame boundary (:start or :end) option: #{boundary.inspect}" end literal_append(sql, offset) sql << (direction == :preceding ? " PRECEDING" : " FOLLOWING") end end