class Sequel::Postgres::ArrayOp
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
Constants
- CONCAT
- CONTAINED_BY
- CONTAINS
- OVERLAPS
Public Instance Methods
Access a member of the array, returns an SQL::Subscript instance:
array_op[1] # array[1]
# File lib/sequel/extensions/pg_array_ops.rb, line 87 def [](key) s = Sequel::SQL::Subscript.new(self, [key]) s = ArrayOp.new(s) if key.is_a?(Range) s end
Call the ALL function:
array_op.all # ALL(array)
Usually used like:
dataset.where(1=>array_op.all) # WHERE (1 = ALL(array))
# File lib/sequel/extensions/pg_array_ops.rb, line 101 def all function(:ALL) end
Call the ANY function:
array_op.all # ANY(array)
Usually used like:
dataset.where(1=>array_op.any) # WHERE (1 = ANY(array))
# File lib/sequel/extensions/pg_array_ops.rb, line 113 def any function(:ANY) end
Call the cardinality method:
array_op.cardinality # cardinality(array)
# File lib/sequel/extensions/pg_array_ops.rb, line 120 def cardinality function(:cardinality) end
Use the contained by (<@) operator:
array_op.contained_by(:a) # (array <@ a)
# File lib/sequel/extensions/pg_array_ops.rb, line 134 def contained_by(other) bool_op(CONTAINED_BY, wrap_array(other)) end
Use the contains (@>) operator:
array_op.contains(:a) # (array @> a)
# File lib/sequel/extensions/pg_array_ops.rb, line 127 def contains(other) bool_op(CONTAINS, wrap_array(other)) end
Call the array_dims method:
array_op.dims # array_dims(array)
# File lib/sequel/extensions/pg_array_ops.rb, line 141 def dims function(:array_dims) end
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)
# File lib/sequel/extensions/pg_array_ops.rb, line 150 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
Call the array_length method:
array_op.length # array_length(array, 1) array_op.length(2) # array_length(array, 2)
# File lib/sequel/extensions/pg_array_ops.rb, line 166 def length(dimension = 1) function(:array_length, dimension) end
Call the array_lower method:
array_op.lower # array_lower(array, 1) array_op.lower(2) # array_lower(array, 2)
# File lib/sequel/extensions/pg_array_ops.rb, line 174 def lower(dimension = 1) function(:array_lower, dimension) end
Use the overlaps (&&) operator:
array_op.overlaps(:a) # (array && a)
# File lib/sequel/extensions/pg_array_ops.rb, line 181 def overlaps(other) bool_op(OVERLAPS, wrap_array(other)) end
Return the receiver.
# File lib/sequel/extensions/pg_array_ops.rb, line 195 def pg_array self end
Use the concatentation (||) operator:
array_op.push(:a) # (array || a) array_op.concat(:a) # (array || a)
# File lib/sequel/extensions/pg_array_ops.rb, line 189 def push(other) array_op(CONCAT, [self, wrap_array(other)]) end
Remove the given element from the array:
array_op.remove(1) # array_remove(array, 1)
# File lib/sequel/extensions/pg_array_ops.rb, line 202 def remove(element) ArrayOp.new(function(:array_remove, element)) end
Replace the given element in the array with another element:
array_op.replace(1, 2) # array_replace(array, 1, 2)
# File lib/sequel/extensions/pg_array_ops.rb, line 210 def replace(element, replacement) ArrayOp.new(function(:array_replace, element, replacement)) end
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, ':', '*')
# File lib/sequel/extensions/pg_array_ops.rb, line 220 def to_string(joiner="", null=nil) function(:array_to_string, joiner, null) end
Call the unnest method:
array_op.unnest # unnest(array)
# File lib/sequel/extensions/pg_array_ops.rb, line 228 def unnest(*args) function(:unnest, *args.map{|a| wrap_array(a)}) end
Use the concatentation (||) operator, reversing the order:
array_op.unshift(:a) # (a || array)
# File lib/sequel/extensions/pg_array_ops.rb, line 235 def unshift(other) array_op(CONCAT, [wrap_array(other), self]) end
Private Instance Methods
Return a placeholder literal with the given str and args, wrapped in an ArrayOp, used by operators that return arrays.
# File lib/sequel/extensions/pg_array_ops.rb, line 243 def array_op(str, args) ArrayOp.new(Sequel::SQL::PlaceholderLiteralString.new(str, args)) end
Return a placeholder literal with the given str and args, wrapped in a boolean expression, used by operators that return booleans.
# File lib/sequel/extensions/pg_array_ops.rb, line 249 def bool_op(str, other) Sequel::SQL::BooleanExpression.new(:NOOP, Sequel::SQL::PlaceholderLiteralString.new(str, [value, other])) end
Return a function with the given name, and the receiver as the first argument, with any additional arguments given.
# File lib/sequel/extensions/pg_array_ops.rb, line 255 def function(name, *args) SQL::Function.new(name, self, *args) end