Active Record Connection Adapters Quoting

Methods

Instance Public methods

quote(value)

Quotes the column value to help prevent SQL injection attacks.

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 12
      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}'"
        when ActiveSupport::Duration
          warn_quote_duration_deprecated
          value.to_s
        else raise TypeError, "can't quote #{value.class.name}"
        end
      end
πŸ”Ž See on GitHub

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.

Deprecated: Consider β€˜Arel.sql(β€œβ€¦ ? …”, value)` or sanitize_sql instead.

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 57
      def quote_bound_value(value)
        ActiveRecord.deprecator.warn(<<~MSG.squish)
          #quote_bound_value is deprecated and will be removed in Rails 7.2.
          Consider Arel.sql(".. ? ..", value) or #sanitize_sql instead.
        MSG

        quote(cast_bound_value(value))
      end
πŸ”Ž See on GitHub

quote_column_name(column_name)

Quotes the column name. Defaults to no quoting.

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 93
      def quote_column_name(column_name)
        column_name.to_s
      end
πŸ”Ž See on GitHub

quote_string(s)

Quotes a string, escaping any β€˜ (single quote) and \ (backslash) characters.

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 88
      def quote_string(s)
        s.gsub("\\", '\&\&').gsub("'", "''") # ' (for ruby-mode)
      end
πŸ”Ž See on GitHub

quote_table_name(table_name)

Quotes the table name. Defaults to column name quoting.

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 98
      def quote_table_name(table_name)
        quote_column_name(table_name)
      end
πŸ”Ž See on GitHub

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

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 110
      def quote_table_name_for_assignment(table, attr)
        quote_table_name("#{table}.#{attr}")
      end
πŸ”Ž See on GitHub

quoted_date(value)

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

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 141
      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
πŸ”Ž See on GitHub

quoted_false()

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 131
      def quoted_false
        "FALSE"
      end
πŸ”Ž See on GitHub

quoted_true()

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 123
      def quoted_true
        "TRUE"
      end
πŸ”Ž See on GitHub

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.

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 36
      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
πŸ”Ž See on GitHub

unquoted_false()

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 135
      def unquoted_false
        false
      end
πŸ”Ž See on GitHub

unquoted_true()

πŸ“ Source code 
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 127
      def unquoted_true
        true
      end
πŸ”Ž See on GitHub