Pyvelox Runners

class pyvelox.runner.LocalRunner

__init__(self: pyvelox.runner.LocalRunner, arg0: pyvelox.plan_builder.PlanNode) → None

add_file_split(self: pyvelox.runner.LocalRunner, file: facebook::velox::py::PyFile, plan_id: str, connector_id: str = 'prism') → None

Add a split to scan a file, and associate it to the plan node described by plan_id.

Args:

file: A file object describing the file path and format. plan_id: The plan node id of the scan to associate this

file/split with.

connector_id: The id of the connector used by the scan.

add_query_config(self: pyvelox.runner.LocalRunner, config_name: str, config_value: str) → None

Add a query configuration parameter. These values are passed to the Velox Task through a query context object.

Args:

configName: The name (key) of the configuration parameter. configValue: The configuration value.

execute(self: pyvelox.runner.LocalRunner, max_drivers: int = 1) → Iterator

Executes a given plan returning an iterator to the output produced by the root plan node.

Args:

max_drivers: Maximum number of drivers (threads) to use when executing the plan.

print_plan_with_stats(self: pyvelox.runner.LocalRunner) → str

Prints a descriptive debug message containing plan and execution stats. If the task hasn’t finished, will print the plan with the current stats.