1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
User Interfaces
===============
``sqlformat``
The ``sqlformat`` command line script is distributed with the module.
Run :command:`sqlformat --help` to list available options and for usage
hints.
Pre-commit Hook
^^^^^^^^^^^^^^^^
``sqlparse`` can be integrated with `pre-commit <https://pre-commit.com/>`_
to automatically format SQL files before committing them to version control.
To use it, add the following to your ``.pre-commit-config.yaml``:
.. code-block:: yaml
repos:
- repo: https://github.com/andialbrecht/sqlparse
rev: 0.5.4 # Replace with the version you want to use
hooks:
- id: sqlformat
The hook will format your SQL files with basic indentation (``--reindent``) by default.
To customize formatting options, override the ``args`` parameter:
.. code-block:: yaml
repos:
- repo: https://github.com/andialbrecht/sqlparse
rev: 0.5.4
hooks:
- id: sqlformat
args: [--in-place, --reindent, --keywords, upper, --identifiers, lower]
.. important::
When overriding ``args``, you **must include** ``--in-place`` as the first
argument, otherwise the hook will not modify your files.
Common formatting options include:
* ``--in-place``: Required - modify files in-place (always include this!)
* ``--reindent`` or ``-r``: Reindent statements
* ``--keywords upper`` or ``-k upper``: Convert keywords to uppercase
* ``--identifiers lower`` or ``-i lower``: Convert identifiers to lowercase
* ``--indent_width 4``: Set indentation width to 4 spaces
* ``--strip-comments``: Remove comments from SQL
Run ``sqlformat --help`` for a complete list of formatting options.
After adding the configuration, install the pre-commit hooks:
.. code-block:: bash
pre-commit install
The hook will now run automatically before each commit. You can also run
it manually on all files:
.. code-block:: bash
pre-commit run sqlformat --all-files
``sqlformat.appspot.com``
An example `Google App Engine <https://cloud.google.com/appengine/>`_
application that exposes the formatting features using a web front-end.
See https://sqlformat.org/ for details.
The source for this application is available from a source code check out
of the :mod:`sqlparse` module (see :file:`extras/appengine`).
|
