Class | Sequel::Postgres::PGArray |
In: |
lib/sequel/extensions/pg_array_ops.rb
lib/sequel/extensions/pg_array.rb |
Parent: | Object |
Represents a PostgreSQL array column value.
ARRAY | = | "ARRAY".freeze | ||
DOUBLE_COLON | = | '::'.freeze | ||
EMPTY_ARRAY | = | "'{}'".freeze | ||
EMPTY_BRACKET | = | '[]'.freeze | ||
OPEN_BRACKET | = | '['.freeze | ||
CLOSE_BRACKET | = | ']'.freeze | ||
COMMA | = | ','.freeze | ||
BACKSLASH | = | '\\'.freeze | ||
EMPTY_STRING | = | ''.freeze | ||
OPEN_BRACE | = | '{'.freeze | ||
CLOSE_BRACE | = | '}'.freeze | ||
NULL | = | 'NULL'.freeze | ||
QUOTE | = | '"'.freeze | ||
ARRAY_TYPES | = | {} | Global hash of database array type name strings to symbols (e.g. ‘double precision’ => :float), used by the schema parsing for array types registered globally. |
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‘ |
Set the array to delegate to, and a database type.
# File lib/sequel/extensions/pg_array.rb, line 469 469: def initialize(array, type=nil) 470: super(array) 471: @array_type = type 472: end
Registers an array type that the extension should handle. Makes a Database instance that has been extended with DatabaseMethods recognize the array type given and set up the appropriate typecasting. Also sets up automatic typecasting for the native postgres adapter, so that on retrieval, the values are automatically converted to PGArray instances. The db_type argument should be the exact database type used (as returned by the PostgreSQL format_type database function). Accepts the following options:
:array_type : | The type to automatically cast the array to when literalizing the array. Usually the same as db_type. |
:converter : | A callable object (e.g. Proc), that is called with each element of the array (usually a string), and should return the appropriate typecasted object. |
:oid : | The PostgreSQL OID for the array type. This is used by the Sequel postgres adapter to set up automatic type conversion on retrieval from the database. |
:scalar_oid : | Should be the PostgreSQL OID for the scalar version of this array type. If given, automatically sets the :converter option by looking for scalar conversion proc. |
:scalar_typecast : | Should be a symbol indicating the typecast method that should be called on each element of the array, when a plain array is passed into a database typecast method. For example, for an array of integers, this could be set to :integer, so that the typecast_value_integer method is called on all of the array elements. Defaults to :type_symbol option. |
:type_procs : | A hash mapping oids to conversion procs, used for looking up the :scalar_oid and value and setting the :oid value. Defaults to the global Sequel::Postgres::PG_TYPES. |
:type_symbol : | The base of the schema type symbol for this type. For example, if you provide :integer, Sequel will recognize this type as :integer_array during schema parsing. Defaults to the db_type argument. |
:typecast_method_map : | The map in which to place the database type string to type symbol mapping. Defaults to ARRAY_TYPES. |
:typecast_methods_module : | If given, a module object to add the typecasting method to. Defaults to DatabaseMethods. |
If a block is given, it is treated as the :converter option.
# File lib/sequel/extensions/pg_array.rb, line 146 146: def self.register(db_type, opts=OPTS, &block) 147: db_type = db_type.to_s 148: type = (opts[:type_symbol] || db_type).to_sym 149: type_procs = opts[:type_procs] || PG_TYPES 150: mod = opts[:typecast_methods_module] || DatabaseMethods 151: typecast_method_map = opts[:typecast_method_map] || ARRAY_TYPES 152: 153: if converter = opts[:converter] 154: raise Error, "can't provide both a block and :converter option to register" if block 155: else 156: converter = block 157: end 158: 159: if soid = opts[:scalar_oid] 160: raise Error, "can't provide both a converter and :scalar_oid option to register" if converter 161: converter = type_procs[soid] 162: end 163: 164: array_type = (opts[:array_type] || db_type).to_s.dup.freeze 165: creator = Creator.new(array_type, converter) 166: 167: typecast_method_map[db_type] = "#{type}_array""#{type}_array" 168: 169: define_array_typecast_method(mod, type, creator, opts.fetch(:scalar_typecast, type)) 170: 171: if oid = opts[:oid] 172: type_procs[oid] = creator 173: end 174: 175: nil 176: end
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, line 477 477: def sql_literal_append(ds, sql) 478: at = array_type 479: if empty? && at 480: sql << EMPTY_ARRAY 481: else 482: sql << ARRAY 483: _literal_append(sql, ds, to_a) 484: end 485: if at 486: sql << DOUBLE_COLON << at.to_s << EMPTY_BRACKET 487: end 488: end