Variable default

Type Declaration

• analyzeQuery: {
      (sql: string, dialect: string): QueryAnalysisResult;
      (sql: string, options?: AnalyzeQueryOptions): QueryAnalysisResult;
  }

• annotateTypes: (sql: string, dialect?: Dialect, schema?: Schema) => AnnotateTypesResult

• changesOnly: (edits: DiffEdit[]) => DiffEdit[]

• compat: compat

  Immutable compatibility builder API.

  Plans are evaluated by the same Rust builder engine used by Python and Go. The mutable builders in builders.ts are adapters over this API.

• Dialect: typeof Dialect

• diff: (
      source: string,
      target: string,
      dialect?: string,
      options?: DiffOptions,
  ) => DiffResult

• format: (sql: string, dialect?: Dialect) => TranspileResult

• generate: (ast: any, dialect?: Dialect) => TranspileResult

• generateDataType: (dataType: DataType, dialect?: Dialect) => GenerateDataTypeResult

• getDialects: () => string[]

• getSourceTables: (column: string, sql: string, dialect?: string) => SourceTablesResult

• getVersion: () => string

• hasChanges: (edits: DiffEdit[]) => boolean

• init: () => Promise<void>

• isInitialized: () => boolean

• lineage: (
      column: string,
      sql: string,
      dialect?: string,
      trimSelects?: boolean,
  ) => LineageResult

• lineageAt: (
      ordinal: number,
      sql: string,
      dialect?: string,
      trimSelects?: boolean,
  ) => LineageResult

• lineageAtWithSchema: (
      ordinal: number,
      sql: string,
      schema: Schema,
      dialect?: string,
      trimSelects?: boolean,
  ) => LineageResult

• lineageWithSchema: (
      column: string,
      sql: string,
      schema: Schema,
      dialect?: string,
      trimSelects?: boolean,
  ) => LineageResult

• openLineageColumnLineage: (sql: string, options: OpenLineageOptions) => OpenLineageColumnLineageResult

• openLineageJobEvent: (sql: string, options: OpenLineageOptions) => OpenLineageEventResult

• openLineageRunEvent: (sql: string, options: OpenLineageOptions) => OpenLineageEventResult

• outputColumns: (sql: string, dialect?: string) => QueryOutputResult

• outputColumnsWithSchema: (sql: string, schema: Schema, dialect?: string) => QueryOutputResult

• parse: (sql: string, dialect?: Dialect) => ParseResult

• parseDataType: (sql: string, dialect?: Dialect) => DataTypeResult

• plan: (sql: string, dialect?: string) => PlanResult

• Polyglot: typeof Polyglot

• tokenize: (sql: string, dialect?: Dialect) => TokenizeResult

• transpile: (
      sql: string,
      read: Dialect,
      write: Dialect,
      options?: TranspileOptions,
  ) => TranspileResult