Class Runtime

constructor

• new Runtime(options?: RuntimeOptions): Runtime

  Parameters

  • Optionaloptions: RuntimeOptions

  Returns Runtime

Readonlypersist

Readonlyroot

memoryPolicy

• get memoryPolicy(): MemoryPolicy | undefined

  The memory policy this runtime applies to every execution (call-site collect({ memory }) overrides it).

  Returns MemoryPolicy | undefined

chooseBackend

• chooseBackend(plan: PlanNode): Backend

  Parameters

  • plan: PlanNode

  Returns Backend

execute

• execute(plan: PlanNode, opts?: ExecuteOptions): Promise<TableView>

  Parameters

  • plan: PlanNode
  • Optionalopts: ExecuteOptions

  Returns Promise<TableView>

executeWithReport

• executeWithReport(
      plan: PlanNode,
      opts?: ExecuteOptions,
  ): Promise<{ report: ExecutionReport; table: TableView }>

  Execute and return what actually ran: per-node backend, kernels, fallback reasons and timings. In strict mode a plan whose requested engine executed no node throws EngineStrictError.

  Parameters

  • plan: PlanNode
  • Optionalopts: ExecuteOptions

  Returns Promise<{ report: ExecutionReport; table: TableView }>

explain

• explain(plan: PlanNode): string

  Parameters

  • plan: PlanNode

  Returns string

listBackends

• listBackends(): Backend[]

  Registered backends (CPU first). Backends are shareable: withEngine forks and sessions reuse them.

  Returns Backend[]

register

• register(backend: Backend): void

  Parameters

  • backend: Backend

  Returns void

setEngine

• setEngine(engine: EngineKind): void

  Parameters

  • engine: EngineKind

  Returns void

setMemoryPolicy

• setMemoryPolicy(policy: MemoryPolicy): void

  Replace this runtime's memory policy (instance only; setMemoryPolicy() from the package sets the process default).

  Parameters

  • policy: MemoryPolicy

  Returns void

withEngine

• withEngine(engine: EngineKind, options?: { strict?: boolean }): Runtime

  Immutable-ish fork with a forced engine (does not mutate this instance).

  Parameters

  • engine: EngineKind
  • Optionaloptions: { strict?: boolean }

  Returns Runtime