Skip to main content

Makes your SQL readable.

Project description

https://travis-ci.org/paetzke/format-sql.svg?branch=master https://coveralls.io/repos/paetzke/format-sql/badge.svg?branch=master https://badge.fury.io/py/format-sql.svg https://readthedocs.org/projects/format-sql/badge/?version=latest

Makes your SQL readable.

https://paetzke.me/static/images/format-sql.gif

An example:

    sql = """ SELECT country, product, SUM(profit) FROM
sales   left join x on x.id=sales.k GROUP BY country,
product having f > 7 and fk=9 limit 5;    """

Will result in:

sql = """
    SELECT
        country,
        product,
        SUM(profit)
    FROM
        sales
        LEFT JOIN x ON
            x.id = sales.k
    GROUP BY
        country,
        product
    HAVING
        f > 7
        AND fk = 9
    LIMIT 5; """

Install format-sql via pip:

$ pip install format-sql

You can then just call format-sql with files and directories:

$ format-sql -h
usage: format-sql [-h] [--types TYPES] [-r] [--no-semicolon] [--version]
                  [--debug] [--dry-run]
                  paths [paths ...]

positional arguments:
  paths

optional arguments:
  -h, --help       show this help message and exit
  --types TYPES    Only process these given file types.
  -r, --recursive  Process files found in subdirectories.
  --no-semicolon   Try to detect SQL queries with no trailing semicolon.
  --version        show program's version number and exit
  --debug          Print available debug information.
  --dry-run        Print the altered output and do not change the file.

For example:

$ format-sql my-file.py

Or recursively with directory:

$ format-sql -r my-directory/

You can try format-sql online: http://format-sql.de.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

format-sql-0.12.0.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

format_sql-0.12.0-py2.py3-none-any.whl (14.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file format-sql-0.12.0.tar.gz.

File metadata

  • Download URL: format-sql-0.12.0.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for format-sql-0.12.0.tar.gz
Algorithm Hash digest
SHA256 ad968b406402351e04d78cb46947ae783dcda479461913ea4d5a5c4f2ee2d3c2
MD5 6fa35f9e762b326f3d2294eb359cf3c8
BLAKE2b-256 daefc2e47d839377d3f16efdfd56ba417e86c352a876a6b254c56f5177c4dd08

See more details on using hashes here.

File details

Details for the file format_sql-0.12.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for format_sql-0.12.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d6bd6817d02ad3e9b7ec001a205aa2f6fbab2a44585d2e6a978460898bdd7286
MD5 2c646dd8b5b8b3983293a9e1f4d95e7f
BLAKE2b-256 3007ff409992ea5a36238fbf678d62fe12f93bca5ea1a550287deb1c4d7d38ca

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page