Skip to content
Rails engine to generate instant reports from adhoc SQL query.
Branch: master
Clone or download
Latest commit 88f67e4 May 15, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin bundle exec rails plugin new adhoq Oct 3, 2014
.rspec Prepare rspec rails Oct 3, 2014
.tachikoma.yml tachikomized Oct 28, 2014
.travis.yml remove old test matrix settings Apr 27, 2019
ChangeLog bump v1.0.0 Apr 19, 2019
LICENSE.txt Update README Oct 7, 2014 bump v1.0.0 Apr 19, 2019
adhoq.gemspec move sqlie3 deps to adhoq.gemspec Apr 27, 2019

Adhoq Build Status Code Climate Test Coverage

Rails engine to generate instant reports from adhoc SQL query.



  • Export ad-hoc SQL reports in some formats:
    • .csv
    • .json
    • .xlsx
  • Persist generated report as local file or in AWS S3
  • over Rails 5.1.X
  • Nice administration console with rails engine

Future planning

  • Label data substitution


Add this line to your application's Gemfile:

gem 'adhoq'

And then execute:

$ bundle

Or install it yourself as:

$ gem install adhoq


As Rails engine

Install migrations

$ bundle exec rake adhoq:install:migrations
$ bundle exec rake db:migrate

Mount it in config/routes.rb

Rails.application.routes.draw do
  root  to: 'hi#show'

  mount Adhoq::Engine => "/adhoq"

Edit initialization file in config/initializers/adhoq.rb

Adhoq.configure do |config|
  # if not set, use :on_the_fly.(default)       = [:local_file, Rails.root + './path/to/store/report/files']
  config.authorization = ->(controller) { controller.signed_in? }

See configuration example in dummy app.

Then restart server and try it out.

As Plain old library (application export helper)

Adhoq also provides report generation from SQL string, not from mounted rails engine.

execution =
  'SELECT "hello" AS name ,"English greeting message" AS description'

Adhoq::Reporter.generate(execution) #=> report data

Persistence is also available without engine via Adhoq::Storage::SomeClass#store. Below is example that generating report and persist to in Rails application report method.

execution =
  'SELECT "hello" AS name ,"English greeting message" AS description'

storage   =
  aws_access_key_id: 'key_id',
  aws_secret_access_key: 'access_key'

# generate report and store it to S3, returns `key` to get report data
key ='.xlsx') { Adhoq::Reporter.generate(execution) }

storage.get(key) #=> report data


  1. Fork it ( )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request
You can’t perform that action at this time.