BasicTypeMapForQueries

class
Superclass
PG::TypeMapByClass
Included Modules
PG::BasicTypeRegistry::Checker

Simple set of rules for type casting common Ruby types to PostgreSQL.

OIDs of supported type casts are not hard-coded in the sources, but are retrieved from the PostgreSQL’s pg_type table in PG::BasicTypeMapForQueries.new .

Query params are type casted based on the class of the given value.

Higher level libraries will most likely not make use of this class, but use their own derivation of PG::TypeMapByClass or another set of rules to choose suitable encoders and decoders for the values to be sent.

Example:

conn = PG::Connection.new
# Assign a default ruleset for type casts of input and output values.
conn.type_map_for_queries = PG::BasicTypeMapForQueries.new(conn)
# Execute a query. The Integer param value is typecasted internally by PG::BinaryEncoder::Int8.
# The format of the parameter is set to 0 (text) and the OID of this parameter is set to 20 (int8).
res = conn.exec_params( "SELECT $1", [5] )

Constants

DEFAULT_ARRAY_TYPE_MAP
DEFAULT_TYPE_MAP

Attributes

encode_array_as[R]

Public Class Methods

anchor
new(connection_or_coder_maps, registry: nil, if_undefined: nil)

Create a new type map for query submission

Options:

  • registry: Custom type registry, nil for default global registry

  • if_undefined: Optional Proc object which is called, if no type for an parameter class is not defined in the registry.

# File lib/pg/basic_type_map_for_queries.rb, line 49
def initialize(connection_or_coder_maps, registry: nil, if_undefined: nil)
        @coder_maps = build_coder_maps(connection_or_coder_maps, registry: registry)
        @array_encoders_by_klass = array_encoders_by_klass
        @encode_array_as = :array
        @if_undefined = if_undefined || proc { |oid_name, format|
                raise UndefinedEncoder, "no encoder defined for type #{oid_name.inspect} format #{format}"
        }
        init_encoders
end

Public Instance Methods

anchor
encode_array_as=(pg_type)

Change the mechanism that is used to encode ruby array values

Possible values:

  • :array : Encode the ruby array as a PostgreSQL array. The array element type is inferred from the class of the first array element. This is the default.

  • :json : Encode the ruby array as a JSON document.

  • :record : Encode the ruby array as a composite type row.

  • "_type" : Encode the ruby array as a particular PostgreSQL type. All PostgreSQL array types are supported. If there’s an encoder registered for the elements type, it will be used. Otherwise a string conversion (by value.to_s) is done.

# File lib/pg/basic_type_map_for_queries.rb, line 70
def encode_array_as=(pg_type)
        case pg_type
                when :array
                when :json
                when :record
                when /\A_/
                else
                        raise ArgumentError, "invalid pg_type #{pg_type.inspect}"
        end

        @encode_array_as = pg_type

        init_encoders
end