class Sequel::Postgres::ArrayOp

  1. lib/sequel/extensions/pg_array_ops.rb
Parent: Postgres

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 = ["(".freeze, " || ".freeze, ")".freeze].freeze  
CONTAINED_BY = ["(".freeze, " <@ ".freeze, ")".freeze].freeze  
CONTAINS = ["(".freeze, " @> ".freeze, ")".freeze].freeze  
OVERLAPS = ["(".freeze, " && ".freeze, ")".freeze].freeze  

Public Instance Aliases

concat -> push
join -> to_string

Public Instance methods

[] (key)

Access a member of the array, returns an SQL::Subscript instance:

array_op[1] # array[1]
[show source] 
# 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 ()

Call the ALL function:

array_op.all # ALL(array)

Usually used like:

dataset.where(1=>array_op.all)
# WHERE (1 = ALL(array))
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 92
def all
  function(:ALL)
end
any ()

Call the ANY function:

array_op.all # ANY(array)

Usually used like:

dataset.where(1=>array_op.any)
# WHERE (1 = ANY(array))
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 104
def any
  function(:ANY)
end
contained_by (other)

Use the contained by (<@) operator:

array_op.contained_by(:a) # (array <@ a)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 118
def contained_by(other)
  bool_op(CONTAINED_BY, wrap_array(other))
end
contains (other)

Use the contains (@>) operator:

array_op.contains(:a) # (array @> a)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 111
def contains(other)
  bool_op(CONTAINS, wrap_array(other))
end
dims ()

Call the array_dims method:

array_op.dims # array_dims(array)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 125
def dims
  function(:array_dims)
end
hstore (arg=(no_arg_given=true; nil))

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)
[show source] 
# 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)

Call the array_length method:

array_op.length    # array_length(array, 1)
array_op.length(2) # array_length(array, 2)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 150
def length(dimension = 1)
  function(:array_length, dimension)
end
lower (dimension = 1)

Call the array_lower method:

array_op.lower    # array_lower(array, 1)
array_op.lower(2) # array_lower(array, 2)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 158
def lower(dimension = 1)
  function(:array_lower, dimension)
end
overlaps (other)

Use the overlaps (&&) operator:

array_op.overlaps(:a) # (array && a)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 165
def overlaps(other)
  bool_op(OVERLAPS, wrap_array(other))
end
pg_array ()

Return the receiver.

[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 179
def pg_array
  self
end
push (other)

Use the concatentation (||) operator:

array_op.push(:a) # (array || a)
array_op.concat(:a) # (array || a)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 173
def push(other)
  array_op(CONCAT, [self, wrap_array(other)])
end
remove (element)

Remove the given element from the array:

array_op.remove(1) # array_remove(array, 1)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 186
def remove(element)
  ArrayOp.new(function(:array_remove, element))
end
replace (element, replacement)

Replace the given element in the array with another element:

array_op.replace(1, 2) # array_replace(array, 1, 2)
[show source] 
# 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)

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, ':', '*')
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 204
def to_string(joiner="", null=nil)
  function(:array_to_string, joiner, null)
end
unnest ()

Call the unnest method:

array_op.unnest # unnest(array)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 212
def unnest
  function(:unnest)
end
unshift (other)

Use the concatentation (||) operator, reversing the order:

array_op.unshift(:a) # (a || array)
[show source] 
# File lib/sequel/extensions/pg_array_ops.rb, line 219
def unshift(other)
  array_op(CONCAT, [wrap_array(other), self])
end