| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175 |
- Metadata-Version: 2.5
- Name: sqlparse
- Version: 0.6.0
- Summary: A non-validating SQL parser.
- Project-URL: Home, https://github.com/andialbrecht/sqlparse
- Project-URL: Documentation, https://sqlparse.readthedocs.io/
- Project-URL: Release Notes, https://sqlparse.readthedocs.io/en/latest/changes.html
- Project-URL: Source, https://github.com/andialbrecht/sqlparse
- Project-URL: Tracker, https://github.com/andialbrecht/sqlparse/issues
- Author-email: Andi Albrecht <albrecht.andi@gmail.com>
- License-File: AUTHORS
- License-File: LICENSE
- Classifier: Development Status :: 5 - Production/Stable
- Classifier: Intended Audience :: Developers
- Classifier: License :: OSI Approved :: BSD License
- Classifier: Operating System :: OS Independent
- Classifier: Programming Language :: Python
- Classifier: Programming Language :: Python :: 3
- Classifier: Programming Language :: Python :: 3 :: Only
- Classifier: Programming Language :: Python :: 3.10
- Classifier: Programming Language :: Python :: 3.11
- Classifier: Programming Language :: Python :: 3.12
- Classifier: Programming Language :: Python :: 3.13
- Classifier: Programming Language :: Python :: 3.14
- Classifier: Programming Language :: Python :: Implementation :: CPython
- Classifier: Programming Language :: Python :: Implementation :: PyPy
- Classifier: Topic :: Database
- Classifier: Topic :: Software Development
- Requires-Python: >=3.10
- Provides-Extra: dev
- Requires-Dist: build; extra == 'dev'
- Provides-Extra: doc
- Requires-Dist: furo; extra == 'doc'
- Requires-Dist: sphinx; extra == 'doc'
- Description-Content-Type: text/markdown
- # sqlparse
- [](https://github.com/andialbrecht/sqlparse/actions/workflows/python-app.yml)
- [](https://codecov.io/gh/andialbrecht/sqlparse)
- [](https://sqlparse.readthedocs.io/en/latest/)
- [](https://pypi.org/project/sqlparse)
- [](https://pypi.org/project/sqlparse)
- [](https://opensource.org/licenses/BSD-3-Clause)
- A non-validating SQL parser for Python. Split scripts into statements, format
- them, and walk their token tree.
- sqlparse tokenizes SQL text and groups the parts it recognizes into a tree of
- statements, clauses, identifiers and expressions. It accepts any input without
- validating it, and makes no assumptions about a particular SQL dialect, so
- vendor extensions and templated SQL parse too. It is a building block for
- formatters, linters, editors and query analysis tools.
- Licensed under the
- [New BSD license](https://opensource.org/licenses/BSD-3-Clause).
- ## Install
- ```bash
- pip install sqlparse
- ```
- ## Usage
- Three module-level functions cover most needs: `split()`, `format()` and
- `parse()`.
- ### Split a script into statements
- ```python
- import sqlparse
- sqlparse.split("select * from foo; select * from bar;")
- # ['select * from foo;', 'select * from bar;']
- ```
- ### Format a statement
- ```python
- print(sqlparse.format("select id,name from users where active=1",
- reindent=True, keyword_case="upper"))
- ```
- ```sql
- SELECT id,
- name
- FROM users
- WHERE active=1
- ```
- `format()` accepts the same options as the command line, among them
- `reindent`, `keyword_case`, `strip_comments` and `indent_width`.
- ### Parse and inspect a statement
- ```python
- statement = sqlparse.parse("select id, name from users where active = 1")[0]
- print(statement.get_type())
- for token in statement.tokens:
- if not token.is_whitespace:
- print(f"{token.ttype or type(token).__name__!s:20} {token!s}")
- ```
- ```
- SELECT
- Token.Keyword.DML select
- IdentifierList id, name
- Token.Keyword from
- Identifier users
- Where where active = 1
- ```
- Tokens with a `ttype` are leaves. The others are groups you can descend into,
- which is how nested constructs like subqueries and `CASE` expressions are
- represented. See
- [Analyzing SQL statements](https://sqlparse.readthedocs.io/en/latest/analyzing.html)
- for the traversal API.
- ## Command line
- Installing sqlparse also provides the `sqlformat` command. It reads from stdin
- when the filename is `-`, writes to stdout by default, and rewrites files in
- place with `--in-place`:
- ```bash
- sqlformat --reindent --keywords upper query.sql
- ```
- Run `sqlformat --help` for all formatting options.
- ## Pre-commit hook
- Format SQL files on commit with [pre-commit](https://pre-commit.com/):
- ```yaml
- repos:
- - repo: https://github.com/andialbrecht/sqlparse
- rev: 0.5.5 # use the latest release
- hooks:
- - id: sqlformat
- args: [--in-place, --reindent, --keywords, upper]
- ```
- The hook defaults to `--in-place --reindent`. When overriding `args`, keep
- `--in-place`, or the hook writes to stdout and leaves your files unchanged.
- ## Links
- | | |
- |---|---|
- | Documentation | <https://sqlparse.readthedocs.io/> |
- | Release notes | <https://sqlparse.readthedocs.io/en/latest/changes.html> |
- | Issues | <https://github.com/andialbrecht/sqlparse/issues> |
- | Discussions | <https://github.com/andialbrecht/sqlparse/discussions> |
- | Online demo | <https://sqlformat.org/> |
- ## Contributing
- Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) to get
- started.
- sqlparse is maintained in spare time, so it can take a while before an issue or
- pull request gets a reply. Thanks for your patience. A pull request that comes
- with tests for the behavior it changes is usually the quickest to review.
- For security issues, please follow [SECURITY.md](SECURITY.md) rather than
- opening a public issue.
- ## License
- sqlparse is licensed under the New BSD license; see [LICENSE](LICENSE) for the
- full text. Parts of the code are based on [Pygments](https://pygments.org/),
- written by Georg Brandl and others.
|