Class Polyglot

Main Polyglot class for object-oriented usage.

Index

Methods

analyzeQuery annotateTypes format formatWithOptions generate generateDataType getDialects getVersion parse parseDataType tokenize transpile getInstance

Methods

analyzeQuery

analyzeQuery(sql: string, dialect: string): QueryAnalysisResult
Return compact query analysis facts for a SELECT or set operation.
Parameters
- sql: string
- dialect: string
Returns QueryAnalysisResult
- Defined in index.ts:1023
analyzeQuery(sql: string, options?: AnalyzeQueryOptions): QueryAnalysisResult
Return compact query analysis facts for a SELECT or set operation.
Parameters
- sql: string
- Optionaloptions: AnalyzeQueryOptions
Returns QueryAnalysisResult
- Defined in index.ts:1024

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

format

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

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

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

generateDataType

generateDataType(dataType: DataType, dialect?: Dialect): GenerateDataTypeResult
Generate SQL from a standalone DataType AST node.
Parameters
- dataType: DataType
- dialect: Dialect = Dialect.Generic
Returns GenerateDataTypeResult
- Defined in index.ts:970

getDialects

getDialects(): string[]
Get supported dialects in this build.

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

getVersion

getVersion(): string
Get library version.

Returns string
- Defined in index.ts:1005

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

parseDataType

parseDataType(sql: string, dialect?: Dialect): DataTypeResult
Parse a standalone SQL data type.
Parameters
- sql: string
- dialect: Dialect = Dialect.Generic
Returns DataTypeResult
- Defined in index.ts:946

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

transpile

transpile(
    sql: string,
    read: Dialect,
    write: Dialect,
    options?: TranspileOptions,
): TranspileResult
Transpile SQL from one dialect to another.
Parameters
- sql: string
- read: Dialect
- write: Dialect
- Optionaloptions: TranspileOptions
Returns TranspileResult
Remarks
Use Polyglot.getDialects to inspect available dialects.
- Defined in index.ts:927

`Static`getInstance

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

Returns Polyglot
- Defined in index.ts:914

Class Polyglot

Index

Methods

Methods

analyzeQuery

Parameters

Returns QueryAnalysisResult

Parameters

Returns QueryAnalysisResult

annotateTypes

Parameters

Returns AnnotateTypesResult

format

Parameters

Returns TranspileResult

formatWithOptions

Parameters

Returns TranspileResult

generate

Parameters

Returns TranspileResult

generateDataType

Parameters

Returns GenerateDataTypeResult

getDialects

Returns string[]

getVersion

Returns string

parse

Parameters

Returns ParseResult

parseDataType

Parameters

Returns DataTypeResult

tokenize

Parameters

Returns TokenizeResult

transpile

Parameters

Returns TranspileResult

Remarks

StaticgetInstance

Returns Polyglot

Settings

On This Page

`Static`getInstance