RawSqlBuilder

This gem is to ease the pain of mass creating and updating object attributes in your database. It will adapt to different tables, columns, and column-types. Dramatically speeds up the creating or updating of large groups of objects.

Loops through all objects passed and will build/execute raw SQL mass create or update queries.

This was made for use with Postgres. I haven't tested this with any other database type.

Installation

Add this line to your application's Gemfile:

gem 'raw_sql_builder'

And then execute:

$ bundle

Or install it yourself as:

$ gem install raw_sql_builder

Usage

Pass through a collection or array of objects to one of the methods below. Will also accept a single object.

• Creating:

  • Use the method 'new' to create new objects without saving them to the database.
  • Once all objects have attributes assigned, pass them through to mass_create or mass_create_or_update to be created.

• Updating:

  • Assign attributes to objects, I prefer using the method 'assign_attributes.'
  • Once all attributes are assigned for all objects pass them through to mass_update or mass_create_or_update for updating.

• Methods:

  • mass_create(objects)
    • This will only do a creation query and include objects that return true on 'new_record?'
    • Any existing objects that have updated attributes and were passed through will be ignored.
    • Example:

      users = []
      users << User.new(first_name: 'Saige', last_name: 'Fuentes', active: true)
      users << User.new(first_name: 'Bowen', last_name: 'Higgins', active: false)
      users << User.new(first_name: 'Leighton', last_name: 'Kramer', active: false)
      RawSqlBuilder.mass_create(users)

  • mass_update(objects)
    • Will only update existing objects and ignore new objects.
    • Example:

      users = User.where.not(active: true)
      users.each { |u| u.assign_attributes(active: true) }
      RawSqlBuilder.mass_update(users)

  • mass_create_or_update(objects)
    • Will separate new objects and updated objects, then run respective queries.
    • Example:

      users = []
      users << User.new(first_name: 'Kylan', last_name: 'Gentry', active: true)
      users << User.new(first_name: 'Franklin', last_name: 'Sierra', active: true)
      user = User.find_by(first_name: 'Bowen', last_name: 'Higgins')
      user.first_name = 'Bow'
      users << user
      RawSqlBuilder.mass_create_or_update(users)

  • execute(query)
    • Will execute the query you pass through.
    • Example:

      query = "UPDATE users SET active = 'true' WHERE users.id = 3;"
      RawSqlBuilder.execute(query)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/MatTarantini/raw_sql_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.