76 lines
2.0 KiB
ReStructuredText
76 lines
2.0 KiB
ReStructuredText
python-sqlparse - Parse SQL statements
|
|
======================================
|
|
|
|
|buildstatus|_
|
|
|coverage|_
|
|
|docs|_
|
|
|
|
.. docincludebegin
|
|
|
|
sqlparse is a non-validating SQL parser for Python.
|
|
It provides support for parsing, splitting and formatting SQL statements.
|
|
|
|
The module is compatible with Python 3.5+ and released under the terms of the
|
|
`New BSD license <https://opensource.org/licenses/BSD-3-Clause>`_.
|
|
|
|
Visit the project page at https://github.com/andialbrecht/sqlparse for
|
|
further information about this project.
|
|
|
|
|
|
Quick Start
|
|
-----------
|
|
|
|
.. code-block:: sh
|
|
|
|
$ pip install sqlparse
|
|
|
|
.. code-block:: python
|
|
|
|
>>> import sqlparse
|
|
|
|
>>> # Split a string containing two SQL statements:
|
|
>>> raw = 'select * from foo; select * from bar;'
|
|
>>> statements = sqlparse.split(raw)
|
|
>>> statements
|
|
['select * from foo;', 'select * from bar;']
|
|
|
|
>>> # Format the first statement and print it out:
|
|
>>> first = statements[0]
|
|
>>> print(sqlparse.format(first, reindent=True, keyword_case='upper'))
|
|
SELECT *
|
|
FROM foo;
|
|
|
|
>>> # Parsing a SQL statement:
|
|
>>> parsed = sqlparse.parse('select * from foo')[0]
|
|
>>> parsed.tokens
|
|
[<DML 'select' at 0x7f22c5e15368>, <Whitespace ' ' at 0x7f22c5e153b0>, <Wildcard '*' … ]
|
|
>>>
|
|
|
|
Links
|
|
-----
|
|
|
|
Project page
|
|
https://github.com/andialbrecht/sqlparse
|
|
|
|
Bug tracker
|
|
https://github.com/andialbrecht/sqlparse/issues
|
|
|
|
Documentation
|
|
https://sqlparse.readthedocs.io/
|
|
|
|
Online Demo
|
|
https://sqlformat.org/
|
|
|
|
|
|
sqlparse is licensed under the BSD license.
|
|
|
|
Parts of the code are based on pygments written by Georg Brandl and others.
|
|
pygments-Homepage: http://pygments.org/
|
|
|
|
.. |buildstatus| image:: https://secure.travis-ci.org/andialbrecht/sqlparse.png?branch=master
|
|
.. _buildstatus: https://travis-ci.org/#!/andialbrecht/sqlparse
|
|
.. |coverage| image:: https://codecov.io/gh/andialbrecht/sqlparse/branch/master/graph/badge.svg
|
|
.. _coverage: https://codecov.io/gh/andialbrecht/sqlparse
|
|
.. |docs| image:: https://readthedocs.org/projects/sqlparse/badge/?version=latest
|
|
.. _docs: https://sqlparse.readthedocs.io/en/latest/?badge=latest
|