Module: ActiveRecord::ConnectionAdapters::Quoting

Relationships & Source Files
Namespace Children
Modules: `ClassMethods`
Extension / Inclusion / Inheritance Descendants
Included In: `AbstractAdapter`, `AbstractMysqlAdapter`, `Mysql2Adapter`, `PostgreSQLAdapter`, `SQLite3Adapter`, `TrilogyAdapter`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::ActiveSupport::Concern`
Defined in:	activerecord/lib/active_record/connection_adapters/abstract/quoting.rb

Class Method Summary

`::ActiveSupport::Concern` - Extended

class_methods	Define class methods from given block.
included	Evaluate given block in context of base class, so that you can write class macros here.
prepended	Evaluate given block in context of base class, so that you can write class macros here.
append_features, prepend_features

Instance Method Summary

#quote(value)

Quotes the column value to help prevent SQL injection attacks.
#quote_column_name(column_name)

Quotes the column name.
#quote_string(s)

Quotes a string, escaping any ‘ (single quote) and \ (backslash) characters.
#quote_table_name(table_name)

Quotes the table name.
#quote_table_name_for_assignment(table, attr)

Override to return the quoted table name for assignment.
#quoted_date(value)

Quote date/time values for use in SQL input.
#quoted_false
#quoted_true
#type_cast(value)

Cast a value to a type that the database understands.
#unquoted_false
#unquoted_true
#lookup_cast_type(sql_type) private
#type_casted_binds(binds) private
#cast_bound_value(value) Internal use only

Cast a value to be used as a bound parameter of unknown type.
#lookup_cast_type_from_column(column) Internal use only

If you are having to call this function, you are likely doing something wrong.
#quote_default_expression(value, column) Internal use only
#quoted_binary(value) Internal use only
#quoted_time(value) Internal use only
#sanitize_as_sql_comment(value) Internal use only

Instance Method Details

#cast_bound_value(value)

This method is for internal use only.

Cast a value to be used as a bound parameter of unknown type. For example, MySQL might perform dangerous castings when comparing a string to a number, so this method will cast numbers to string.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 112


def cast_bound_value(value) # :nodoc:
  value
end

#lookup_cast_type(sql_type) (private)

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 234


def lookup_cast_type(sql_type)
  type_map.lookup(sql_type)
end

#lookup_cast_type_from_column(column)

This method is for internal use only.

If you are having to call this function, you are likely doing something wrong. The column does not have sufficient type information if the user provided a custom type on the class level either explicitly (via Attributes::ClassMethods#attribute) or implicitly (via AttributeMethods::Serialization::ClassMethods#serialize, time_zone_aware_attributes). In almost all cases, the sql type should only be used to change quoting behavior, when the primitive to represent the type doesn’t sufficiently reflect the differences (varchar vs binary) for example. The type used to get this primitive should have been provided before reaching the connection adapter.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 125


def lookup_cast_type_from_column(column) # :nodoc:
  lookup_cast_type(column.sql_type)
end

#quote(value)

Quotes the column value to help prevent SQL injection attacks.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 73


def quote(value)
  case value
  when String, Symbol, ActiveSupport::Multibyte::Chars
    "'#{quote_string(value.to_s)}'"
  when true       then quoted_true
  when false      then quoted_false
  when nil        then "NULL"
  # BigDecimals need to be put in a non-normalized form and quoted.
  when BigDecimal then value.to_s("F")
  when Numeric then value.to_s
  when Type::Binary::Data then quoted_binary(value)
  when Type::Time::Value then "'#{quoted_time(value)}'"
  when Date, Time then "'#{quoted_date(value)}'"
  when Class      then "'#{value}'"
  else raise TypeError, "can't quote #{value.class.name}"
  end
end

#quote_column_name(column_name)

Quotes the column name.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 136


def quote_column_name(column_name)
  self.class.quote_column_name(column_name)
end

#quote_default_expression(value, column)

This method is for internal use only.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 157


def quote_default_expression(value, column) # :nodoc:
  if value.is_a?(Proc)
    value.call
  else
    value = lookup_cast_type(column.sql_type).serialize(value)
    quote(value)
  end
end

#quote_string(s)

Quotes a string, escaping any ‘ (single quote) and \ (backslash) characters.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 131


def quote_string(s)
  s.gsub("\\", '\&\&').gsub("'", "''") # ' (for ruby-mode)
end

#quote_table_name(table_name)

Quotes the table name.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 141


def quote_table_name(table_name)
  self.class.quote_table_name(table_name)
end

#quote_table_name_for_assignment(table, attr)

Override to return the quoted table name for assignment. Defaults to table quoting.

This works for MySQL where table.column can be used to resolve ambiguity.

We override this in the sqlite3 and postgresql adapters to use only the column name (as per syntax requirements).

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 153


def quote_table_name_for_assignment(table, attr)
  quote_table_name("#{table}.#{attr}")
end

#quoted_binary(value)

This method is for internal use only.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 206


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

#quoted_date(value)

Quote date/time values for use in SQL input. Includes microseconds if the value is a ::Time responding to usec.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 184


def quoted_date(value)
  if value.acts_like?(:time)
    if default_timezone == :utc
      value = value.getutc if !value.utc?
    else
      value = value.getlocal
    end
  end

  result = value.to_fs(:db)
  if value.respond_to?(:usec) && value.usec > 0
    result << "." << sprintf("%06d", value.usec)
  else
    result
  end
end

#quoted_false

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 174


def quoted_false
  "FALSE"
end

#quoted_time(value)

This method is for internal use only.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 201


def quoted_time(value) # :nodoc:
  value = value.change(year: 2000, month: 1, day: 1)
  quoted_date(value).sub(/\A\d\d\d\d-\d\d-\d\d /, "")
end

#quoted_true

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 166


def quoted_true
  "TRUE"
end

#sanitize_as_sql_comment(value)

This method is for internal use only.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 210


def sanitize_as_sql_comment(value) # :nodoc:
  # Sanitize a string to appear within a SQL comment
  # For compatibility, this also surrounding "/*+", "/*", and "*/"
  # charcacters, possibly with single surrounding space.
  # Then follows that by replacing any internal "*/" or "/ *" with
  # "* /" or "/ *"
  comment = value.to_s.dup
  comment.gsub!(%r{\A\s*/\*\+?\s?|\s?\*/\s*\Z}, "")
  comment.gsub!("*/", "* /")
  comment.gsub!("/*", "/ *")
  comment
end

#type_cast(value)

Cast a value to a type that the database understands. For example, SQLite does not understand dates, so this method will convert a ::Date to a ::String.

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 94


def type_cast(value)
  case value
  when Symbol, ActiveSupport::Multibyte::Chars, Type::Binary::Data
    value.to_s
  when true       then unquoted_true
  when false      then unquoted_false
  # BigDecimals need to be put in a non-normalized form and quoted.
  when BigDecimal then value.to_s("F")
  when nil, Numeric, String then value
  when Type::Time::Value then quoted_time(value)
  when Date, Time then quoted_date(value)
  else raise TypeError, "can't cast #{value.class.name}"
  end
end

#type_casted_binds(binds) (private)

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 224


def type_casted_binds(binds)
  binds&.map do |value|
    if ActiveModel::Attribute === value
      type_cast(value.value_for_database)
    else
      type_cast(value)
    end
  end
end

#unquoted_false

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 178


def unquoted_false
  false
end

#unquoted_true

[ GitHub ]

# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 170


def unquoted_true
  true
end

Module: ActiveRecord::ConnectionAdapters::Quoting

Class Method Summary

::ActiveSupport::Concern - Extended

Instance Method Summary

Instance Method Details

#cast_bound_value(value)

#lookup_cast_type(sql_type) (private)

#lookup_cast_type_from_column(column)

#quote(value)

#quote_column_name(column_name)

#quote_default_expression(value, column)

#quote_string(s)

#quote_table_name(table_name)

#quote_table_name_for_assignment(table, attr)

#quoted_binary(value)

#quoted_date(value)

#quoted_false

#quoted_time(value)

#quoted_true

#sanitize_as_sql_comment(value)

#type_cast(value)

#type_casted_binds(binds) (private)

#unquoted_false

#unquoted_true

`::ActiveSupport::Concern` - Extended