This is archived documentation for InfluxData product versions that are no longer maintained. For newer documentation, see the latest InfluxData documentation.
Joins the data from any number of nodes. As each data point is received from a parent node it is paired with the next data points from the other parent nodes with a matching timestamp. Each parent node contributes at most one point to each joined point. A tolerance can be supplied to join points that do not have perfectly aligned timestamps. Any points that fall within the tolerance are joined on the timestamp. If multiple points fall within the same tolerance window than they are joined in the order they arrive.
Aliases are used to prefix all fields from the respective nodes.
The join can be an inner or outer join, see the JoinNode.Fill property.
var errors = stream .from().measurement('errors') var requests = stream .from().measurement('requests') // Join the errors and requests streams errors.join(requests) // Provide prefix names for the fields of the data points. .as('errors', 'requests') // points that are within 1 second are considered the same time. .tolerance(1s) // fill missing values with 0, implies outer join. .fill(0.0) // name the resulting stream .streamName('error_rate') // Both the "value" fields from each parent have been prefixed // with the respective names 'errors' and 'requests'. .eval(lambda: "errors.value" / "requests.value")) .as('rate') ...
In the above example the
requests streams are joined
and then transformed to calculate a combined field.
Property methods modify state on the calling node. They do not add another node to the pipeline, and always return a reference to the calling node.
Prefix names for all fields from the respective nodes. Each field from the parent nodes will be prefixed with the provided name and a '.'. See the example above.
The names cannot have a dot '.' character.
Fill the data. The fill option implies the type of join: inner or full outer Options are:
- none - (default) skip rows where a point is missing, inner join.
- null - fill missing points with null, full outer join.
Any numerical value - fill fields with given value, full outer join.
The name of this new joined data stream. If empty the name of the left parent is used.
The maximum duration of time that two incoming points can be apart and still be considered to be equal in time. The joined data point's time will be rounded to the nearest multiple of the tolerance duration.
Chaining methods create a new node in the pipeline as a child of the calling node. They do not modify the calling node.
Create an alert node, which can trigger alerts.
Create a new node that computes the derivative of adjacent points.
Create an eval node that will evaluate the given transformation function to each data point. A list of expressions may be provided and will be evaluated in the order they are given and results of previous expressions are made available to later expressions.
Group the data by a set of tags.
Can pass literal * to group by all dimensions. Example:
Create an http output node that caches the most recent data it has received. The cached data is available at the given endpoint. The endpoint is the relative path from the API endpoint of the running task. For example if the task endpoint is at "/api/v1/task/<task_name>" and endpoint is "top10", then the data can be requested from "/api/v1/task/<task_name>/top10".
Create an influxdb output node that will store the incoming data into InfluxDB.
Join this node with other nodes. The data is joined on timestamp.
Perform a map-reduce operation on the data.
The built-in functions under
influxql provide the
selection,aggregation, and transformation functions
from the InfluxQL language.
MapReduce may be applied to either a batch or a stream edge. In the case of a batch each batch is passed to the mapper idependently. In the case of a stream all incoming data points that have the exact same time are combined into a batch and sent to the mapper.
Create a new node that samples the incoming points or batches.
One point will be emitted every count or duration specified.
Perform the union of this node and all other given nodes.
Create a new node that filters the data stream by a given expression.
Create a new node that windows the stream by time.
NOTE: Window can only be applied to stream edges.