Polyglot SQL API Documentation - v0.2.0
    Preparing search index...

    Variable default

    default: {
        annotateTypes: (
            sql: string,
            dialect?: Dialect,
            schema?: Schema,
        ) => AnnotateTypesResult;
        changesOnly: (edits: DiffEdit[]) => DiffEdit[];
        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;
        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;
        lineageWithSchema: (
            column: string,
            sql: string,
            schema: Schema,
            dialect?: string,
            trimSelects?: boolean,
        ) => LineageResult;
        parse: (sql: string, dialect?: Dialect) => ParseResult;
        plan: (sql: string, dialect?: string) => PlanResult;
        Polyglot: typeof Polyglot;
        tokenize: (sql: string, dialect?: Dialect) => TokenizeResult;
        transpile: (sql: string, read: Dialect, write: Dialect) => TranspileResult;
    }

    Type Declaration