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

Included in:
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
Defined in:
lib/active_record/connection_adapters/postgresql/quoting.rb

Defined Under Namespace

Classes: IntegerOutOf64BitRange

Constant Summary collapse

QUOTED_COLUMN_NAMES =

:nodoc:

Concurrent::Map.new
QUOTED_TABLE_NAMES =

:nodoc:

Concurrent::Map.new

Instance Method Summary collapse

Instance Method Details

#check_int_in_range(value) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File '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 ⇒ Object 



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

def column_name_matcher
  COLUMN_NAME
end

#column_name_with_order_matcher ⇒ Object 



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

def column_name_with_order_matcher
  COLUMN_NAME_WITH_ORDER
end

#escape_bytea(value) ⇒ Object

Escapes binary strings for bytea input to the database.



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

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

#lookup_cast_type_from_column(column) ⇒ Object

:nodoc:



151
152
153
154
 
# File '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) ⇒ Object

:nodoc:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File '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) ⇒ Object

Quotes column names for use in SQL queries.



102
103
104
 
# File '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) ⇒ Object

:nodoc:



120
121
122
123
124
125
126
127
128
129
130
131
 
# File '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) ⇒ Object

Quotes schema names for use in SQL queries.



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

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

#quote_string(s) ⇒ Object

Quotes strings for use in SQL input.



74
75
76
77
78
 
# File '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) ⇒ Object

Checks the following cases:

  • table_name

  • “table.name”

  • schema_name.table_name

  • schema_name.“table.name”

  • “schema.name”.table_name

  • “schema.name”.“table.name”



88
89
90
 
# File '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) ⇒ Object 



97
98
99
 
# File '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) ⇒ Object

:nodoc:



116
117
118
 
# File 'lib/active_record/connection_adapters/postgresql/quoting.rb', line 116

def quoted_binary(value) # :nodoc:
  "'#{escape_bytea(value.to_s)}'"
end

#quoted_date(value) ⇒ Object

Quote date/time values for use in SQL input.



107
108
109
110
111
112
113
114
 
# File '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) ⇒ Object

:nodoc:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File '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

#unescape_bytea(value) ⇒ Object

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.



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

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