diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 15 insertions, 6 deletions
@@ -1,12 +1,12 @@ # SQLGlot -SQLGlot is a no dependency Python SQL parser, transpiler, optimizer, and engine. It can be used to format SQL or translate between different dialects like [DuckDB](https://duckdb.org/), [Presto](https://prestodb.io/), [Spark](https://spark.apache.org/), [Snowflake](https://www.snowflake.com/en/), and [BigQuery](https://cloud.google.com/bigquery/). It aims to read a wide variety of SQL inputs and output syntactically correct SQL in the targeted dialects. +SQLGlot is a no dependency Python SQL parser, transpiler, optimizer, and engine. It can be used to format SQL or translate between [18 different dialects](https://github.com/tobymao/sqlglot/blob/main/sqlglot/dialects/__init__.py) like [DuckDB](https://duckdb.org/), [Presto](https://prestodb.io/), [Spark](https://spark.apache.org/), [Snowflake](https://www.snowflake.com/en/), and [BigQuery](https://cloud.google.com/bigquery/). It aims to read a wide variety of SQL inputs and output syntactically correct SQL in the targeted dialects. It is a very comprehensive generic SQL parser with a robust [test suite](https://github.com/tobymao/sqlglot/blob/main/tests/). It is also quite [performant](#benchmarks) while being written purely in Python. You can easily [customize](#custom-dialects) the parser, [analyze](#metadata) queries, traverse expression trees, and programmatically [build](#build-and-modify-sql) SQL. -Syntax [errors](#parser-errors) are highlighted and dialect incompatibilities can warn or raise depending on configurations. +Syntax [errors](#parser-errors) are highlighted and dialect incompatibilities can warn or raise depending on configurations. However, it should be noted that the parser is very lenient when it comes to detecting errors, because it aims to consume as much SQL as possible. On one hand, this makes its implementation simpler, and thus more comprehensible, but on the other hand it means that syntax errors may sometimes go unnoticed. Contributions are very welcome in SQLGlot; read the [contribution guide](https://github.com/tobymao/sqlglot/blob/main/CONTRIBUTING.md) to get started! @@ -25,6 +25,7 @@ Contributions are very welcome in SQLGlot; read the [contribution guide](https:/ * [AST Diff](#ast-diff) * [Custom Dialects](#custom-dialects) * [SQL Execution](#sql-execution) +* [Used By](#used-by) * [Documentation](#documentation) * [Run Tests and Lint](#run-tests-and-lint) * [Benchmarks](#benchmarks) @@ -165,7 +166,7 @@ for table in parse_one("SELECT * FROM x JOIN y JOIN z").find_all(exp.Table): ### Parser Errors -A syntax error will result in a parser error: +When the parser detects an error in the syntax, it raises a ParserError: ```python import sqlglot @@ -283,13 +284,13 @@ print( ```sql SELECT ( - "x"."A" OR "x"."B" OR "x"."C" + "x"."a" OR "x"."b" OR "x"."c" ) AND ( - "x"."A" OR "x"."B" OR "x"."D" + "x"."a" OR "x"."b" OR "x"."d" ) AS "_col_0" FROM "x" AS "x" WHERE - "x"."Z" = CAST('2021-02-01' AS DATE) + CAST("x"."z" AS DATE) = CAST('2021-02-01' AS DATE) ``` ### AST Introspection @@ -432,6 +433,14 @@ user_id price 2 3.0 ``` +## Used By +* [Fugue](https://github.com/fugue-project/fugue) +* [ibis](https://github.com/ibis-project/ibis) +* [mysql-mimic](https://github.com/kelsin/mysql-mimic) +* [Querybook](https://github.com/pinterest/querybook) +* [Quokka](https://github.com/marsupialtail/quokka) +* [Splink](https://github.com/moj-analytical-services/splink) + ## Documentation SQLGlot uses [pdocs](https://pdoc.dev/) to serve its API documentation: |