mirror of
https://github.com/apache/impala.git
synced 2026-01-01 00:00:20 -05:00
49413d9c5b
sqlparse-0.1.19 is the last version of sqlparse that supports Python 2.6. Testing: - Ran all end-to-end tests Change-Id: Ide51ef3ac52d25a96b0fa832e29b6535197d23cb Reviewed-on: http://gerrit.cloudera.org:8080/10354 Reviewed-by: David Knupp <dknupp@cloudera.com> Tested-by: Impala Public Jenkins <impala-public-jenkins@cloudera.com>
58 lines
1.6 KiB
ReStructuredText
58 lines
1.6 KiB
ReStructuredText
: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".
|