Module: ActiveRecord::ConnectionAdapters::PostgreSQL::Quoting
Relationships & Source Files | |
Namespace Children | |
Exceptions:
| |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
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
-
QUOTED_COLUMN_NAMES =
Internal use only
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 7Concurrent::Map.new
-
QUOTED_TABLE_NAMES =
Internal use only
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 8Concurrent::Map.new
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.
- #determine_encoding_of_strings_in_array(value) private
- #encode_array(array_data) private
- #encode_range(range) private
- #infinity?(value) ⇒ Boolean private
- #lookup_cast_type(sql_type) private
- #type_cast_array(values) private
- #type_cast_range_value(value) private
- #lookup_cast_type_from_column(column) Internal use only
- #quote(value) Internal use only
-
#quote_column_name(name)
Internal use only
Quotes column names for use in SQL queries.
- #quote_default_expression(value, column) Internal use only
-
#quote_string(s)
Internal use only
Quotes strings for use in SQL input.
-
#quote_table_name(name)
Internal use only
Checks the following cases:
- #quoted_binary(value) Internal use only
-
#quoted_date(value)
Internal use only
Quote date/time values for use in SQL input.
- #type_cast(value) Internal use only
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
#determine_encoding_of_strings_in_array(value) (private)
[ GitHub ]#encode_array(array_data) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 199
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) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 210
def encode_range(range) "[#{type_cast_range_value(range.begin)},#{type_cast_range_value(range.end)}#{range.exclude_end? ? ')' : ']'}" end
#escape_bytea(value)
Escapes binary strings for bytea input to the database.
# 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
#infinity?(value) ⇒ Boolean
(private)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 232
def infinity?(value) value.respond_to?(:infinite?) && value.infinite? end
#lookup_cast_type(sql_type) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 195
def lookup_cast_type(sql_type) super(query_value("SELECT #{quote(sql_type)}::regtype::oid", "SCHEMA").to_i) end
#lookup_cast_type_from_column(column)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 151
def lookup_cast_type_from_column(column) # :nodoc: verify! if type_map.nil? type_map.lookup(column.oid, column.fmod, column.sql_type) end
#quote(value)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 44
def quote(value) # :nodoc: if ActiveRecord.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
#quote_column_name(name)
Quotes column names for use in SQL queries.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 102
def quote_column_name(name) # :nodoc: QUOTED_COLUMN_NAMES[name] ||= PG::Connection.quote_ident(super).freeze end
#quote_default_expression(value, column)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 120
def quote_default_expression(value, column) # :nodoc: if value.is_a?(Proc) value.call elsif column.type == :uuid && value.is_a?(String) && value.include?("()") value # Does not quote function default values for UUID columns elsif column.respond_to?(:array?) type = lookup_cast_type_from_column(column) quote(type.serialize(value)) else super end end
#quote_schema_name(name)
Quotes schema names for use in SQL queries.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 93
def quote_schema_name(name) PG::Connection.quote_ident(name) end
#quote_string(s)
Quotes strings for use in SQL input.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 74
def quote_string(s) # :nodoc: with_raw_connection(allow_retry: true, materialize_transactions: false) do |connection| connection.escape(s) end end
#quote_table_name(name)
Checks the following cases:
-
table_name
-
“table.name”
-
schema_name.table_name
-
schema_name.“table.name”
-
“schema.name”.table_name
-
“schema.name”.“table.name”
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 88
def quote_table_name(name) # :nodoc: QUOTED_TABLE_NAMES[name] ||= Utils.extract_schema_qualified_name(name.to_s).quoted.freeze 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
#quoted_binary(value)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 116
def quoted_binary(value) # :nodoc: "'#{escape_bytea(value.to_s)}'" end
#quoted_date(value)
Quote date/time values for use in SQL input.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 107
def quoted_date(value) # :nodoc: if value.year <= 0 bce_year = format("%04d", -value.year + 1) super.sub(/^-?\d+/, bce_year) + " BC" else super end end
#type_cast(value)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 133
def type_cast(value) # :nodoc: 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
#type_cast_array(values) (private)
[ GitHub ]#type_cast_range_value(value) (private)
[ GitHub ]#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.
# 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