Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 2.59 KB

README.md

File metadata and controls

73 lines (55 loc) · 2.59 KB
Raw

SQL Format

This is a CLI adaptation of the SqlFormatter library. Like the basic cli example, but with more options.

Install

  1. Install Box — more info on my blog
  2. Build the PHAR: box build
  3. Move to your path — eg. mv sqlformat.phar /usr/local/bin/sqlformat

Usage

Usage:
  $basename [--no-format] [--no-highlight] [<sql>]
  $basename [--no-comment] [--no-highlight] [<sql>]
  $basename [-c | --compress] [<sql>]
  $basename [-h | --help]

Options:
  --no-highlight  Disable highlight.
  --no-format     Disable auto formatting.
  --no-comment    Remove comment.
  -c --compress   Compress SQL request.
  -h --help       Display this help.

Examples

$ sqlformat "SELECT name FROM users WHERE id > 10"
SELECT
  name
FROM
  users
WHERE
  id > 10

$ cat example.sql
-- foobar request
SELECT foobar FROM barbaz
WHERE count > 20   -- super comment
  AND name = 'john'  -- find john

$ cat example.sql | sqlformat -c
SELECT foobar FROM barbaz WHERE count > 20 AND name = 'john'

Credits

License

The MIT License (MIT)

Copyright (c) 2013 Matthieu Moquet

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.