Edit on GitHub

SQLGlot logo

SQLGlot is a no-dependency SQL parser, transpiler, optimizer, and engine. It can be used to format SQL or translate between over 30 dialects like DuckDB, Presto / Trino, Spark / Databricks, Snowflake, and BigQuery. It aims to read a wide variety of SQL inputs and output syntactically and semantically correct SQL in the targeted dialects.

It is a very comprehensive generic SQL parser with a robust test suite. It is also quite performant, while being written purely in Python.

You can easily customize the parser, analyze queries, traverse expression trees, and programmatically build SQL.

SQLGlot can detect a variety of syntax errors, such as unbalanced parentheses, incorrect usage of reserved keywords, and so on. These errors are highlighted and dialect incompatibilities can warn or raise depending on configurations.

Learn more about SQLGlot in the API documentation and the expression tree primer.

Contributions are very welcome in SQLGlot; read the contribution guide and the onboarding document to get started!

Table of Contents

Install

From PyPI:

# Pure python version
pip3 install sqlglot

# C extensions compiled with mypyc (Python 3.10+)
# prebuilt wheel if available for your platform, otherwise builds from source
pip3 install "sqlglot[c]"

On Python 3.9, sqlglot[c] installs the pure Python version.

Or with a local checkout:

# Optionally prefix with UV=1 to use uv for the installation
make install

Requirements for development (optional):

# Optionally prefix with UV=1 to use uv for the installation
make install-dev

Versioning

Given a version number MAJOR.MINOR.PATCH:

  • PATCH is incremented for backwards-compatible changes.
  • MINOR is incremented for backwards-incompatible changes.
  • MAJOR is incremented for significant backwards-incompatible changes.

Get in Touch

We'd love to hear from you. Join our community Slack channel!

FAQ

I tried to parse SQL that should be valid, but it failed. Why?

You probably didn't specify the source dialect. Without it, parse_one assumes the "SQLGlot dialect", which is designed to be a superset of all supported dialects. Always pass the dialect when you know it, e.g. parse_one(sql, dialect="spark"). If parsing still fails, please file an issue.

The generated SQL is not in the correct dialect!

The target dialect must also be specified explicitly. For example, to transpile a query from Spark SQL to DuckDB, do parse_one(sql, dialect="spark").sql(dialect="duckdb"), or transpile(sql, read="spark", write="duckdb").

Why does SQLGlot parse my invalid SQL without complaining?

The parser is intentionally lenient, so it can accept queries that a real engine would reject. SQLGlot is a transpiler, not a validator. A query that parses successfully may still fail at execution time.

Why doesn't the output preserve my formatting, casing or quoting?

SQLGlot parses queries into an AST and generates SQL back from it, so it preserves the meaning of a query rather than its exact text. Cosmetic details can change in the process. Use pretty=True for formatted output and identify=True to quote all identifiers. Comments are preserved on a best-effort basis.

How can I make parsing faster?

Install the version compiled with mypyc: pip3 install "sqlglot[c]". It is roughly 3-5x faster than the pure Python version (see Benchmarks).

My dialect isn't supported. What are my options?

You can subclass an existing dialect (Custom Dialects), or ship one as a separate package (Creating a Dialect Plugin). Keep in mind that subclassing may not work properly with sqlglot[c] installed, so custom dialects may require the pure Python version.

Examples

Formatting and Transpiling

Easily translate from one dialect to another. For example, date/time functions vary between dialects and can be hard to deal with:

import sqlglot
sqlglot.transpile("SELECT EPOCH_MS(1618088028295)", read="duckdb", write="hive")[0]
'SELECT FROM_UNIXTIME(1618088028295 / POW(10, 3))'

SQLGlot can even translate custom time formats:

import sqlglot
sqlglot.transpile("SELECT STRFTIME(x, '%y-%-m-%S')", read="duckdb", write="hive")[0]
"SELECT DATE_FORMAT(x, 'yy-M-ss')"

Identifier delimiters and data types can be translated as well:

import sqlglot

# Spark SQL requires backticks (`) for delimited identifiers and uses `FLOAT` over `REAL`
sql = """WITH baz AS (SELECT a, c FROM foo WHERE a = 1) SELECT f.a, b.b, baz.c, CAST("b"."a" AS REAL) d FROM foo f JOIN bar b ON f.a = b.a LEFT JOIN baz ON f.a = baz.a"""

