Methods

Instance Public methods

quote(value)

Quotes the column value to help prevent SQL injection attacks.

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 11
      def quote(value)
        if value.is_a?(Base)
          ActiveSupport::Deprecation.warn(<<~MSG)
            Passing an Active Record object to `quote` directly is deprecated
            and will be no longer quoted as id value in Rails 7.0.
          MSG
          value = value.id_for_database
        end

        _quote(value)
      end

quote_bound_value(value)

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.

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

quote_column_name(column_name)

Quotes the column name. Defaults to no quoting.

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

quote_string(s)

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

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

quote_table_name(table_name)

Quotes the table name. Defaults to column name quoting.

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 78
def quote_table_name(table_name)
  quote_column_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 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).

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

quoted_date(value)

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

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 121
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_s(:db)
  if value.respond_to?(:usec) && value.usec > 0
    result << "." << sprintf("%06d", value.usec)
  else
    result
  end
end

quoted_false()

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

quoted_true()

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

type_cast(value, column = nil)

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.

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 26
      def type_cast(value, column = nil)
        if value.is_a?(Base)
          ActiveSupport::Deprecation.warn(<<~MSG)
            Passing an Active Record object to `type_cast` directly is deprecated
            and will be no longer type casted as id value in Rails 7.0.
          MSG
          value = value.id_for_database
        end

        if column
          ActiveSupport::Deprecation.warn(<<~MSG)
            Passing a column to `type_cast` is deprecated and will be removed in Rails 7.0.
          MSG
          type = lookup_cast_type_from_column(column)
          value = type.serialize(value)
        end

        _type_cast(value)
      end

unquoted_false()

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

unquoted_true()

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