Report.route()

The route by which run would take the plan to engine, and the

Usage

Source

Report.route(
    engine,
    route="auto",
    *,
    reproducible=None,
)

plan’s class there, without running it: the route report.routes records after a run (D13).

Parameters

engine: Any

The engine’s name ("duckdb", "polars", …) or a Spark session.

route: RouteKind | Literal["auto"] = "auto"

"auto" (the default) tries the routes in turn; a route by name ("native", "reference", "transfer", "recheck") is taken or refused.

reproducible: Observation | None = None

What a rerun must reproduce, as run takes it.

Returns

Route

The Route: its kind, cls ("exact", "observed", "shim"

or "refused"), observation and reason. A plan that is not

proved is refused, with reason saying so.

Raises

EngineVersionError

The installed engine is another major version than its profile’s.

EngineSettingsError

A setting the engine’s profile depends on differs from its facts’.