Module: ActiveRecord::ConnectionAdapters::Quoting
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
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}"
/ \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"
/ \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_bound_value(value)
Quote a value to be used as a bound parameter of unknown type.
-
#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)
Cast a
value
to a type that the database understands. - #unquoted_false
- #unquoted_true
- #lookup_cast_type(sql_type) private
- #type_casted_binds(binds) private
- #warn_quote_duration_deprecated private
-
#cast_bound_value(value)
Internal use only
Cast a value to be used as a bound parameter of unknown type.
- #column_name_matcher Internal use only
- #column_name_with_order_matcher Internal use only
-
#lookup_cast_type_from_column(column)
Internal use only
If you are having to call this function, you are likely doing something wrong.
- #quote_default_expression(value, column) Internal use only
- #quoted_binary(value) Internal use only
- #quoted_time(value) Internal use only
- #sanitize_as_sql_comment(value) Internal use only
Instance Method Details
#cast_bound_value(value)
Cast 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 69
def cast_bound_value(value) # :nodoc: value end
#column_name_matcher
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 180
def column_name_matcher # :nodoc: COLUMN_NAME end
#column_name_with_order_matcher
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 184
def column_name_with_order_matcher # :nodoc: COLUMN_NAME_WITH_ORDER end
#lookup_cast_type(sql_type) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 244
def lookup_cast_type(sql_type) type_map.lookup(sql_type) end
#lookup_cast_type_from_column(column)
If you are having to call this function, you are likely doing something wrong. The column does not have sufficient type information if the user provided a custom type on the class level either explicitly (via Attributes::ClassMethods#attribute) or implicitly (via AttributeMethods::Serialization::ClassMethods#serialize, time_zone_aware_attributes
). In almost all cases, the sql type should only be used to change quoting behavior, when the primitive to represent the type doesn’t sufficiently reflect the differences (varchar vs binary) for example. The type used to get this primitive should have been provided before reaching the connection adapter.
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 82
def lookup_cast_type_from_column(column) # :nodoc: lookup_cast_type(column.sql_type) end
#quote(value)
Quotes the column value to help prevent SQL injection attacks.
# 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
#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.
# 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
#quote_column_name(column_name)
Quotes the column name. Defaults to no quoting.
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 93
def quote_column_name(column_name) column_name.to_s end
#quote_default_expression(value, column)
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 114
def quote_default_expression(value, column) # :nodoc: if value.is_a?(Proc) value.call else value = lookup_cast_type(column.sql_type).serialize(value) quote(value) end 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 88
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 98
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 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).
# 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
#quoted_binary(value)
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 163
def quoted_binary(value) # :nodoc: "'#{quote_string(value.to_s)}'" 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 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
#quoted_false
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 131
def quoted_false "FALSE" end
#quoted_time(value)
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 158
def quoted_time(value) # :nodoc: value = value.change(year: 2000, month: 1, day: 1) quoted_date(value).sub(/\A\d\d\d\d-\d\d-\d\d /, "") end
#quoted_true
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 123
def quoted_true "TRUE" end
#sanitize_as_sql_comment(value)
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 167
def sanitize_as_sql_comment(value) # :nodoc: # Sanitize a string to appear within a SQL comment # For compatibility, this also surrounding "/*+", "/*", and "*/" # charcacters, possibly with single surrounding space. # Then follows that by replacing any internal "*/" or "/ *" with # "* /" or "/ *" comment = value.to_s.dup comment.gsub!(%r{\A\s*/\*\+?\s?|\s?\*/\s*\Z}, "") comment.gsub!("*/", "* /") comment.gsub!("/*", "/ *") comment end
#type_cast(value)
# 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
#type_casted_binds(binds) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 234
def type_casted_binds(binds) binds.map do |value| if ActiveModel::Attribute === value type_cast(value.value_for_database) else type_cast(value) end end end
#unquoted_false
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 135
def unquoted_false false end
#unquoted_true
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 127
def unquoted_true true end
#warn_quote_duration_deprecated (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 248
def warn_quote_duration_deprecated ActiveRecord.deprecator.warn(<<~MSG) Using ActiveSupport::Duration as an interpolated bind parameter in a SQL string template is deprecated. To avoid this warning, you should explicitly convert the duration to a more specific database type. For example, if you want to use a duration as an integer number of seconds: ``` Record.where("duration = ?", 1.hour.to_i) ``` If you want to use a duration as an ISO 8601 string: ``` Record.where("duration = ?", 1.hour.iso8601) ``` MSG end