A non-validating SQL parser module for Python (LADI project)
Go to file
Andreas Albrecht 0d6684baba Update version number for release. 2020-02-29 13:56:13 +01:00
docs add comma_first option for docs 2020-02-02 21:26:26 +01:00
examples Refactored extract column defs example (fixes #439, #411, #526). 2020-01-06 21:33:44 +01:00
sqlparse Update version number for release. 2020-02-29 13:56:13 +01:00
tests [grouping] group_as() no longer groups AS CTE 2020-02-02 21:21:09 +01:00
.editorconfig Update editorconfig 2016-12-22 22:32:31 -07:00
.gitignore Add pytest_cache to gitignore. 2018-07-28 09:32:35 +02:00
.travis.yml CI: Remove obsolete comment. 2020-01-16 09:24:01 +01:00
AUTHORS Update changelog and authors. 2020-02-02 21:23:49 +01:00
CHANGELOG Update version number for release. 2020-02-29 13:56:13 +01:00
LICENSE Add or Update copyright year to files 2016-06-04 11:08:20 -07:00
MANIFEST.in Update manifest files 2016-12-22 23:10:15 -07:00
Makefile Switch to twine, it's the modern world. 2019-03-11 19:40:44 +01:00
README.rst Update README. 2019-06-25 15:36:59 +02:00
TODO Remove useless items from TODO. 2015-10-26 20:37:06 +01:00
setup.cfg Include license file in the generated wheel package 2017-10-28 16:22:25 -07:00
setup.py Add Python 3.8 to list of classifiers. 2020-01-08 16:29:50 +01:00
tox.ini Add Python 3.8-dev to Travis setup. 2018-07-30 12:09:12 +02:00

README.rst

python-sqlparse - Parse SQL statements
======================================

|buildstatus|_
|coverage|_

.. 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 2.7 and Python 3 (>= 3.4)
and released under the terms of the `New BSD license
<https://opensource.org/licenses/BSD-3-Clause>`_.

.. note::

   Support for Python<3.4 (including 2.x) will be dropped soon.

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://coveralls.io/repos/andialbrecht/sqlparse/badge.svg?branch=master&service=github
.. _coverage: https://coveralls.io/github/andialbrecht/sqlparse?branch=master