W3cubDocs

module ActiveRecord::ConnectionAdapters::Quoting

Public Instance Methods

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 11
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, ActiveSupport::Duration 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

Quotes the column value to help prevent SQL injection attacks.

quote_bound_value(value) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 50
def quote_bound_value(value)
  quote(value)
end

Quote 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.

quote_column_name(column_name) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 74
def quote_column_name(column_name)
  column_name.to_s
end

Quotes the column name. Defaults to no quoting.

quote_string(s) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 69
def quote_string(s)
  s.gsub("\\", '\&\&').gsub("'", "''") # ' (for ruby-mode)
end

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

quote_table_name(table_name) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 79
def quote_table_name(table_name)
  quote_column_name(table_name)
end

Quotes the table name. Defaults to column name quoting.

quote_table_name_for_assignment(table, attr) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 91
def quote_table_name_for_assignment(table, attr)
  quote_table_name("#{table}.#{attr}")
end

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

This works for mysql2 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).

quoted_date(value) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 122
def quoted_date(value)
  if value.acts_like?(:time)
    if ActiveRecord.default_timezone == :utc
      value = value.getutc if !value.utc?
    else
      value = value.getlocal
    end
  end

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

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

quoted_false() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 112
def quoted_false
  "FALSE"
end

quoted_true() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 104
def quoted_true
  "TRUE"
end

type_cast(value) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 32
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

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.

unquoted_false() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 116
def unquoted_false
  false
end

unquoted_true() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 108
def unquoted_true
  true
end