Interface AnalyzeRequest

A request to analyze SQL for data lineage.

This is the main entry point for the analysis API. It accepts SQL code along with optional dialect and schema information to produce accurate lineage graphs.

interface AnalyzeRequest {
    dialect: Dialect;
    options?: AnalysisOptions;
    schema?: SchemaMetadata;
    sql: string;
}

Index

Properties

dialect options? schema? sql

Properties

dialect

dialect: Dialect

SQL dialect

`Optional`options

options?: AnalysisOptions

Optional analysis options

`Optional`schema

schema?: SchemaMetadata

Optional schema metadata for accurate column resolution

sql

sql: string

The SQL code to analyze (UTF-8 string, multi-statement supported)