Module: Arel
Constant Summary
-
Attribute =
# File 'activerecord/lib/arel/attributes/attribute.rb', line 32Attributes::Attribute
-
VERSION =
# File 'activerecord/lib/arel.rb', line 29"10.0.0"
Class Method Summary
-
.sql(sql_string, *positional_binds, retryable: false, **named_binds)
Wrap a known-safe SQL string for passing to query methods, e.g.
- .arel_node?(value) ⇒ Boolean Internal use only
- .fetch_attribute(value, &block) Internal use only
- .star Internal use only
Class Method Details
.arel_node?(value) ⇒ Boolean
# File 'activerecord/lib/arel.rb', line 64
def self.arel_node?(value) # :nodoc: value.is_a?(Arel::Nodes::Node) || value.is_a?(Arel::Attribute) || value.is_a?(Arel::Nodes::SqlLiteral) end
.fetch_attribute(value, &block)
# File 'activerecord/lib/arel.rb', line 68
def self.fetch_attribute(value, &block) # :nodoc: unless String === value value.fetch_attribute(&block) end end
.sql(sql_string, *positional_binds, retryable: false, **named_binds)
Wrap a known-safe SQL string for passing to query methods, e.g.
Post.order(Arel.sql("REPLACE(title, 'misc', 'zzzz') asc")).pluck(:id)
Great caution should be taken to avoid SQL injection vulnerabilities. This method should not be used with unsafe values such as request parameters or model attributes.
Take a look at the security guide for more information.
To construct a more complex query fragment, including the possible use of user-provided values, the sql_string
may contain ?
and :key
placeholders, corresponding to the additional arguments. Note that this behavior only applies when bind value parameters are supplied in the call; without them, the placeholder tokens have no special meaning, and will be passed through to the query as-is.
The :retryable
option can be used to mark the SQL as safe to retry. Use this option only if the SQL is idempotent, as it could be executed more than once.
# File 'activerecord/lib/arel.rb', line 52
def self.sql(sql_string, *positional_binds, retryable: false, **named_binds) if positional_binds.empty? && named_binds.empty? Arel::Nodes::SqlLiteral.new(sql_string, retryable: retryable) else Arel::Nodes::BoundSqlLiteral.new sql_string, positional_binds, named_binds end end
.star
# File 'activerecord/lib/arel.rb', line 60
def self.star # :nodoc: sql("*", retryable: true) end