module ActiveRecord::ConnectionAdapters::Quoting
Constants
- COLUMN_NAME
Regexp for column names (with or without a table name prefix). Matches the following:
"#{table_name}.#{column_name}" "#{column_name}"
- COLUMN_NAME_WITH_ORDER
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"
Public Instance Methods
Quotes the column value to help prevent SQL injection attacks.
# File 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
Quotes the column name. Defaults to no quoting.
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 66 def quote_column_name(column_name) column_name.to_s end
Quotes a string, escaping any ' (single quote) and \ (backslash) characters.
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 61 def quote_string(s) s.gsub('\\', '\&\&').gsub("'", "''") # ' (for ruby-mode) end
Quotes the table name. Defaults to column name quoting.
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 71 def quote_table_name(table_name) quote_column_name(table_name) end
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 lib/active_record/connection_adapters/abstract/quoting.rb, line 83 def quote_table_name_for_assignment(table, attr) quote_table_name("#{table}.#{attr}") end
Quote date/time values for use in SQL input. Includes microseconds if the value is a Time responding to usec.
# File 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
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 104 def quoted_false "FALSE" end
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 96 def quoted_true "TRUE" end
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 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
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 108 def unquoted_false false end
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 100 def unquoted_true true end
Private Instance Methods
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 226 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, ActiveSupport::Duration 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}'" else raise TypeError, "can't quote #{value.class.name}" end end
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 244 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
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 222 def lookup_cast_type(sql_type) type_map.lookup(sql_type) end
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 207 def type_casted_binds(binds) case binds.first when Array binds.map { |column, value| type_cast(value, column) } else binds.map do |value| if ActiveModel::Attribute === value type_cast(value.value_for_database) else type_cast(value) end end end end