sqlite_ext

SqliteExt

Provides a convenient way of writing functions in Ruby that can be called from within SQLite queries through the sqlite3 gem.

Although it is already possible to write ruby code for functions that can be called from within SQL queries using SQLite via the sqlite3 gem, that has some limitations which this gem seeks to address.

First, when utilizing SQLite3::Database#create_function, the added function only exists for the current instance of SQLite3::Database. If that instance is being accessed through a connection pool (e.g. via ActiveRecord) then there it is hard to ensure that the functions are created on each new instance before the SQL that needs them to exist is executed.

Secondly, the Ruby code needed to define a trivial SQL-callable function using SQLite3::Database#create_function is fairly verbose, and it would be nice to have a simpler API.

Installation

Add this line to your application's Gemfile:

gem 'sqlite_ext'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sqlite_ext

Usage

SqliteExt.register_function(
  'sign',
  ->(x){ x <=> 0 }
)

SQLite3::Database.new 'data.db' do |db|
  puts db.execute(<<-EOS).first
    SELECT
        sign(2)
      , sign(-3)
      , sign(0)
      , COALESCE(sign(NULL), 'n/a')
  EOS
end

# == Output ==
# 1
# -1
# 0
# n/a

SqliteExt.register_ruby_math

SQLite3::Database.new 'data.db' do |db|
  puts db.execute(<<-EOS).first
    SELECT
        sqrt(25)
      , cos(asin(3.0/5.0))
      , COALESCE(sqrt(NULL), 'n/a')
  EOS
end

# == Output ==
# 5.0
# 0.8
# n/a

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/stevecj/sqlite_ext. 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.