module Sequel::CoreRefinements
:nocov:
Public Instance Methods
Return a Sequel::SQL::BooleanExpression
created from this hash, matching all of the conditions in this hash and the condition specified by the given argument.
{a: 1} & :b # SQL: ((a = 1) AND b) {a: true} & ~:b # SQL: ((a IS TRUE) AND NOT b)
# File lib/sequel/extensions/core_refinements.rb 102 def &(ce) 103 ::Sequel::SQL::BooleanExpression.new(:AND, self, ce) 104 end
Return a Sequel::SQL::CaseExpression
with this array as the conditions and the given default value and expression.
[[{a: [2,3]}, 1]].case(0) # SQL: CASE WHEN (a IN (2, 3)) THEN 1 ELSE 0 END [[:a, 1], [:b, 2]].case(:d, :c) # SQL: CASE c WHEN a THEN 1 WHEN b THEN 2 ELSE d END
# File lib/sequel/extensions/core_refinements.rb 33 def case(*args) 34 ::Sequel::SQL::CaseExpression.new(self, *args) 35 end
# File lib/sequel/extensions/pg_hstore.rb 342 def hstore 343 Sequel::Postgres::HStore.new(self) 344 end
Returns receiver wrapped in an Sequel::SQL::Identifier
.
:ab.identifier # SQL: "a"
# File lib/sequel/extensions/core_refinements.rb 205 def identifier 206 Sequel::SQL::Identifier.new(self) 207 end
Converts a string into a Sequel::LiteralString
, in order to override string literalization, e.g.:
DB[:items].where(abc: 'def') # "SELECT * FROM items WHERE (abc = 'def')" DB[:items].where(abc: 'def'.lit) # "SELECT * FROM items WHERE (abc = def)"
You can also provide arguments, to create a Sequel::SQL::PlaceholderLiteralString
:
DB[:items].select{|o| o.count('DISTINCT ?'.lit(:a))} # "SELECT count(DISTINCT a) FROM items"
# File lib/sequel/extensions/core_refinements.rb 180 def lit(*args) 181 args.empty? ? Sequel::LiteralString.new(self) : Sequel::SQL::PlaceholderLiteralString.new(self, args) 182 end
# File lib/sequel/extensions/pg_array.rb 521 def pg_array(type=nil) 522 Sequel::Postgres::PGArray.new(self, type) 523 end
# File lib/sequel/extensions/pg_json.rb 626 def pg_json 627 Sequel::Postgres::JSONArray.new(self) 628 end
# File lib/sequel/extensions/pg_json.rb 630 def pg_jsonb 631 Sequel::Postgres::JSONBArray.new(self) 632 end
# File lib/sequel/extensions/pg_range.rb 567 def pg_range(db_type=nil) 568 Sequel::Postgres::PGRange.from_range(self, db_type) 569 end
# File lib/sequel/extensions/pg_row.rb 576 def pg_row 577 Sequel::Postgres::PGRow::ArrayRow.new(self) 578 end
Return a Sequel::SQL::BooleanExpression
created from this array, matching all of the conditions. Rarely do you need to call this explicitly, as Sequel
generally assumes that arrays of two element arrays specify this type of condition. One case where it can be necessary to use this is if you are using the object as a value in a filter hash and want to use the = operator instead of the IN operator (which is used by default for arrays of two element arrays).
[[:a, true]].sql_expr # SQL: (a IS TRUE) [[:a, 1], [:b, [2, 3]]].sql_expr # SQL: ((a = 1) AND (b IN (2, 3)))
# File lib/sequel/extensions/core_refinements.rb 59 def sql_expr 60 Sequel[self] 61 end
Returns a Sequel::SQL::Function
with this as the function name, and the given arguments.
:now.sql_function # SQL: now() :sum.sql_function(:a) # SQL: sum(a) :concat.sql_function(:a, :b) # SQL: concat(a, b)
# File lib/sequel/extensions/core_refinements.rb 215 def sql_function(*args) 216 Sequel::SQL::Function.new(self, *args) 217 end
Return a Sequel::SQL::BooleanExpression
created from this array, matching none of the conditions.
[[:a, true]].sql_negate # SQL: (a IS NOT TRUE) [[:a, 1], [:b, [2, 3]]].sql_negate # SQL: ((a != 1) AND (b NOT IN (2, 3)))
# File lib/sequel/extensions/core_refinements.rb 68 def sql_negate 69 Sequel.negate(self) 70 end
Return a Sequel::SQL::BooleanExpression
created from this array, matching any of the conditions.
[[:a, true]].sql_or # SQL: (a IS TRUE) [[:a, 1], [:b, [2, 3]]].sql_or # SQL: ((a = 1) OR (b IN (2, 3)))
# File lib/sequel/extensions/core_refinements.rb 77 def sql_or 78 Sequel.or(self) 79 end
Return a Sequel::SQL::StringExpression
representing an SQL
string made up of the concatenation of this array's elements. If an argument is passed it is used in between each element of the array in the SQL
concatenation.
[:a].sql_string_join # SQL: a [:a, :b].sql_string_join # SQL: (a || b) [:a, 'b'].sql_string_join # SQL: (a || 'b') ['a', :b].sql_string_join(' ') # SQL: ('a' || ' ' || b)
# File lib/sequel/extensions/core_refinements.rb 90 def sql_string_join(joiner=nil) 91 Sequel.join(self, joiner) 92 end
Return a Sequel::SQL::ValueList
created from this array. Used if this array contains all two element arrays and you want it treated as an SQL
value list (IN predicate) instead of as a conditions specifier (similar to a hash). This is not necessary if you are using this array as a value in a filter, but may be necessary if you are using it as a value with placeholder SQL:
DB[:a].where([:a, :b]=>[[1, 2], [3, 4]]) # SQL: ((a, b) IN ((1, 2), (3, 4))) DB[:a].where('(a, b) IN ?', [[1, 2], [3, 4]]) # SQL: ((a, b) IN ((1 = 2) AND (3 = 4))) DB[:a].where('(a, b) IN ?', [[1, 2], [3, 4]].sql_value_list) # SQL: ((a, b) IN ((1, 2), (3, 4)))
# File lib/sequel/extensions/core_refinements.rb 46 def sql_value_list 47 ::Sequel::SQL::ValueList.new(self) 48 end
Returns a Sequel::SQL::Blob
that holds the same data as this string. Blobs provide proper escaping of binary data.
# File lib/sequel/extensions/core_refinements.rb 186 def to_sequel_blob 187 ::Sequel::SQL::Blob.new(self) 188 end
Return a Sequel::SQL::BooleanExpression
created from this hash, matching all of the conditions in this hash or the condition specified by the given argument.
{a: 1} | :b # SQL: ((a = 1) OR b) {a: true} | ~:b # SQL: ((a IS TRUE) OR NOT b)
# File lib/sequel/extensions/core_refinements.rb 112 def |(ce) 113 ::Sequel::SQL::BooleanExpression.new(:OR, self, ce) 114 end
Return a Sequel::SQL::BooleanExpression
created from this array, not matching all of the conditions.
~[[:a, true]] # SQL: (a IS NOT TRUE) ~[[:a, 1], [:b, [2, 3]]] # SQL: ((a != 1) OR (b NOT IN (2, 3)))
# File lib/sequel/extensions/core_refinements.rb 24 def ~ 25 Sequel.~(self) 26 end