W3cubDocs

module ActiveRecord::ConnectionAdapters::Quoting

Public Instance Methods

fetch_type_metadata(sql_type) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 67
def fetch_type_metadata(sql_type)
  cast_type = lookup_cast_type(sql_type)
  SqlTypeMetadata.new(
    sql_type: sql_type,
    type: cast_type.type,
    limit: cast_type.limit,
    precision: cast_type.precision,
    scale: cast_type.scale,
  )
end

quote(value, column = nil) Show source

Quotes the column value to help prevent SQL injection attacks.

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 9
      def quote(value, column = nil)
        # records are quoted as their primary key
        return value.quoted_id if value.respond_to?(:quoted_id)

        if column
          ActiveSupport::Deprecation.warn("            Passing a column to `quote` has been deprecated. It is only used
            for type casting, which should be handled elsewhere. See
            https://github.com/rails/arel/commit/6160bfbda1d1781c3b08a33ec4955f170e95be11
            for more information.
".squish)
          value = type_cast_from_column(column, value)
        end

        _quote(value)
      end

quote_column_name(column_name) Show source

Quotes the column name. Defaults to no quoting.

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

quote_string(s) Show source

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

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

quote_table_name(table_name) Show source

Quotes the table name. Defaults to column name quoting.

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

quote_table_name_for_assignment(table, attr) Show source

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 102
def quote_table_name_for_assignment(table, attr)
  quote_table_name("#{table}.#{attr}")
end

quoted_date(value) Show source

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 133
def quoted_date(value)
  if value.acts_like?(:time)
    zone_conversion_method = ActiveRecord::Base.default_timezone == :utc ? :getutc : :getlocal

    if value.respond_to?(zone_conversion_method)
      value = value.send(zone_conversion_method)
    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() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 123
def quoted_false
  "'f'".freeze
end

quoted_true() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 115
def quoted_true
  "'t'".freeze
end

type_cast(value, column = nil) Show source

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 29
def type_cast(value, column = nil)
  if value.respond_to?(:quoted_id) && value.respond_to?(:id)
    return value.id
  end

  if column
    value = type_cast_from_column(column, value)
  end

  _type_cast(value)
rescue TypeError
  to_type = column ? " to #{column.type}" : ""
  raise TypeError, "can't cast #{value.class}#{to_type}"
end

unquoted_false() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 127
def unquoted_false
  'f'.freeze
end

unquoted_true() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 119
def unquoted_true
  't'.freeze
end