https://github.com/andialbrecht/sqlparse

A non-validating SQL parser module for Python
https://github.com/andialbrecht/sqlparse

Last synced: 3 days ago
JSON representation

A non-validating SQL parser module for Python

• Host: GitHub
• URL: https://github.com/andialbrecht/sqlparse
• Owner: andialbrecht
• License: bsd-3-clause
• Created: 2012-04-18T19:33:21.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-08-31T12:39:52.000Z (3 months ago)
• Last Synced: 2024-10-29T15:54:50.680Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 1.42 MB
• Stars: 3,738
• Watchers: 94
• Forks: 698
• Open Issues: 245
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome - andialbrecht/sqlparse - A non-validating SQL parser module for Python (Python)
• awesome-starts - andialbrecht/sqlparse - A non-validating SQL parser module for Python (Python)
• starred-awesome - sqlparse - A non-validating SQL parser module for Python (Python)
• awesome-hacking-lists - andialbrecht/sqlparse - A non-validating SQL parser module for Python (Python)

README

        
python-sqlparse - Parse SQL statements

======================================

|buildstatus|_

|coverage|_

|docs|_

|packageversion|_

.. 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.8+ and released under the terms of the

`New BSD license `_.

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

   [, , >>

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://github.com/andialbrecht/sqlparse/actions/workflows/python-app.yml/badge.svg

.. _buildstatus: https://github.com/andialbrecht/sqlparse/actions/workflows/python-app.yml

.. |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

.. |packageversion| image:: https://img.shields.io/pypi/v/sqlparse?color=%2334D058&label=pypi%20package

.. _packageversion: https://pypi.org/project/sqlparse