# Translates the query into Spark SQL, formats it, and delimits all of its identifiers
print(sqlglot.transpile(sql, write="spark", identify=True, pretty=True)[0])
WITH `baz` AS (
  SELECT
    `a`,
    `c`
  FROM `foo`
  WHERE
    `a` = 1
)
SELECT
  `f`.`a`,
  `b`.`b`,
  `baz`.`c`,
  CAST(`b`.`a` AS FLOAT) AS `d`
FROM `foo` AS `f`
JOIN `bar` AS `b`
  ON `f`.`a` = `b`.`a`
LEFT JOIN `baz`
  ON `f`.`a` = `baz`.`a`

Comments are also preserved on a best-effort basis:

sql = """
/* multi
   line
   comment
*/
SELECT
  tbl.cola /* comment 1 */ + tbl.colb /* comment 2 */,
  CAST(x AS SIGNED), # comment 3
  y               -- comment 4
FROM
  bar /* comment 5 */,
  tbl #          comment 6
"""

# Note: MySQL-specific comments (`#`) are converted into standard syntax
print(sqlglot.transpile(sql, read='mysql', pretty=True)[0])
/* multi
   line
   comment
*/
SELECT
  tbl.cola /* comment 1 */ + tbl.colb /* comment 2 */,
  CAST(x AS SIGNED), /* comment 3 */
  y /* comment 4 */
FROM bar /* comment 5 */, tbl /*          comment 6 */

Metadata

You can explore SQL with expression helpers to do things like find columns and tables in a query:

from sqlglot import parse_one, exp

# print all column references (a and b)
for column in parse_one("SELECT a, b + 1 AS c FROM d").find_all(exp.Column):
    print(column.alias_or_name)

# find all projections in select statements (a and c)
for select in parse_one("SELECT a, b + 1 AS c FROM d").find_all(exp.Select):
    for projection in select.expressions:
        print(projection.alias_or_name)

# find all tables (x, y, z)
for table in parse_one("SELECT * FROM x JOIN y JOIN z").find_all(exp.Table):
    print(table.name)

Read the ast primer to learn more about SQLGlot's internals.

Parser Errors

When the parser detects an error in the syntax, it raises a ParseError:

