Class Polyglot

Main Polyglot class for object-oriented usage.

Index

Methods

format generate getDialects getVersion parse transpile getInstance

Methods

format

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

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:240

getDialects

getDialects(): string[]
Get supported dialects.

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

getVersion

getVersion(): string
Get library version.

Returns string
- Defined in index.ts:261

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:233

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
- Defined in index.ts:226

`Static`getInstance

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

Returns Polyglot
- Defined in index.ts:216