Module Sequel::CoreRefinements
In: lib/sequel/extensions/pg_array.rb
lib/sequel/extensions/pg_row.rb
lib/sequel/extensions/pg_array_ops.rb
lib/sequel/extensions/pg_json_ops.rb
lib/sequel/extensions/pg_inet_ops.rb
lib/sequel/extensions/core_refinements.rb
lib/sequel/extensions/pg_range_ops.rb
lib/sequel/extensions/pg_json.rb
lib/sequel/extensions/pg_hstore_ops.rb
lib/sequel/extensions/pg_range.rb
lib/sequel/extensions/pg_row_ops.rb
lib/sequel/extensions/pg_hstore.rb

Methods

&   case   case   hstore   identifier   lit   pg_array   pg_json   pg_json   pg_jsonb   pg_jsonb   pg_range   pg_row   sql_expr   sql_expr   sql_function   sql_negate   sql_negate   sql_or   sql_or   sql_string_join   sql_value_list   to_sequel_blob   |   ~   ~  

Included Modules

Sequel::Postgres::ArrayOpMethods Sequel::Postgres::JSONOpMethods Sequel::Postgres::InetOpMethods Sequel::SQL::AliasMethods Sequel::SQL::CastMethods Sequel::SQL::AliasMethods Sequel::SQL::CastMethods Sequel::SQL::OrderMethods Sequel::SQL::BooleanMethods Sequel::SQL::NumericMethods Sequel::SQL::QualifyingMethods Sequel::SQL::StringMethods Sequel::SQL::SubscriptMethods Sequel::SQL::ComplexExpressionMethods Sequel::Postgres::RangeOpMethods Sequel::Postgres::HStoreOpMethods Sequel::Postgres::PGRowOp::ExpressionMethods

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)

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 100
100:     def &(ce)
101:       ::Sequel::SQL::BooleanExpression.new(:AND, self, ce)
102:     end

Return a Sequel::SQL::CaseExpression with this hash as the conditions and the given default value.

  {{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

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 128
128:     def case(*args)
129:       ::Sequel::SQL::CaseExpression.new(to_a, *args)
130:     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

[Source]

    # File lib/sequel/extensions/core_refinements.rb, line 31
31:     def case(*args)
32:       ::Sequel::SQL::CaseExpression.new(self, *args)
33:     end

[Source]

     # File lib/sequel/extensions/pg_hstore.rb, line 336
336:       def hstore
337:         Sequel::Postgres::HStore.new(self)
338:       end

Returns receiver wrapped in an Sequel::SQL::Identifier.

  :ab.identifier # SQL: "a"

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 203
203:     def identifier
204:       Sequel::SQL::Identifier.new(self)
205:     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"

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 178
178:     def lit(*args)
179:       args.empty? ? Sequel::LiteralString.new(self) : Sequel::SQL::PlaceholderLiteralString.new(self, args)
180:     end

[Source]

     # File lib/sequel/extensions/pg_array.rb, line 512
512:       def pg_array(type=nil)
513:         Sequel::Postgres::PGArray.new(self, type)
514:       end

[Source]

     # File lib/sequel/extensions/pg_json.rb, line 372
372:       def pg_json
373:         Sequel::Postgres::JSONHash.new(self)
374:       end

[Source]

     # File lib/sequel/extensions/pg_json.rb, line 362
362:       def pg_json
363:         Sequel::Postgres::JSONArray.new(self)
364:       end

[Source]

     # File lib/sequel/extensions/pg_json.rb, line 366
366:       def pg_jsonb
367:         Sequel::Postgres::JSONBArray.new(self)
368:       end

[Source]

     # File lib/sequel/extensions/pg_json.rb, line 376
376:       def pg_jsonb
377:         Sequel::Postgres::JSONBHash.new(self)
378:       end

[Source]

     # File lib/sequel/extensions/pg_range.rb, line 557
557:       def pg_range(db_type=nil)
558:         Sequel::Postgres::PGRange.from_range(self, db_type)
559:       end

[Source]

     # File lib/sequel/extensions/pg_row.rb, line 574
574:       def pg_row
575:         Sequel::Postgres::PGRow::ArrayRow.new(self)
576:       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)))

[Source]

    # File lib/sequel/extensions/core_refinements.rb, line 57
57:     def sql_expr
58:       Sequel[self]
59:     end

Return a Sequel::SQL::BooleanExpression created from this hash, matching all of the conditions. Rarely do you need to call this explicitly, as Sequel generally assumes that hashes specify this type of condition.

  {a: true}.sql_expr # SQL: (a IS TRUE)
  {a: 1, b: [2, 3]}.sql_expr # SQL: ((a = 1) AND (b IN (2, 3)))

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 138
138:     def sql_expr
139:       ::Sequel::SQL::BooleanExpression.from_value_pairs(self)
140:     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)

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 213
213:     def sql_function(*args)
214:       Sequel::SQL::Function.new(self, *args)
215:     end

Return a Sequel::SQL::BooleanExpression created from this hash, 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)))

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 147
147:     def sql_negate
148:       ::Sequel::SQL::BooleanExpression.from_value_pairs(self, :AND, true)
149:     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)))

[Source]

    # File lib/sequel/extensions/core_refinements.rb, line 66
66:     def sql_negate
67:       Sequel.negate(self)
68:     end

Return a Sequel::SQL::BooleanExpression created from this hash, 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)))

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 156
156:     def sql_or
157:       ::Sequel::SQL::BooleanExpression.from_value_pairs(self, :OR)
158:     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)))

[Source]

    # File lib/sequel/extensions/core_refinements.rb, line 75
75:     def sql_or
76:       Sequel.or(self)
77:     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)

[Source]

    # File lib/sequel/extensions/core_refinements.rb, line 88
88:     def sql_string_join(joiner=nil)
89:       Sequel.join(self, joiner)
90:     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)))

[Source]

    # File lib/sequel/extensions/core_refinements.rb, line 44
44:     def sql_value_list
45:       ::Sequel::SQL::ValueList.new(self)
46:     end

Returns a Sequel::SQL::Blob that holds the same data as this string. Blobs provide proper escaping of binary data.

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 184
184:     def to_sequel_blob
185:       ::Sequel::SQL::Blob.new(self)
186:     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)

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 110
110:     def |(ce)
111:       ::Sequel::SQL::BooleanExpression.new(:OR, self, ce)
112:     end

Return a Sequel::SQL::BooleanExpression created from this hash, 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)))

[Source]

     # File lib/sequel/extensions/core_refinements.rb, line 119
119:     def ~
120:       ::Sequel::SQL::BooleanExpression.from_value_pairs(self, :OR, true)
121:     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)))

[Source]

    # File lib/sequel/extensions/core_refinements.rb, line 22
22:     def ~
23:       Sequel.~(self)
24:     end

[Validate]