Deprecated: Rust-backed SQLGlot tokenizer

0.13.0 · deprecated · verified Thu Apr 09

SQLGlotrs was an optional Rust-backed tokenizer for the SQLGlot library, designed to accelerate SQL parsing performance. Introduced to provide significant speed improvements, it has since been deprecated. Users seeking performance enhancements should now use `sqlglot[c]`, which provides similar benefits through C extensions compiled with MyPyC.

Warnings

breaking The `sqlglotrs` package is deprecated and is no longer compatible with recent versions of `sqlglot`. Attempting to use `sqlglotrs` with modern `sqlglot` installations may lead to runtime errors or unexpected behavior.
Fix: Migrate to using the `sqlglot[c]` extra for performance. Uninstall `sqlglotrs` and install `sqlglot` using `pip install "sqlglot[c]"`.
deprecated The `sqlglotrs` library is officially deprecated. Its PyPI summary explicitly states: 'Deprecated: use sqlglotc instead.'
Fix: No new development or maintenance is expected. Users should transition to `sqlglot[c]` for continued performance benefits and compatibility with `sqlglot`.
gotcha Users often confuse `sqlglot`, `sqlglotrs`, and `sqlglotc`. `sqlglot` is the main Python SQL parsing library. `sqlglotrs` was an optional Rust-backed tokenizer for `sqlglot`, now replaced by `sqlglotc`, which provides C extensions for performance. Direct imports of `sqlglotrs` were generally not the intended usage.
Fix: Focus on the main `sqlglot` library and use `pip install "sqlglot[c]"` for enhanced performance. The performance benefits are integrated into `sqlglot` when the `[c]` extra is installed.

Install

pip install sqlglotrs Original installation (DEPRECATED)
pip install "sqlglot[c]" Recommended replacement for performance

Imports

parse_one
```
from sqlglot import parse_one
```
sqlglotrs primarily functioned as an internal tokenizer backend for the main `sqlglot` library. End-users would typically import functionalities directly from `sqlglot`, not `sqlglotrs`.

Quickstart

This quickstart demonstrates basic parsing and transpilation using the core `sqlglot` library. While `sqlglotrs` provided a faster tokenizer, its functionality was exposed through `sqlglot`'s API. For current performance benefits, install `sqlglot` with the `[c]` extra.

from sqlglot import parse_one, exp

# Example using the core sqlglot library functionality
sql_query = "SELECT a, b FROM my_table WHERE a > 10"
expression_tree = parse_one(sql_query)

print(expression_tree.sql(dialect="mysql"))

# To get the performance benefits previously offered by sqlglotrs (now sqlglot[c]),
# ensure sqlglot is installed with the '[c]' extra: pip install "sqlglot[c]"

view raw JSON →