Struct LineageHandle 

pub struct LineageHandle { /* private fields */ }

The per-query lineage payload produced by begin_lineage, carried under one run_id from the planning-time step to the terminal event.

A host composing lineage with another concern (e.g. running lineage’s START step after a policy gate, from its own single QueryPlanner) holds this between begin_lineage and [Self::into_marker] / the emit_* methods.

Implementations

impl LineageHandle

pub fn run_id(&self) -> Uuid

The run id START was emitted under; COMPLETE/FAIL must share it.

pub fn to_marker( &self, plan: LogicalPlan, client: OpenLineageClient, config: &OpenLineageConfig, ) -> LogicalPlan

Wrap plan in a LineageMarker carrying the COMPLETE template, so a registered LineageExtensionPlanner lowers it into the terminal OpenLineageExec at the physical root (the composable path).

Borrows so the handle stays available for Self::emit_fail if the subsequent physical planning errors.

pub fn emit_fail( &self, client: &OpenLineageClient, config: &OpenLineageConfig, err: &str, )

Emit FAIL for a planning error that occurs after START, before any OpenLineageExec exists to observe execution. Under the same run_id.

pub fn emit_complete( &self, client: &OpenLineageClient, config: &OpenLineageConfig, )

Emit COMPLETE directly, under the same run_id, with eventTime refreshed to now (so run duration is meaningful). For paths that run the query outside a physical plan — there is no OpenLineageExec to emit the terminal event, so the caller emits it (e.g. the CTAS / CREATE VIEW DDL path, which materializes internally and hands back an empty result).

pub fn set_sql_if_absent(&mut self, sql: &str)

Fold SQL text into the lineage when the context provider didn’t supply it (a path that has the raw statement in hand — e.g. the DDL path).