Class Sequel::Postgres::ArrayOp
In: lib/sequel/extensions/pg_array_ops.rb
Parent: Sequel::SQL::Wrapper

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

Methods

[]   all   any   concat   contained_by   contains   dims   join   length   lower   overlaps   pg_array   push   to_string   unnest   unshift  

Constants

CONCAT = ["(".freeze, " || ".freeze, ")".freeze].freeze
CONTAINS = ["(".freeze, " @> ".freeze, ")".freeze].freeze
CONTAINED_BY = ["(".freeze, " <@ ".freeze, ")".freeze].freeze
OVERLAPS = ["(".freeze, " && ".freeze, ")".freeze].freeze

Public Instance methods

[](key)

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

  array_op[1] # array[1]

[Source]

    # File lib/sequel/extensions/pg_array_ops.rb, line 78
78:       def [](key)
79:         Sequel::SQL::Subscript.new(self, [key])
80:       end
all()

Call the ALL function: 

  array_op.all # ALL(array)

Usually used like: 

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

[Source]

    # File lib/sequel/extensions/pg_array_ops.rb, line 90
90:       def all
91:         function(:ALL)
92:       end
any()

Call the ANY function: 

  array_op.all # ANY(array)

Usually used like: 

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

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 102
102:       def any
103:         function(:ANY)
104:       end
concat(other)

Alias for push

contained_by(other)

Use the contained by (<@) operator: 

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

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 116
116:       def contained_by(other)
117:         bool_op(CONTAINED_BY, wrap_array(other))
118:       end
contains(other)

Use the contains (@>) operator: 

  array_op.contains(:a) # (array @> a)

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 109
109:       def contains(other)
110:         bool_op(CONTAINS, wrap_array(other))
111:       end
dims()

Call the array_dims method: 

  array_op.dims # array_dims(array)

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 123
123:       def dims
124:         function(:array_dims)
125:       end
join(joiner="", null=nil)

Alias for to_string

length(dimension = 1)

Call the array_length method: 

  array_op.length    # array_length(array, 1)
  array_op.length(2) # array_length(array, 2)

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 131
131:       def length(dimension = 1)
132:         function(:array_length, dimension)
133:       end
lower(dimension = 1)

Call the array_lower method: 

  array_op.lower    # array_lower(array, 1)
  array_op.lower(2) # array_lower(array, 2)

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 139
139:       def lower(dimension = 1)
140:         function(:array_lower, dimension)
141:       end
overlaps(other)

Use the overlaps (&&) operator: 

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

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 146
146:       def overlaps(other)
147:         bool_op(OVERLAPS, wrap_array(other))
148:       end
pg_array()

Return the receiver.

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 160
160:       def pg_array
161:         self
162:       end
push(other)

Use the concatentation (||) operator: 

  array_op.push(:a) # (array || a)
  array_op.concat(:a) # (array || a)

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 154
154:       def push(other)
155:         array_op(CONCAT, [self, wrap_array(other)])
156:       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, ':', '*')

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 170
170:       def to_string(joiner="", null=nil)
171:         function(:array_to_string, joiner, null)
172:       end
unnest()

Call the unnest method: 

  array_op.unnest # unnest(array)

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 178
178:       def unnest
179:         function(:unnest)
180:       end
unshift(other)

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

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

[Source]

     # File lib/sequel/extensions/pg_array_ops.rb, line 185
185:       def unshift(other)
186:         array_op(CONCAT, [wrap_array(other), self])
187:       end

[Validate]