README.md

ActiveRecord Simple Execute

Warning

GEM DEPRECATED: I now recommend to just use connection.select_all(Arel.sql(sql, foo: "dead", bar: "beef")).to_a

Sanitize and Execute your raw SQL queries in ActiveRecord and Rails with a much more intuitive and shortened syntax.

This gem is in response to a lack of proper documentation of best practices within Rails - I've created a documentation PR to resolve this but until this this is merged this gem seems necessary for the eco-system.

Installation

gem "active_record_simple_execute"

Comparison with Plain ActiveRecord

As seen here using simple_execute is much easier to remember than all the hoops plain ActiveRecord makes you jump through.

Using simple_execute

sql_str = <<~SQL.squish
  SELECT * FROM orders
  FROM orders
  WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
SQL

records = ActiveRecord::Base.connection.simple_execute(sql_str, company_id: @company.id, user_id: @user.id)
# OR use the convenience method excluding the connection portion
# ActiveRecord::Base.simple_execute(...)

Using original ActiveRecord select_all or exec_query method

sql_str = <<~SQL.squish
  SELECT *
  FROM orders
  WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
SQL

### FOR READ OPERATIONS
sanitized_sql = Arel.sql(sql_str, company_id: @company.id, user_id: @user.id)
result = ActiveRecord::Base.connection.select_all(sanitized_sql)

### OR FOR WRITE OPERATIONS (you probably shouldnt be doing this anyways)
### (while exec_query is capable of read & write operations, recommended only for write operations as it affects the query cache)
sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, {company_id: @company.id, user_id: @user.id}]) # Must use sanitize_sql_array, since Arel.sql is not yet compatible with `exec_query`
result = ActiveRecord::Base.connection.exec_query(sanitized_sql) # recommended only for write operations as it affects the query cache

records = result.to_a # convert the ActiveRecord::Result object into an array of hashes

return records

Using original ActiveRecord execute method

It should be noted that it is recommended to avoid all usage of execute and to instead use select_all or exec_query which returns generic ActiveRecord::Result objects

sql_str = <<~SQL.squish
  SELECT *
  FROM orders
  WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
SQL

# Must use sanitize_sql_array, since Arel.sql is not yet compatible with `execute`
sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, {company_id: @company.id, user_id: @user.id}])

result = ActiveRecord::Base.connection.execute(sanitized_sql)

if defined?(PG::Result) && result.is_a?(PG::Result)
  records = result.to_a

  result.clear # to prevent memory leak

elsif defined?(Mysql2::Result) && result.is_a?(Mysql2::Result)
  records = []

  result.each do |row|
    h = {}

    result.fields.each_with_index do |field,i|
      h[field] = row[i]
    end

    records << h
  end

else
  records = result
end

return records

Testing

bundle exec rake test

We can locally test different versions of Rails using ENV['RAILS_VERSION']

export RAILS_VERSION=7.0
bundle install
bundle exec rake test

For quicker feedback during gem development or debugging feel free to use the provided rake console task. It is defined within the Rakefile.

Credits

Created & Maintained by Weston Ganger - @westonganger