Niceql

This is a small, nice, simple and dependentless solution for SQL prettifiyng for Ruby. It can be used in an irb console without any dependencies ( run ./console from bin and look for examples ).

Any reasonable suggestions on formatting/coloring are welcome

Before/After

SQL prettifier:

PG errors prettifier

before:

after:

Installation

Add this line to your application's Gemfile:

gem 'niceql'

And then execute:

$ bundle

Or install it yourself as:

$ gem install niceql

Configuration

Niceql.configure do |c|
  # Setting pg_adapter_with_nicesql to true will force formatting SQL queries
  # before executing them, this will lead to better SQL-query debugging and much more clearer error messages 
  # if you are using Postgresql as a data source.  
  # You can adjust pg_adapter in prooduction but do it at your own risk!
  # If you need to debug SQL queries in production use exec_niceql
  # default: false
  # uncomment next string to enable in development
  # c.pg_adapter_with_nicesql = Rails.env.development?

  # spaces count for one indentation
  c.indentation_base = 2

  # setting open_bracket_is_newliner to true will start opening brackets '(' with nested subqueries from new line 
  # i.e. SELECT * FROM ( SELECT * FROM tags ) tags; will transform to: 
  # SELECT * 
  # FROM 
  # ( 
 #    SELECT * FROM tags 
 #  ) tags; 
 # when open_bracket_is_newliner is false: 
  # SELECT * 
  # FROM ( 
 #   SELECT * FROM tags 
 # ) tags; 
 # default: false
  c.open_bracket_is_newliner = false
end

Usage

With ActiveRecord

  # puts colorized ( or not if you are willing so ) to_niceql ( you need to call puts otherwise to_niceql looks ugly  )
  Model.scope.niceql

  # only formatting without colorization, you can run output of to_niceql as a SQL query in connection.execute  
  Model.scope.to_niceql

  # prettify PG errors if scope runs with any 
  Model.scope_with_err.exec_niceql 

Without ActiveRecord

   puts Niceql::Prettifier.prettify_sql("SELECT * FROM ( VALUES(1), (2) ) AS tmp")

   # see colors in irb %) 
   #=>  SELECT * 
   #=>  FROM ( VALUES(1), (2) ) AS tmp

   # rails combines err with query, so don't forget to do it yourself 
   # to get real nice result you should executeprettified version (i.e. execute( prettified_sql ) !) of query on your DB! 
   # otherwise you will not get such a nice output

   puts Niceql::Prettifier.prettify_pg_err(<<-ERR )
ERROR:  VALUES in FROM must have an alias
LINE 2:  FROM ( VALUES(1), (2) )
              ^
HINT:  For example, FROM (VALUES ...) [AS] foo.
 SELECT err 
 FROM ( VALUES(1), (2) )
 ORDER BY 1
ERR


# ERROR:  VALUES in FROM must have an alias
# LINE 2:  FROM ( VALUES(1), (2) )
#               ^
#     HINT:  For example, FROM (VALUES ...) [AS] foo.
#     SELECT err
#     FROM ( VALUES(1), (2) )
#          ^
#     ORDER BY 1

Customizing colors

If your console support more colors or different schemes, or if you prefer different colorization, then you can override ColorizeString methods. Current colors are selected with dark and white console themes in mind, so a niceql colorization works good for dark, and good enough for white.

Limitations

Right now gem detects only uppercased form of verbs with simple indentation and parsing options.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/niceql.

License

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