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

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

Instance Method Summary collapse

Instance Method Details

#column_name_matcherObject


124
125
126
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 124

def column_name_matcher
  COLUMN_NAME
end

#column_name_with_order_matcherObject


128
129
130
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 128

def column_name_with_order_matcher
  COLUMN_NAME_WITH_ORDER
end

#escape_bytea(value) ⇒ Object

Escapes binary strings for bytea input to the database.


8
9
10
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 8

def escape_bytea(value)
  @raw_connection.escape_bytea(value) if value
end

#lookup_cast_type_from_column(column) ⇒ Object

:nodoc:


120
121
122
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 120

def lookup_cast_type_from_column(column) # :nodoc:
  type_map.lookup(column.oid, column.fmod, column.sql_type)
end

#quote(value) ⇒ Object

:nodoc:


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 19

def quote(value) # :nodoc:
  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.


71
72
73
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 71

def quote_column_name(name) # :nodoc:
  self.class.quoted_column_names[name] ||= PG::Connection.quote_ident(super).freeze
end

#quote_default_expression(value, column) ⇒ Object

:nodoc:


89
90
91
92
93
94
95
96
97
98
99
100
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 89

def quote_default_expression(value, column) # :nodoc:
  if value.is_a?(Proc)
    value.call
  elsif column.type == :uuid && value.is_a?(String) && /\(\)/.match?(value)
    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.


62
63
64
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 62

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

#quote_string(s) ⇒ Object

Quotes strings for use in SQL input.


45
46
47
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 45

def quote_string(s) # :nodoc:
  @raw_connection.escape(s)
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”


57
58
59
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 57

def quote_table_name(name) # :nodoc:
  self.class.quoted_table_names[name] ||= Utils.extract_schema_qualified_name(name.to_s).quoted.freeze
end

#quote_table_name_for_assignment(table, attr) ⇒ Object


66
67
68
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 66

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

#quoted_binary(value) ⇒ Object

:nodoc:


85
86
87
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 85

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

#quoted_date(value) ⇒ Object

Quote date/time values for use in SQL input.


76
77
78
79
80
81
82
83
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 76

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:


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb', line 102

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.


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

def unescape_bytea(value)
  @raw_connection.unescape_bytea(value) if value
end