Class Polyglot

Main Polyglot class for object-oriented usage.

Index

Methods

annotateTypes format formatWithOptions generate getDialects getVersion parse tokenize transpile getInstance

Methods

annotateTypes

annotateTypes(
    sql: string,
    dialect?: Dialect,
    schema?: Schema,
): AnnotateTypesResult
Parse SQL and annotate the AST with inferred type information.
Parameters
- sql: string
- dialect: Dialect = Dialect.Generic
- Optionalschema: Schema
Returns AnnotateTypesResult
- Defined in index.ts:622

format

format(sql: string, dialect?: Dialect): TranspileResult
Format SQL.
Parameters
- sql: string
- dialect: Dialect = Dialect.Generic
Returns TranspileResult
- Defined in index.ts:589

formatWithOptions

formatWithOptions(
    sql: string,
    dialect?: Dialect,
    options?: FormatOptions,
): TranspileResult
Format SQL with explicit guard limits.
Parameters
- sql: string
- dialect: Dialect = Dialect.Generic
- options: FormatOptions = {}
Returns TranspileResult
- Defined in index.ts:596

generate

generate(ast: any, dialect?: Dialect): TranspileResult
Generate SQL from an AST.
Parameters
- ast: any
- dialect: Dialect = Dialect.Generic
Returns TranspileResult
- Defined in index.ts:582

getDialects

getDialects(): string[]
Get supported dialects in this build. Per-dialect builds return only "generic" and the selected dialect.

Returns string[]
- Defined in index.ts:608

getVersion

getVersion(): string
Get library version.

Returns string
- Defined in index.ts:615

parse

parse(sql: string, dialect?: Dialect): ParseResult
Parse SQL into an AST.
Parameters
- sql: string
- dialect: Dialect = Dialect.Generic
Returns ParseResult
- Defined in index.ts:568

tokenize

tokenize(sql: string, dialect?: Dialect): TokenizeResult
Tokenize SQL into a token stream.
Parameters
- sql: string
- dialect: Dialect = Dialect.Generic
Returns TokenizeResult
- Defined in index.ts:575

transpile

transpile(sql: string, read: Dialect, write: Dialect): TranspileResult
Transpile SQL from one dialect to another.
Parameters
- sql: string
- read: Dialect
- write: Dialect
Returns TranspileResult
Remarks
Per-dialect builds only support same-dialect and to/from Generic transpilation. Use Polyglot.getDialects to check available dialects.
- Defined in index.ts:561

`Static`getInstance

getInstance(): Polyglot
Get or create the Polyglot instance. The WASM module is automatically initialized on import.

Returns Polyglot
- Defined in index.ts:547