class Sequel::Postgres::PGArray

Represents a PostgreSQL array column value.

:nocov:

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
460 def initialize(array, type=nil)
461   super(array)
462   @array_type = type
463 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
294 def op
295   ArrayOp.new(self)
296 end
sequel_auto_param_type(ds) click to toggle source

Allow automatic parameterization of the receiver if all elements can be can be automatically parameterized.

    # File lib/sequel/extensions/pg_array.rb
483 def sequel_auto_param_type(ds)
484   if array_type && all?{|x| nil == x || ds.send(:auto_param_type, x)}
485     "::#{array_type}[]"
486   end
487 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
468 def sql_literal_append(ds, sql)
469   at = array_type
470   if empty? && at
471     sql << "'{}'"
472   else
473     sql << "ARRAY"
474     _literal_append(sql, ds, to_a)
475   end
476   if at
477     sql << '::' << at.to_s << '[]'
478   end
479 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
494 def _literal_append(sql, ds, array)
495   sql << '['
496   comma = false
497   commas = ','
498   array.each do |i|
499     sql << commas if comma
500     if i.is_a?(Array)
501       _literal_append(sql, ds, i)
502     else
503       ds.literal_append(sql, i)
504     end
505     comma = true
506   end
507   sql << ']'
508 end