class Sequel::Postgres::PGArray

Represents a PostgreSQL array column value.

Attributes

array_type[RW]

The type of this array. May be nil if no type was given. If a type is provided, the array is automatically casted to this type when literalizing. This type is the underlying type, not the array type itself, so for an int4[] database type, it should be :int4 or 'int4'

Public Class Methods

new(array, type=nil) click to toggle source

Set the array to delegate to, and a database type.

Calls superclass method
    # File lib/sequel/extensions/pg_array.rb
430 def initialize(array, type=nil)
431   super(array)
432   @array_type = type
433 end

Public Instance Methods

op() click to toggle source

Wrap the PGArray instance in an ArrayOp, allowing you to easily use the PostgreSQL array functions and operators with literal arrays.

    # File lib/sequel/extensions/pg_array_ops.rb
286 def op
287   ArrayOp.new(self)
288 end
sql_literal_append(ds, sql) click to toggle source

Append the array SQL to the given sql string. If the receiver has a type, add a cast to the database array type.

    # File lib/sequel/extensions/pg_array.rb
438 def sql_literal_append(ds, sql)
439   at = array_type
440   if empty? && at
441     sql << "'{}'"
442   else
443     sql << "ARRAY"
444     _literal_append(sql, ds, to_a)
445   end
446   if at
447     sql << '::' << at.to_s << '[]'
448   end
449 end

Private Instance Methods

_literal_append(sql, ds, array) click to toggle source

Recursive method that handles multi-dimensional arrays, surrounding each with [] and interspersing entries with ,.

    # File lib/sequel/extensions/pg_array.rb
456 def _literal_append(sql, ds, array)
457   sql << '['
458   comma = false
459   commas = ','
460   array.each do |i|
461     sql << commas if comma
462     if i.is_a?(Array)
463       _literal_append(sql, ds, i)
464     else
465       ds.literal_append(sql, i)
466     end
467     comma = true
468   end
469   sql << ']'
470 end