import sqlglot
sqlglot.transpile("SELECT foo FROM (SELECT baz FROM t")
sqlglot.errors.ParseError: Expecting ). Line 1, Col: 34.
  SELECT foo FROM (SELECT baz FROM t
                                   ~

Structured syntax errors are accessible for programmatic use:

import sqlglot.errors
try:
    sqlglot.transpile("SELECT foo FROM (SELECT baz FROM t")
except sqlglot.errors.ParseError as e:
    print(e.errors)
[{
  'description': 'Expecting )',
  'line': 1,
  'col': 34,
  'start_context': 'SELECT foo FROM (SELECT baz FROM ',
  'highlight': 't',
  'end_context': '',
  'into_expression': None
}]

Unsupported Errors

It may not be possible to translate some queries between certain dialects. For these cases, SQLGlot may emit a warning and will proceed to do a best-effort translation by default:

import sqlglot
sqlglot.transpile("SELECT APPROX_DISTINCT(a, 0.1) FROM foo", read="presto", write="hive")
Argument 'accuracy' is not supported for expression 'ApproxDistinct' when targeting Hive.
'SELECT APPROX_COUNT_DISTINCT(a) FROM foo'

This behavior can be changed by setting the unsupported_level attribute. For example, we can set it to either RAISE or IMMEDIATE to ensure an exception is raised instead:

import sqlglot
sqlglot.transpile("SELECT APPROX_DISTINCT(a, 0.1) FROM foo", read="presto", write="hive", unsupported_level=sqlglot.ErrorLevel.RAISE)
sqlglot.errors.UnsupportedError: Argument 'accuracy' is not supported for expression 'ApproxDistinct' when targeting Hive.

Some queries need additional information to be transpiled accurately, such as the schemas of the referenced tables. This is because certain transformations are type-sensitive and depend on type inference. The qualify and annotate_types optimizer rules can provide this information, but they are not used by default because they add overhead and complexity.

Transpilation is a hard problem, so SQLGlot solves it incrementally. Some dialect pairs may lack support for certain inputs, but coverage improves over time. We highly appreciate well-documented and tested issues or PRs, so feel free to reach out if you need guidance!

Build and Modify SQL

SQLGlot supports incrementally building SQL expressions:

from sqlglot import select, condition

where = condition("x=1").and_("y=1")
select("*").from_("y").where(where).sql()
'SELECT * FROM y WHERE x = 1 AND y = 1'

It's possible to modify a parsed tree:

from sqlglot import parse_one
parse_one("SELECT x FROM y").from_("z").sql()
'SELECT x FROM z'

Parsed expressions can also be transformed recursively by applying a mapping function to each node in the tree:

from sqlglot import exp, parse_one

expression_tree = parse_one("SELECT a FROM x")

def transformer(node):
    if isinstance(node, exp.Column) and node.name == "a":
        return parse_one("FUN(a)")
    return node

transformed_tree = expression_tree.transform(transformer)
transformed_tree.sql()
'SELECT FUN(a) FROM x'

SQL Optimizer

SQLGlot can rewrite queries into an "optimized" form. It performs a variety of techniques to create a new canonical AST. This AST can be used to standardize queries or provide the foundations for implementing an actual engine. For example:

import sqlglot
from sqlglot.optimizer import optimize

print(
    optimize(
        sqlglot.parse_one("""
            SELECT A OR (B OR (C AND D))
            FROM x
            WHERE Z = date '2021-01-01' + INTERVAL '1' month OR 1 = 0
        """),
        schema={"x": {"A": "INT", "B": "INT", "C": "INT", "D": "INT", "Z": "STRING"}}
    ).sql(pretty=True)
)
SELECT
  (
    "x"."a" <> 0 OR "x"."b" <> 0 OR "x"."c" <> 0
  )
  AND (
    "x"."a" <> 0 OR "x"."b" <> 0 OR "x"."d" <> 0
  ) AS "_col_0"
FROM "x" AS "x"
WHERE
  CAST("x"."z" AS DATE) = CAST('2021-02-01' AS DATE)

AST Introspection

You can see the AST version of the parsed SQL by calling repr:

from sqlglot import parse_one
print(repr(parse_one("SELECT a + 1 AS z")))
Select(
  expressions=[
    Alias(
      this=Add(
        this=Column(
          this=Identifier(this=a, quoted=False)),
        expression=Literal(this=1, is_string=False)),
      alias=Identifier(this=z, quoted=False))])

AST Diff

SQLGlot can calculate the semantic difference between two expressions and output changes in a form of a sequence of actions needed to transform a source expression into a target one:

from sqlglot import diff, parse_one
diff(parse_one("SELECT a + b, c, d"), parse_one("SELECT c, a - b, d"))
[
  Remove(expression=Add(
    this=Column(
      this=Identifier(this=a, quoted=False)),
    expression=Column(
      this=Identifier(this=b, quoted=False)))),
  Insert(expression=Sub(
    this=Column(
      this=Identifier(this=a, quoted=False)),
    expression=Column(
      this=Identifier(this=b, quoted=False)))),
  Keep(
    source=Column(this=Identifier(this=a, quoted=False)),
    target=Column(this=Identifier(this=a, quoted=False))),
  ...
]

The sequence consists of Insert, Remove, Move, Update and Keep actions. The order of the matched (Keep / Move) actions may vary between runs.

See also: Semantic Diff for SQL.

Custom Dialects

Dialects can be added by subclassing Dialect:

from sqlglot import exp
from sqlglot.dialects.dialect import Dialect
from sqlglot.generator import Generator
from sqlglot.tokens import Tokenizer, TokenType


class Custom(Dialect):
    class Tokenizer(Tokenizer):
        QUOTES = ["'", '"']
        IDENTIFIERS = ["`"]

        KEYWORDS = {
            **Tokenizer.KEYWORDS,
            "INT64": TokenType.BIGINT,
            "FLOAT64": TokenType.DOUBLE,
        }

    class Generator(Generator):
        TRANSFORMS = {exp.Array: lambda self, e: f"[{self.expressions(e)}]"}

        TYPE_MAPPING = {
            exp.DataType.Type.TINYINT: "INT64",
            exp.DataType.Type.SMALLINT: "INT64",
            exp.DataType.Type.INT: "INT64",
            exp.DataType.Type.BIGINT: "INT64",
            exp.DataType.Type.DECIMAL: "NUMERIC",
            exp.DataType.Type.FLOAT: "FLOAT64",
            exp.DataType.Type.DOUBLE: "FLOAT64",
            exp.DataType.Type.BOOLEAN: "BOOL",
            exp.DataType.Type.TEXT: "STRING",
        }

print(Dialect["custom"])
<class '__main__.Custom'>

Note: when sqlglot[c] is installed, subclassing may not work properly, because runtime subclassing of the mypyc-compiled classes has been disabled for performance reasons. Use the pure Python version if you need custom dialects.

SQL Execution

SQLGlot is able to interpret SQL queries, where the tables are represented as Python dictionaries. The engine is not supposed to be fast, but it can be useful for unit testing and running SQL natively across Python objects. Additionally, the foundation can be easily integrated with fast compute kernels, such as Arrow and Pandas.

The example below showcases the execution of a query that involves aggregations and joins:

from sqlglot.executor import execute

tables = {
    "sushi": [
        {"id": 1, "price": 1.0},
        {"id": 2, "price": 2.0},
        {"id": 3, "price": 3.0},
    ],
    "order_items": [
        {"sushi_id": 1, "order_id": 1},
        {"sushi_id": 1, "order_id": 1},
        {"sushi_id": 2, "order_id": 1},
        {"sushi_id": 3, "order_id": 2},
    ],
    "orders": [
        {"id": 1, "user_id": 1},
        {"id": 2, "user_id": 2},
    ],
}

execute(
    """
    SELECT
      o.user_id,
      SUM(s.price) AS price
    FROM orders o
    JOIN order_items i
      ON o.id = i.order_id
    JOIN sushi s
      ON i.sushi_id = s.id
    GROUP BY o.user_id
    """,
    tables=tables
)
user_id price
      1   4.0
      2   3.0

See also: Writing a Python SQL engine from scratch.

Used By

Documentation

SQLGlot uses pdoc to serve its API documentation.

A hosted version is on the SQLGlot website, or you can build locally with:

make docs-serve

Run Tests and Lint

make style   # Format, lint, and type-check
make unit    # Only unit tests (pure Python)
make test    # Unit and integration tests (pure Python)
make unitc   # Only unit tests (mypyc compiled)
make testc   # Unit and integration tests (mypyc compiled)
make check   # Full test suite, formatting, linting, and type checks
make clean   # Remove compiled C artifacts (.so files, build dirs)

Benchmarks

Benchmarks run on Python 3.14.3 in seconds.

sqlglot, sqltree, sqlparse, and sqlfluff are python based whereas sqloxide and polyglot-sql are rust bindings.

Query sqlglot sqlglot[c] sqltree sqlparse sqlfluff sqloxide polyglot-sql
tpch 0.002709 (1.00) 0.000740 (0.27) 0.002172 (0.80) 0.014152 (5.22) 0.241027 (88.97) 0.000655 (0.24) 0.000698 (0.26)
short 0.000226 (1.00) 0.000075 (0.33) 0.000184 (0.81) 0.000938 (4.15) 0.031542 (139.47) 0.000041 (0.18) 0.000174 (0.77)
deep_arithmetic 0.007760 (1.00) 0.002015 (0.26) 0.005927 (0.76) N/A 1.359824 (175.22) 0.003117 (0.40) 0.002964 (0.38)
large_in 0.407987 (1.00) 0.101644 (0.25) 0.467943 (1.15) N/A N/A 0.147765 (0.36) 0.105854 (0.26)
values 0.466734 (1.00) 0.113762 (0.24) 0.522797 (1.12) N/A N/A 0.117628 (0.25) 0.117169 (0.25)
many_joins 0.011943 (1.00) 0.002701 (0.23) 0.009887 (0.83) 0.059303 (4.97) 1.246253 (104.35) 0.002918 (0.24) 0.002964 (0.25)
many_unions 0.041321 (1.00) 0.008291 (0.20) 0.038249 (0.93) N/A 1.826401 (44.20) 0.012395 (0.30) 0.013087 (0.32)
nested_subqueries 0.001200 (1.00) 0.000235 (0.20) N/A 0.003860 (3.22) 0.089490 (74.56) 0.000215 (0.18) 0.000262 (0.22)
many_columns 0.011821 (1.00) 0.002825 (0.24) 0.012722 (1.08) 0.238510 (20.18) 1.050386 (88.86) 0.002515 (0.21) 0.003765 (0.32)
large_case 0.035822 (1.00) 0.008593 (0.24) 0.033578 (0.94) N/A 4.200220 (117.25) 0.009870 (0.28) 0.009442 (0.26)
complex_where 0.032710 (1.00) 0.006602 (0.20) N/A 0.136203 (4.16) 2.492927 (76.21) 0.006002 (0.18) 0.007787 (0.24)
many_ctes 0.017610 (1.00) 0.003630 (0.21) 0.012377 (0.70) 0.123620 (7.02) 0.657611 (37.34) 0.004197 (0.24) 0.003273 (0.19)
many_windows 0.020790 (1.00) 0.005751 (0.28) N/A 0.203144 (9.77) 1.421216 (68.36) 0.003941 (0.19) 0.004570 (0.22)
nested_functions 0.000703 (1.00) 0.000189 (0.27) 0.000754 (1.07) 0.005082 (7.23) 0.091007 (129.51) 0.000168 (0.24) 0.000225 (0.32)
large_strings 0.005073 (1.00) 0.001480 (0.29) 0.014533 (2.86) 0.049392 (9.74) 0.320672 (63.22) 0.001616 (0.32) 0.002151 (0.42)
many_numbers 0.103898 (1.00) 0.024483 (0.24) 0.120119 (1.16) N/A N/A 0.031667 (0.30) 0.026880 (0.26)
make bench            # Run parsing, transpilation, and optimization benchmarks
make bench-parse      # Run parsing benchmark
make bench-transpile  # Run transpilation benchmark
make bench-optimize   # Run optimization benchmark

Optional Dependencies

SQLGlot uses dateutil to simplify constant date and interval arithmetic. With dateutil installed, the optimizer simplifies:

DATE '2021-01-01' + INTERVAL '1' MONTH

to:

CAST('2021-02-01' AS DATE)

Without dateutil, the optimizer leaves this arithmetic unevaluated.

Supported Dialects

Dialect Support Level
Athena Official
BigQuery Official
ClickHouse Official
Databricks Official
DAX Community
Doris Community
Dremio Community
Drill Community
Druid Community
DuckDB Official
Dune Community
Exasol Community
Fabric Community
Hive Official
Materialize Community
MySQL Official
Oracle Official
Postgres Official
Presto Official
PRQL Community
Redshift Official
RisingWave Community
SingleStore Community
Snowflake Official
Solr Community
Spark Official
SQLite Official
StarRocks Official
Tableau Official
Teradata Community
Trino Official
TSQL Official
YDB Plugin
MaxCompute Plugin

Official Dialects are maintained by the core SQLGlot team with higher priority for bug fixes and feature additions.

Community Dialects are developed and maintained primarily through community contributions. These are fully functional but may receive lower priority for issue resolution compared to officially supported dialects. We welcome and encourage community contributions to improve these dialects.

Plugin Dialects (supported since v28.6.0) are third-party dialects developed and maintained in external repositories by independent contributors. These dialects are not part of the SQLGlot codebase and are distributed as separate packages. The SQLGlot team does not provide support or maintenance for plugin dialects — please direct any issues or feature requests to their respective repositories. See Creating a Dialect Plugin below for information on how to build your own.

Creating a Dialect Plugin

If your database isn't supported, you can create a plugin that registers a custom dialect via entry points. Create a package with your dialect class and register it in setup.py:

from setuptools import setup

setup(
    name="mydb-sqlglot-dialect",
    entry_points={
        "sqlglot.dialects": [
            "mydb = my_package.dialect:MyDB",
        ],
    },
)

The dialect will be automatically discovered and can be used like any built-in dialect:

from sqlglot import transpile
transpile("SELECT * FROM t", read="mydb", write="postgres")

See the Custom Dialects section for implementation details.


  1# ruff: noqa: F401
  2"""
  3.. include:: ../README.md
  4
  5----
  6"""
  7
  8from __future__ import annotations
  9
 10from collections.abc import Collection
 11from builtins import type as Type
 12
 13import logging
 14import typing as t
 15
 16from sqlglot import expressions as exp
 17from sqlglot.dialects.dialect import Dialect as Dialect, Dialects as Dialects
 18from sqlglot.diff import diff as diff
 19from sqlglot.errors import (
 20    ErrorLevel as ErrorLevel,
 21    ParseError as ParseError,
 22    TokenError as TokenError,
 23    UnsupportedError as UnsupportedError,
 24)
 25from sqlglot.expressions import (
 26    Expr as Expr,
 27    alias_ as alias,
 28    and_ as and_,
 29    case as case,
 30    cast as cast,
 31    column as column,
 32    condition as condition,
 33    delete as delete,
 34    except_ as except_,
 35    find_tables as find_tables,
 36    from_ as from_,
 37    func as func,
 38    insert as insert,
 39    intersect as intersect,
 40    maybe_parse as maybe_parse,
 41    merge as merge,
 42    not_ as not_,
 43    or_ as or_,
 44    select as select,
 45    subquery as subquery,
 46    table_ as table,
 47    to_column as to_column,
 48    to_identifier as to_identifier,
 49    to_table as to_table,
 50    union as union,
 51)
 52from sqlglot.generator import Generator as Generator
 53from sqlglot.parser import Parser as Parser
 54from sqlglot.schema import MappingSchema as MappingSchema, Schema as Schema
 55from sqlglot.tokens import Token as Token, Tokenizer as Tokenizer, TokenType as TokenType
 56
 57if t.TYPE_CHECKING:
 58    from sqlglot._typing import E, GeneratorArgs, ParserNoDialectArgs
 59    from typing_extensions import Unpack
 60    from sqlglot.dialects.dialect import DialectType as DialectType
 61
 62logger = logging.getLogger("sqlglot")
 63
 64
 65try:
 66    from sqlglot._version import __version__, __version_tuple__  # type: ignore[import-not-found]
 67except ImportError:
 68    logger.error(
 69        "Unable to set __version__, run `pip install -e .` or `python setup.py develop` first."
 70    )
 71
 72
 73pretty = False
 74"""Whether to format generated SQL by default."""
 75
 76
 77def tokenize(sql: str, read: DialectType = None, dialect: DialectType = None) -> list[Token]:
 78    """
 79    Tokenizes the given SQL string.
 80
 81    Args:
 82        sql: the SQL code string to tokenize.
 83        read: the SQL dialect to apply during tokenizing (eg. "spark", "hive", "presto", "mysql").
 84            See `sqlglot.dialects.Dialects` for options.
 85        dialect: the SQL dialect (alias for read).
 86
 87    Returns:
 88        The resulting list of tokens.
 89    """
 90    return Dialect.get_or_raise(read or dialect).tokenize(sql)
 91
 92
 93def parse(
 94    sql: str,
 95    read: DialectType = None,
 96    dialect: DialectType = None,
 97    **opts: Unpack[ParserNoDialectArgs],
 98) -> list[Expr | None]:
 99    """
100    Parses the given SQL string into a collection of syntax trees, one per parsed SQL statement.
101
102    Args:
103        sql: the SQL code string to parse.
104        read: the SQL dialect to apply during parsing (eg. "spark", "hive", "presto", "mysql").
105            See `sqlglot.dialects.Dialects` for options.
106        dialect: the SQL dialect (alias for read).
107        **opts: other `sqlglot.parser.Parser` options.
108
109    Returns:
110        The resulting syntax tree collection.
111    """
112    return Dialect.get_or_raise(read or dialect).parse(sql, **opts)
113
114
115@t.overload
116def parse_one(
117    sql: str,
118    *,
119    read: DialectType = ...,
120    dialect: DialectType = ...,
121    into: Type[E],
122    **opts: Unpack[ParserNoDialectArgs],
123) -> E: ...
124
125
126@t.overload
127def parse_one(
128    sql: str,
129    read: DialectType = ...,
130    dialect: DialectType = ...,
131    into: exp.IntoType | None = ...,
132    **opts: Unpack[ParserNoDialectArgs],
133) -> Expr: ...
134
135
136def parse_one(
137    sql: str,
138    read: DialectType = None,
139    dialect: DialectType = None,
140    into: exp.IntoType | None = None,
141    **opts: Unpack[ParserNoDialectArgs],
142) -> Expr:
143    """
144    Parses the given SQL string and returns a syntax tree.
145
146    Args:
147        sql: the SQL code string to parse.
148        read: the SQL dialect to apply during parsing (eg. "spark", "hive", "presto", "mysql").
149            See `sqlglot.dialects.Dialects` for options.
150        dialect: the SQL dialect (alias for read)
151        into: the SQLGlot Expr to parse into.
152        **opts: other `sqlglot.parser.Parser` options.
153
154    Returns:
155        A single syntax tree if one statement is parsed, otherwise a Block expression containing all parsed syntax trees.
156    """
157
158    dialect = Dialect.get_or_raise(read or dialect)
159
160    if into:
161        result = dialect.parse_into(into, sql, **opts)
162    else:
163        result = dialect.parse(sql, **opts)
164
165    if not result or result[0] is None:
166        raise ParseError(f"No expression was parsed from '{sql}'")
167
168    return exp.Block(expressions=result) if len(result) > 1 else result[0]
169
170
171def transpile(
172    sql: str,
173    read: DialectType = None,
174    write: DialectType = None,
175    identity: bool = True,
176    error_level: ErrorLevel | None = None,
177    **opts: Unpack[GeneratorArgs],
178) -> list[str]:
179    """
180    Parses the given SQL string in accordance with the source dialect and returns a list of SQL strings transformed
181    to conform to the target dialect. Each string in the returned list represents a single transformed SQL statement.
182
183    Args:
184        sql: the SQL code string to transpile.
185        read: the source dialect used to parse the input string (eg. "spark", "hive", "presto", "mysql").
186            See `sqlglot.dialects.Dialects` for options.
187        write: the target dialect into which the input should be transformed (eg. "spark", "hive", "presto", "mysql").
188            See `sqlglot.dialects.Dialects` for options.
189        identity: if set to `True` and if the target dialect is not specified the source dialect will be used as both:
190            the source and the target dialect.
191        error_level: the desired error level of the parser.
192        **opts: other `sqlglot.generator.Generator` options.
193
194    Returns:
195        The list of transpiled SQL statements.
196    """
197    write = (read if write is None else write) if identity else write
198    write = Dialect.get_or_raise(write)
199    return [
200        write.generate(expression, copy=False, **opts) if expression else ""
201        for expression in parse(sql, read, error_level=error_level)
202    ]
logger = <Logger sqlglot (WARNING)>
pretty = False

Whether to format generated SQL by default.

def tokenize( sql: str, read: Union[str, sqlglot.dialects.Dialect, type[sqlglot.dialects.Dialect], NoneType] = None, dialect: Union[str, sqlglot.dialects.Dialect, type[sqlglot.dialects.Dialect], NoneType] = None) -> list[sqlglot.tokenizer_core.Token]:
78def tokenize(sql: str, read: DialectType = None, dialect: DialectType = None) -> list[Token]:
79    """
80    Tokenizes the given SQL string.
81
82    Args:
83        sql: the SQL code string to tokenize.
84        read: the SQL dialect to apply during tokenizing (eg. "spark", "hive", "presto", "mysql").
85            See `sqlglot.dialects.Dialects` for options.
86        dialect: the SQL dialect (alias for read).
87
88    Returns:
89        The resulting list of tokens.
90    """
91    return Dialect.get_or_raise(read or dialect).tokenize(sql)

Tokenizes the given SQL string.

Arguments:
  • sql: the SQL code string to tokenize.
  • read: the SQL dialect to apply during tokenizing (eg. "spark", "hive", "presto", "mysql"). See sqlglot.dialects.Dialects for options.
  • dialect: the SQL dialect (alias for read).
Returns:

The resulting list of tokens.

def parse( sql: str, read: Union[str, sqlglot.dialects.Dialect, type[sqlglot.dialects.Dialect], NoneType] = None, dialect: Union[str, sqlglot.dialects.Dialect, type[sqlglot.dialects.Dialect], NoneType] = None, **opts: typing_extensions.Unpack[sqlglot._typing.ParserNoDialectArgs]) -> list[sqlglot.expressions.core.Expr | None]:
 94def parse(
 95    sql: str,
 96    read: DialectType = None,
 97    dialect: DialectType = None,
 98    **opts: Unpack[ParserNoDialectArgs],
 99) -> list[Expr | None]:
100    """
101    Parses the given SQL string into a collection of syntax trees, one per parsed SQL statement.
102
103    Args:
104        sql: the SQL code string to parse.
105        read: the SQL dialect to apply during parsing (eg. "spark", "hive", "presto", "mysql").
106            See `sqlglot.dialects.Dialects` for options.
107        dialect: the SQL dialect (alias for read).
108        **opts: other `sqlglot.parser.Parser` options.
109
110    Returns:
111        The resulting syntax tree collection.
112    """
113    return Dialect.get_or_raise(read or dialect).parse(sql, **opts)

Parses the given SQL string into a collection of syntax trees, one per parsed SQL statement.

Arguments:
  • sql: the SQL code string to parse.
  • read: the SQL dialect to apply during parsing (eg. "spark", "hive", "presto", "mysql"). See sqlglot.dialects.Dialects for options.
  • dialect: the SQL dialect (alias for read).
  • **opts: other sqlglot.parser.Parser options.
Returns:

The resulting syntax tree collection.

def parse_one( sql: str, read: Union[str, sqlglot.dialects.Dialect, type[sqlglot.dialects.Dialect], NoneType] = None, dialect: Union[str, sqlglot.dialects.Dialect, type[sqlglot.dialects.Dialect], NoneType] = None, into: Union[type[sqlglot.expressions.core.Expr], Collection[type[sqlglot.expressions.core.Expr]], NoneType] = None, **opts: typing_extensions.Unpack[sqlglot._typing.ParserNoDialectArgs]) -> sqlglot.expressions.core.Expr:
137def parse_one(
138    sql: str,
139    read: DialectType = None,
140    dialect: DialectType = None,
141    into: exp.IntoType | None = None,
142    **opts: Unpack[ParserNoDialectArgs],
143) -> Expr:
144    """
145    Parses the given SQL string and returns a syntax tree.
146
147    Args:
148        sql: the SQL code string to parse.
149        read: the SQL dialect to apply during parsing (eg. "spark", "hive", "presto", "mysql").
150            See `sqlglot.dialects.Dialects` for options.
151        dialect: the SQL dialect (alias for read)
152        into: the SQLGlot Expr to parse into.
153        **opts: other `sqlglot.parser.Parser` options.
154
155    Returns:
156        A single syntax tree if one statement is parsed, otherwise a Block expression containing all parsed syntax trees.
157    """
158
159    dialect = Dialect.get_or_raise(read or dialect)
160
161    if into:
162        result = dialect.parse_into(into, sql, **opts)
163    else:
164        result = dialect.parse(sql, **opts)
165
166    if not result or result[0] is None:
167        raise ParseError(f"No expression was parsed from '{sql}'")
168
169    return exp.Block(expressions=result) if len(result) > 1 else result[0]

Parses the given SQL string and returns a syntax tree.

Arguments:
  • sql: the SQL code string to parse.
  • read: the SQL dialect to apply during parsing (eg. "spark", "hive", "presto", "mysql"). See sqlglot.dialects.Dialects for options.
  • dialect: the SQL dialect (alias for read)
  • into: the SQLGlot Expr to parse into.
  • **opts: other sqlglot.parser.Parser options.
Returns:

A single syntax tree if one statement is parsed, otherwise a Block expression containing all parsed syntax trees.

def transpile( sql: str, read: Union[str, sqlglot.dialects.Dialect, type[sqlglot.dialects.Dialect], NoneType] = None, write: Union[str, sqlglot.dialects.Dialect, type[sqlglot.dialects.Dialect], NoneType] = None, identity: bool = True, error_level: sqlglot.errors.ErrorLevel | None = None, **opts: typing_extensions.Unpack[sqlglot._typing.GeneratorArgs]) -> list[str]:
172def transpile(
173    sql: str,
174    read: DialectType = None,
175    write: DialectType = None,
176    identity: bool = True,
177    error_level: ErrorLevel | None = None,
178    **opts: Unpack[GeneratorArgs],
179) -> list[str]:
180    """
181    Parses the given SQL string in accordance with the source dialect and returns a list of SQL strings transformed
182    to conform to the target dialect. Each string in the returned list represents a single transformed SQL statement.
183
184    Args:
185        sql: the SQL code string to transpile.
186        read: the source dialect used to parse the input string (eg. "spark", "hive", "presto", "mysql").
187            See `sqlglot.dialects.Dialects` for options.
188        write: the target dialect into which the input should be transformed (eg. "spark", "hive", "presto", "mysql").
189            See `sqlglot.dialects.Dialects` for options.
190        identity: if set to `True` and if the target dialect is not specified the source dialect will be used as both:
191            the source and the target dialect.
192        error_level: the desired error level of the parser.
193        **opts: other `sqlglot.generator.Generator` options.
194
195    Returns:
196        The list of transpiled SQL statements.
197    """
198    write = (read if write is None else write) if identity else write
199    write = Dialect.get_or_raise(write)
200    return [
201        write.generate(expression, copy=False, **opts) if expression else ""
202        for expression in parse(sql, read, error_level=error_level)
203    ]

Parses the given SQL string in accordance with the source dialect and returns a list of SQL strings transformed to conform to the target dialect. Each string in the returned list represents a single transformed SQL statement.

Arguments:
  • sql: the SQL code string to transpile.
  • read: the source dialect used to parse the input string (eg. "spark", "hive", "presto", "mysql"). See sqlglot.dialects.Dialects for options.
  • write: the target dialect into which the input should be transformed (eg. "spark", "hive", "presto", "mysql"). See sqlglot.dialects.Dialects for options.
  • identity: if set to True and if the target dialect is not specified the source dialect will be used as both: the source and the target dialect.
  • error_level: the desired error level of the parser.
  • **opts: other sqlglot.generator.Generator options.
Returns:

The list of transpiled SQL statements.