Class: Sequel::Postgres::ArrayOp

Inherits:
SQL::Wrapper show all
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

#value

Instance Method Summary collapse

Methods inherited from SQL::Wrapper

#initialize

Methods included from RangeOpMethods

#pg_range

Methods included from JSONOpMethods

#pg_json, #pg_jsonb

Methods included from InetOpMethods

#pg_inet

Methods included from PGRowOp::ExpressionMethods

#pg_row

Methods included from SQL::SubscriptMethods

#sql_subscript

Methods included from SQL::StringMethods

#ilike, #like

Methods included from SQL::PatternMatchMethods

#!~, #=~

Methods included from SQL::OrderMethods

#asc, #desc

Methods included from SQL::NumericMethods

#+, #coerce

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

#as

Methods inherited from SQL::Expression

#==, attr_reader, #clone, #eql?, #hash, inherited, #inspect

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]

91
92
93
94
95
# File 'lib/sequel/extensions/pg_array_ops.rb', line 91

def [](key)
  s = Sequel::SQL::Subscript.new(self, [key])
  s = ArrayOp.new(s) if key.is_a?(Range)
  s
end

#allObject

Call the ALL function:

array_op.all # ALL(array)

Usually used like:

dataset.where(1=>array_op.all)
# WHERE (1 = ALL(array))

105
106
107
# File 'lib/sequel/extensions/pg_array_ops.rb', line 105

def all
  function(:ALL)
end

#anyObject

Call the ANY function:

array_op.all # ANY(array)

Usually used like:

dataset.where(1=>array_op.any)
# WHERE (1 = ANY(array))

117
118
119
# File 'lib/sequel/extensions/pg_array_ops.rb', line 117

def any
  function(:ANY)
end

#cardinalityObject

Call the cardinality method:

array_op.cardinality # cardinality(array)

124
125
126
# File 'lib/sequel/extensions/pg_array_ops.rb', line 124

def cardinality
  function(:cardinality)
end

#contained_by(other) ⇒ Object

Use the contained by (<@) operator:

array_op.contained_by(:a) # (array <@ a)

138
139
140
# File 'lib/sequel/extensions/pg_array_ops.rb', line 138

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)

131
132
133
# File 'lib/sequel/extensions/pg_array_ops.rb', line 131

def contains(other)
  bool_op(CONTAINS, wrap_array(other))
end

#dimsObject

Call the array_dims method:

array_op.dims # array_dims(array)

145
146
147
# File 'lib/sequel/extensions/pg_array_ops.rb', line 145

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)

154
155
156
157
158
159
160
161
162
163
164
# File 'lib/sequel/extensions/pg_array_ops.rb', line 154

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)

170
171
172
# File 'lib/sequel/extensions/pg_array_ops.rb', line 170

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)

178
179
180
# File 'lib/sequel/extensions/pg_array_ops.rb', line 178

def lower(dimension = 1)
  function(:array_lower, dimension)
end

#overlaps(other) ⇒ Object

Use the overlaps (&&) operator:

array_op.overlaps(:a) # (array && a)

185
186
187
# File 'lib/sequel/extensions/pg_array_ops.rb', line 185

def overlaps(other)
  bool_op(OVERLAPS, wrap_array(other))
end

#pg_arrayObject

Return the receiver.


199
200
201
# File 'lib/sequel/extensions/pg_array_ops.rb', line 199

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)

193
194
195
# File 'lib/sequel/extensions/pg_array_ops.rb', line 193

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)

206
207
208
# File 'lib/sequel/extensions/pg_array_ops.rb', line 206

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)

214
215
216
# File 'lib/sequel/extensions/pg_array_ops.rb', line 214

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, ':', '*')

224
225
226
# File 'lib/sequel/extensions/pg_array_ops.rb', line 224

def to_string(joiner="", null=nil)
  function(:array_to_string, joiner, null)
end

#unnest(*args) ⇒ Object

Call the unnest method:

array_op.unnest # unnest(array)

232
233
234
# File 'lib/sequel/extensions/pg_array_ops.rb', line 232

def unnest(*args)
  function(:unnest, *args.map{|a| wrap_array(a)})
end

#unshift(other) ⇒ Object

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

array_op.unshift(:a) # (a || array)

239
240
241
# File 'lib/sequel/extensions/pg_array_ops.rb', line 239

def unshift(other)
  array_op(CONCAT, [wrap_array(other), self])
end