Module: ActiveRecord::ConnectionAdapters::PostgreSQL::Quoting

Relationships & Source Files
Namespace Children
Exceptions: `IntegerOutOf64BitRange`
Extension / Inclusion / Inheritance Descendants
Included In: `::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter`
Defined in:	activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb

Constant Summary

COLUMN_NAME = private
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 164

/
  \A
  (
    (?:
      # "schema_name"."table_name"."column_name"::type_name | function(one or no argument)::type_name
      ((?:\w\.|"\w"\.){,2}(?:\w|"\w")(?:::\w+)? | \w\((?:|\g<2>)\)(?:::\w)?)
    )
    (?:(?:\sAS)?\s(?:\w|"\w"))?
  )
  (?:\s*,\s*\g<1>)*
  \z
/ix

COLUMN_NAME_WITH_ORDER = private
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 177

/
  \A
  (
    (?:
      # "schema_name"."table_name"."column_name"::type_name | function(one or no argument)::type_name
      ((?:\w\.|"\w"\.){,2}(?:\w|"\w")(?:::\w+)? | \w\((?:|\g<2>)\)(?:::\w)?)
    )
    (?:\sCOLLATE\s"\w+")?
    (?:\sASC|\sDESC)?
    (?:\sNULLS\s(?:FIRST|LAST))?
  )
  (?:\s*,\s*\g<1>)*
  \z
/ix

Instance Method Summary

#check_int_in_range(value)
#column_name_matcher
#column_name_with_order_matcher
#escape_bytea(value)

Escapes binary strings for bytea input to the database.
#quote_schema_name(name)

Quotes schema names for use in SQL queries.
#quote_table_name_for_assignment(table, attr)
#unescape_bytea(value)

Unescapes bytea output from a database to the binary string it represents.

Instance Method Details

#check_int_in_range(value)

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 28


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.raise_int_wider_than_64bit to false.
    ERROR
    raise IntegerOutOf64BitRange.new exception
  end
end

#column_name_matcher

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 156


def column_name_matcher
  COLUMN_NAME
end

#column_name_with_order_matcher

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 160


def column_name_with_order_matcher
  COLUMN_NAME_WITH_ORDER
end

#escape_bytea(value)

Escapes binary strings for bytea input to the database.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 17


def escape_bytea(value)
  valid_raw_connection.escape_bytea(value) if value
end

#quote_schema_name(name)

Quotes schema names for use in SQL queries.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 93


def quote_schema_name(name)
  PG::Connection.quote_ident(name)
end

#quote_table_name_for_assignment(table, attr)

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 97


def quote_table_name_for_assignment(table, attr)
  quote_column_name(attr)
end

#unescape_bytea(value)

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.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 24


def unescape_bytea(value)
  valid_raw_connection.unescape_bytea(value) if value
end