/usr/share/doc/python-sqlparse-doc/html/_sources/api.txt is in python-sqlparse-doc 0.1.13-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | :mod:`sqlparse` -- Parse SQL statements
=======================================
.. module:: sqlparse
:synopsis: Parse SQL statements.
The :mod:`sqlparse` module provides the following functions on module-level.
.. autofunction:: sqlparse.split
.. autofunction:: sqlparse.format
.. autofunction:: sqlparse.parse
In most cases there's no need to set the `encoding` parameter. If
`encoding` is not set, sqlparse assumes that the given SQL statement
is encoded either in utf-8 or latin-1.
.. _formatting:
Formatting of SQL Statements
----------------------------
The :meth:`~sqlparse.format` function accepts the following keyword arguments.
``keyword_case``
Changes how keywords are formatted. Allowed values are "upper", "lower"
and "capitalize".
``identifier_case``
Changes how identifiers are formatted. Allowed values are "upper", "lower",
and "capitalize".
``strip_comments``
If ``True`` comments are removed from the statements.
``truncate_strings``
If ``truncate_strings`` is a positive integer, string literals longer than
the given value will be truncated.
``truncate_char`` (default: "[...]")
If long string literals are truncated (see above) this value will be append
to the truncated string.
``reindent``
If ``True`` the indentations of the statements are changed.
``indent_tabs``
If ``True`` tabs instead of spaces are used for indentation.
``indent_width``
The width of the indentation, defaults to 2.
``output_format``
If given the output is additionally formatted to be used as a variable
in a programming language. Allowed values are "python" and "php".
|