Class: Sequel::Postgres::ArrayOp
- Inherits:
-
SQL::Wrapper
- Object
- SQL::Expression
- SQL::GenericExpression
- SQL::Wrapper
- Sequel::Postgres::ArrayOp
- Defined in:
- lib/sequel/extensions/pg_array_ops.rb
Overview
The ArrayOp class is a simple container for a single object that defines methods that yield Sequel expression objects representing PostgreSQL array operators and functions.
In the method documentation examples, assume that:
array_op = :array.pg_array
Constant Summary collapse
- CONCAT =
["(".freeze, " || ".freeze, ")".freeze].freeze
- CONTAINS =
["(".freeze, " @> ".freeze, ")".freeze].freeze
- CONTAINED_BY =
["(".freeze, " <@ ".freeze, ")".freeze].freeze
- OVERLAPS =
["(".freeze, " && ".freeze, ")".freeze].freeze
Instance Attribute Summary
Attributes inherited from SQL::Wrapper
Instance Method Summary collapse
-
#[](key) ⇒ Object
Access a member of the array, returns an SQL::Subscript instance:.
-
#all ⇒ Object
Call the ALL function:.
-
#any ⇒ Object
Call the ANY function:.
-
#contained_by(other) ⇒ Object
Use the contained by (<@) operator:.
-
#contains(other) ⇒ Object
Use the contains (@>) operator:.
-
#dims ⇒ Object
Call the array_dims method:.
-
#hstore(arg = (no_arg_given=true; nil)) ⇒ Object
Convert the array into an hstore using the hstore function.
-
#length(dimension = 1) ⇒ Object
Call the array_length method:.
-
#lower(dimension = 1) ⇒ Object
Call the array_lower method:.
-
#overlaps(other) ⇒ Object
Use the overlaps (&&) operator:.
-
#pg_array ⇒ Object
Return the receiver.
-
#push(other) ⇒ Object
(also: #concat)
Use the concatentation (||) operator:.
-
#remove(element) ⇒ Object
Remove the given element from the array:.
-
#replace(element, replacement) ⇒ Object
Replace the given element in the array with another element:.
-
#to_string(joiner = "", null = nil) ⇒ Object
(also: #join)
Call the array_to_string method:.
-
#unnest ⇒ Object
Call the unnest method:.
-
#unshift(other) ⇒ Object
Use the concatentation (||) operator, reversing the order:.
Methods inherited from SQL::Wrapper
Methods included from RangeOpMethods
Methods included from JSONOpMethods
Methods included from PGRowOp::ExpressionMethods
Methods included from SQL::SubscriptMethods
Methods included from SQL::StringMethods
Methods included from SQL::OrderMethods
Methods included from SQL::NumericMethods
Methods included from SQL::ComplexExpressionMethods
#extract, #sql_boolean, #sql_number, #sql_string
Methods included from SQL::CastMethods
#cast, #cast_numeric, #cast_string
Methods included from SQL::BooleanMethods
Methods included from SQL::AliasMethods
Methods inherited from SQL::Expression
#==, attr_reader, #eql?, #hash, inherited, #inspect, #lit, #sql_literal
Constructor Details
This class inherits a constructor from Sequel::SQL::Wrapper
Instance Method Details
#[](key) ⇒ Object
Access a member of the array, returns an SQL::Subscript instance:
array_op[1] # array[1]
78 79 80 81 82 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 78 def [](key) s = Sequel::SQL::Subscript.new(self, [key]) s = ArrayOp.new(s) if key.is_a?(Range) s end |
#all ⇒ Object
Call the ALL function:
array_op.all # ALL(array)
Usually used like:
dataset.where(1=>array_op.all)
# WHERE (1 = ALL(array))
92 93 94 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 92 def all function(:ALL) end |
#any ⇒ Object
Call the ANY function:
array_op.all # ANY(array)
Usually used like:
dataset.where(1=>array_op.any)
# WHERE (1 = ANY(array))
104 105 106 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 104 def any function(:ANY) end |
#contained_by(other) ⇒ Object
Use the contained by (<@) operator:
array_op.contained_by(:a) # (array <@ a)
118 119 120 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 118 def contained_by(other) bool_op(CONTAINED_BY, wrap_array(other)) end |
#contains(other) ⇒ Object
Use the contains (@>) operator:
array_op.contains(:a) # (array @> a)
111 112 113 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 111 def contains(other) bool_op(CONTAINS, wrap_array(other)) end |
#dims ⇒ Object
Call the array_dims method:
array_op.dims # array_dims(array)
125 126 127 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 125 def dims function(:array_dims) end |
#hstore(arg = (no_arg_given=true; nil)) ⇒ Object
Convert the array into an hstore using the hstore function. If given an argument, use the two array form:
array_op.hstore # hstore(array)
array_op.hstore(:array2) # hstore(array, array2)
134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 134 def hstore(arg=(no_arg_given=true; nil)) v = if no_arg_given Sequel.function(:hstore, self) else Sequel.function(:hstore, self, wrap_array(arg)) end if Sequel.respond_to?(:hstore_op) v = Sequel.hstore_op(v) end v end |
#length(dimension = 1) ⇒ Object
Call the array_length method:
array_op.length # array_length(array, 1)
array_op.length(2) # array_length(array, 2)
150 151 152 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 150 def length(dimension = 1) function(:array_length, dimension) end |
#lower(dimension = 1) ⇒ Object
Call the array_lower method:
array_op.lower # array_lower(array, 1)
array_op.lower(2) # array_lower(array, 2)
158 159 160 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 158 def lower(dimension = 1) function(:array_lower, dimension) end |
#overlaps(other) ⇒ Object
Use the overlaps (&&) operator:
array_op.overlaps(:a) # (array && a)
165 166 167 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 165 def overlaps(other) bool_op(OVERLAPS, wrap_array(other)) end |
#pg_array ⇒ Object
Return the receiver.
179 180 181 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 179 def pg_array self end |
#push(other) ⇒ Object Also known as: concat
Use the concatentation (||) operator:
array_op.push(:a) # (array || a)
array_op.concat(:a) # (array || a)
173 174 175 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 173 def push(other) array_op(CONCAT, [self, wrap_array(other)]) end |
#remove(element) ⇒ Object
Remove the given element from the array:
array_op.remove(1) # array_remove(array, 1)
186 187 188 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 186 def remove(element) ArrayOp.new(function(:array_remove, element)) end |
#replace(element, replacement) ⇒ Object
Replace the given element in the array with another element:
array_op.replace(1, 2) # array_replace(array, 1, 2)
194 195 196 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 194 def replace(element, replacement) ArrayOp.new(function(:array_replace, element, replacement)) end |
#to_string(joiner = "", null = nil) ⇒ Object Also known as: join
Call the array_to_string method:
array_op.join # array_to_string(array, '', NULL)
array_op.to_string # array_to_string(array, '', NULL)
array_op.join(":") # array_to_string(array, ':', NULL)
array_op.join(":", "*") # array_to_string(array, ':', '*')
204 205 206 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 204 def to_string(joiner="", null=nil) function(:array_to_string, joiner, null) end |
#unnest ⇒ Object
Call the unnest method:
array_op.unnest # unnest(array)
212 213 214 |
# File 'lib/sequel/extensions/pg_array_ops.rb', line 212 def unnest function(:unnest) end |