Context of a pipeline
This document describes the context information set by the pipeline during its execution.
The context is an object (wizata_dsapi.Context
) initiated once a pipeline execution starts, and terminated when it stops. The context is used to pass to each steps a maximum of known information and data about the pipeline itself but not only.
Properties
Properties is a dictionary initiated when a pipeline starts. It is unique along its full execution and accessible by each step. It is therefore very useful to pass information between different steps that cannot be stored inside a well formatted time-series data frame.
Properties are also passed as parameters when execution starts. Either from code, or manually by user on UI when asks to fulfil pre-defined variables.
Properties contains automatically all template properties values of the registration used when executed the pipeline.
Therefore it is best practice to not use name of a template property for your custom properties.
Properties can also be used to dynamically configure a step (e.g. model ID, df columns mapping to write, …)
Properties are accessible within a script (including for modelling and plotting) by using the wizata_dsapi.Context
attribute properties.
Datapoints
All Query step executed before accessing the context will set on the datapoints attribute of the complete definition of the wizata_dsapi.Datapoint
. This allows you to access to information such as unit, business type, min, max, ... or any extra properties of your Data Point to parametrize your pipeline script.
Updated 10 months ago