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
438 def initialize(array, type=nil)
439   super(array)
440   @array_type = type
441 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
446 def sql_literal_append(ds, sql)
447   at = array_type
448   if empty? && at
449     sql << "'{}'"
450   else
451     sql << "ARRAY"
452     _literal_append(sql, ds, to_a)
453   end
454   if at
455     sql << '::' << at.to_s << '[]'
456   end
457 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
464 def _literal_append(sql, ds, array)
465   sql << '['
466   comma = false
467   commas = ','
468   array.each do |i|
469     sql << commas if comma
470     if i.is_a?(Array)
471       _literal_append(sql, ds, i)
472     else
473       ds.literal_append(sql, i)
474     end
475     comma = true
476   end
477   sql << ']'
478 end