Skip to content

SQLGlot Dialects

from sqlspec.dialects import DB2, ParadeDB, PGTextSearch, PGVector, Spangres, Spanner

Custom SQLGlot dialect implementations registered automatically via Python entry points (sqlglot.dialects) when SQLSpec is installed. See the Query Builder Guide for syntax translations and dialect features.

Cloud Spanner Dialects

Spanner

Bases: BigQuery

Google Cloud Spanner SQL dialect.

Tokenizer

Tokenizer = SpannerTokenizer

Parser

Parser = SpannerParser

Generator

Generator = SpannerGenerator

parse

parse(sql, **opts)

Parse Spanner SQL statements and attach hints.

parse_into

parse_into(expression_type, sql, **opts)

Parse into specific expression type with attached hints.

Spangres

Bases: Postgres

Spanner PostgreSQL-compatible dialect.

Parser

Parser = SpangresParser

Generator

Generator = SpangresGenerator

parse

parse(sql, **opts)

Parse Spangres SQL statements and attach hints.

parse_into

parse_into(expression_type, sql, **opts)

Parse into specific expression type with attached hints.

IBM Db2 Dialect

DB2

Bases: Dialect

IBM Db2 SQL dialect.

NORMALIZATION_STRATEGY

NORMALIZATION_STRATEGY = NormalizationStrategy.UPPERCASE

NULL_ORDERING

NULL_ORDERING = 'nulls_are_large'

TIME_MAPPING

TIME_MAPPING = DB2_TIME_MAPPING

INVERSE_TIME_MAPPING

INVERSE_TIME_MAPPING = DB2_INVERSE_TIME_MAPPING

Tokenizer

Tokenizer = DB2Tokenizer

Generator

Generator = generator.Generator

generator

generator(**opts)

Return a root generator whose dispatch table carries the Db2 handlers.

Parameters:

Name Type Description Default
**opts Any

sqlglot generator options.

{}

Returns:

Type Description
Generator

A generator that renders Db2 SQL.

parse

parse(sql, **opts)

Parse Db2 SQL, including Db2 select-statement tails.

Parameters:

Name Type Description Default
sql str

Db2 SQL text.

required
**opts Any

sqlglot parser options.

{}

Returns:

Type Description
list[Expr | None]

One expression per statement.

parse_into

parse_into(expression_type, sql, **opts)

Parse Db2 SQL into a target expression type, including statement tails.

Parameters:

Name Type Description Default
expression_type Any

Target sqlglot expression type or types.

required
sql str

Db2 SQL text.

required
**opts Any

sqlglot parser options.

{}

Returns:

Type Description
list[Expr | None]

One expression per statement.

PostgreSQL Search & Vector Dialects

PGVector

Bases: Postgres

PostgreSQL dialect with pgvector extension support.

Tokenizer

Tokenizer = PGVectorTokenizer

Generator

Generator = PGVectorGenerator

ParadeDB

Bases: Postgres

ParadeDB dialect with pg_search and pgvector extension support.

Tokenizer

Tokenizer = ParadeDBTokenizer

Generator

Generator = ParadeDBGenerator

PGTextSearch

Bases: Postgres

PostgreSQL dialect with pg_textsearch and pgvector extension support.

Tokenizer

Tokenizer = PGTextSearchTokenizer

Generator

Generator = PGTextSearchGenerator