python-sqlparse — python-sqlparse 0.5.4.dev0 documentation (original) (raw)

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 theNew BSD license.

Visit the project page at https://github.com/andialbrecht/sqlparse for further information about this project.

Quick Start¶

$ pip install sqlparse

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 '*' … ]

Contents¶

• Introduction
  • Download & Installation
  • Getting Started
  • Development & Contributing
• sqlparse – Parse SQL statements
  • split()
  • format()
  • parse()
  • Formatting of SQL Statements
• Analyzing the Parsed Statement
  • Base Classes
  • SQL Representing Classes
• User Interfaces
• Extending sqlparse
  • Configuring the Lexer
• Changes in python-sqlparse
  • Upcoming Deprecations
  • Changelog
• License
• Indices and tables

Resources¶

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/