module ActiveRecord::ConnectionAdapters::PostgreSQL::Quoting

Constants

COLUMN_NAME
COLUMN_NAME_WITH_ORDER

Public Instance Methods

column_name_matcher() click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 87
def column_name_matcher
  COLUMN_NAME
end
column_name_with_order_matcher() click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 91
def column_name_with_order_matcher
  COLUMN_NAME_WITH_ORDER
end
escape_bytea(value) click to toggle source

Escapes binary strings for bytea input to the database.

# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 14
def escape_bytea(value)
  @connection.escape_bytea(value) if value
end
quote_schema_name(name) click to toggle source

Quotes schema names for use in SQL queries.

# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 43
def quote_schema_name(name)
  PG::Connection.quote_ident(name)
end
quote_table_name_for_assignment(table, attr) click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 47
def quote_table_name_for_assignment(table, attr)
  quote_column_name(attr)
end
unescape_bytea(value) click to toggle source

Unescapes bytea output from a database to the binary string it represents. NOTE: This is NOT an inverse of escape_bytea! This is only to be used on escaped binary output from database drive.

# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 21
def unescape_bytea(value)
  @connection.unescape_bytea(value) if value
end

Private Instance Methods

_quote(value) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 145
def _quote(value)
  if ActiveRecord::Base.raise_int_wider_than_64bit && value.is_a?(Integer)
    check_int_in_range(value)
  end

  case value
  when OID::Xml::Data
    "xml '#{quote_string(value.to_s)}'"
  when OID::Bit::Data
    if value.binary?
      "B'#{value}'"
    elsif value.hex?
      "X'#{value}'"
    end
  when Numeric
    if value.finite?
      super
    else
      "'#{value}'"
    end
  when OID::Array::Data
    _quote(encode_array(value))
  when Range
    _quote(encode_range(value))
  else
    super
  end
end
_type_cast(value) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 174
def _type_cast(value)
  case value
  when Type::Binary::Data
    # Return a bind param hash with format as binary.
    # See https://deveiate.org/code/pg/PG/Connection.html#method-i-exec_prepared-doc
    # for more information
    { value: value.to_s, format: 1 }
  when OID::Xml::Data, OID::Bit::Data
    value.to_s
  when OID::Array::Data
    encode_array(value)
  when Range
    encode_range(value)
  else
    super
  end
end
check_int_in_range(value) click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 129
          def check_int_in_range(value)
            if value.to_int > 9223372036854775807 || value.to_int < -9223372036854775808
              exception = <<~ERROR
                Provided value outside of the range of a signed 64bit integer.

                PostgreSQL will treat the column type in question as a numeric.
                This may result in a slow sequential scan due to a comparison
                being performed between an integer or bigint value and a numeric value.

                To allow for this potentially unwanted behavior, set
                ActiveRecord::Base.raise_int_wider_than_64bit to false.
              ERROR
              raise IntegerOutOf64BitRange.new exception
            end
          end
determine_encoding_of_strings_in_array(value) click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 207
def determine_encoding_of_strings_in_array(value)
  case value
  when ::Array then determine_encoding_of_strings_in_array(value.first)
  when ::String then value.encoding
  end
end
encode_array(array_data) click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 192
def encode_array(array_data)
  encoder = array_data.encoder
  values = type_cast_array(array_data.values)

  result = encoder.encode(values)
  if encoding = determine_encoding_of_strings_in_array(values)
    result.force_encoding(encoding)
  end
  result
end
encode_range(range) click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 203
def encode_range(range)
  "[#{type_cast_range_value(range.begin)},#{type_cast_range_value(range.end)}#{range.exclude_end? ? ')' : ']'}"
end
infinity?(value) click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 225
def infinity?(value)
  value.respond_to?(:infinite?) && value.infinite?
end
lookup_cast_type(sql_type) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 125
def lookup_cast_type(sql_type)
  super(query_value("SELECT #{quote(sql_type)}::regtype::oid", "SCHEMA").to_i)
end
type_cast_array(values) click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 214
def type_cast_array(values)
  case values
  when ::Array then values.map { |item| type_cast_array(item) }
  else _type_cast(values)
  end
end
type_cast_range_value(value) click to toggle source
# File lib/active_record/connection_adapters/postgresql/quoting.rb, line 221
def type_cast_range_value(value)
  infinity?(value) ? "" : type_cast(value)
end