MiniSql

Installation

Add this line to your application's Gemfile:

gem 'mini_sql'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mini_sql

Usage

MiniSql is a very simple, safe and fast SQL executor and mapper for PG.

pg_conn = PG.connect(db_name: 'my_db')
conn = MiniSql::Connection.new(pg_conn)

puts conn.exec('update table set column = 1 where id in (1,2)')
# returns 2 if 2 rows changed

conn.query("select 1 id, 'bob' name") do |user|
  puts user.name # bob
  puts user.id # 1
end

puts conn.query_single('select 1 union select 2')
# [1,2]

Is it fast?

Yes, it is very fast, see benchmarks the bench directory

As a rule it will outperform similar naive PG code while remaining safe.

pg_conn = PG.connect(db_name: 'my_db')

# this is slower, and less safe
pg_conn.async_exec('select * from table') do |r|
  name = r['name']
end

# this is faster and safer
conn = MiniSql::Connection.new(pg_conn)
conn.query('select * from table') do |r|
  name = r.name
end

Safety

In current version of the PG gem you should be careful to clear results. If you do not you risk memory bloat. See: Sam's blog post.

MiniSql is careful to always clear results as soon as possible.

Development

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/SamSaffron/mini_sql. 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.

Code of Conduct

Everyone interacting in the MiniSql project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.