Module: ActiveRecord::ConnectionAdapters::Quoting

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `AbstractAdapter`, `AbstractMysqlAdapter`, `Mysql2Adapter`, `PostgreSQLAdapter`, `SQLite3Adapter`
Defined in:	activerecord/lib/active_record/connection_adapters/abstract/quoting.rb

Constant Summary

COLUMN_NAME = private

::Regexp for column names (with or without a table name prefix). Matches the following:

"#{table_name}.#{column_name}"
"#{column_name}"

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

/
  \A
  (
    (?:
      # table_name.column_name | function(one or no argument)
      ((?:\w\.)?\w) | \w+\((?:|\g<2>)\)
    )
    (?:(?:\sAS)?\s\w+)?
  )
  (?:\s*,\s*\g<1>)*
  \z
/ix

COLUMN_NAME_WITH_ORDER = private

::Regexp for column names with order (with or without a table name prefix, with or without various order modifiers). Matches the following:

"#{table_name}.#{column_name}"
"#{table_name}.#{column_name} #{direction}"
"#{table_name}.#{column_name} #{direction} NULLS FIRST"
"#{table_name}.#{column_name} NULLS LAST"
"#{column_name}"
"#{column_name} #{direction}"
"#{column_name} #{direction} NULLS FIRST"
"#{column_name} NULLS LAST"

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

/
  \A
  (
    (?:
      # table_name.column_name | function(one or no argument)
      ((?:\w\.)?\w) | \w+\((?:|\g<2>)\)
    )
    (?:\sASC|\sDESC)?
    (?:\sNULLS\s(?:FIRST|LAST))?
  )
  (?:\s*,\s*\g<1>)*
  \z
/ix

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, column = nil)

Cast a value to a type that the database understands.
#unquoted_false
#unquoted_true

Instance Method Details

#quote(value)

Quotes the column value to help prevent SQL injection attacks.

[ GitHub ]

# 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_column_name(column_name)

Quotes the column name. Defaults to no quoting.

[ GitHub ]

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


def quote_column_name(column_name)
  column_name.to_s
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 61


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.

[ GitHub ]

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


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

[ GitHub ]

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


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.

[ GitHub ]

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


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

[ GitHub ]

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


def quoted_false
  "FALSE"
end

#quoted_true

[ GitHub ]

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


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.

[ GitHub ]

# 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

[ GitHub ]

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


def unquoted_false
  false
end

#unquoted_true

[ GitHub ]

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


def unquoted_true
  true
end