Skip to main content

Dataflow

FINITE_PUBLISH

finite_publish(Stream s, Charstring flow) -> Stream
STABLE

Publish elements in stream s in data flow


FLOWS

flows( ) -> Bag of Record
STABLE

Get all current data flows


PUBLISH

publish(Stream s, Charstring flow) -> Stream
STABLE

Publish elements in stream s in data flow


publish(Stream s, Charstring flow, Record opts) -> Stream
STABLE

Publish elements in stream s in data flow with opts

ParameterDescription
sStream to publish
flowflow to publish on. It is possible to publish
              the flow at another peer in the federation using
`flow@peer` |

| s | opts Extra options for the behaviour of the flow.

              - `size (number)` size of buffer
- `block(boolean)` should producer block or shed old values when full
- `keep-alive(boolean)` should subscribers terminate when publisher terminates. |

PUBLISH:DEFINE

publish:define(Charstring name, Record opts) -> Object
STABLE

No description.


publish:define(Charstring name, Integer maxsize, Boolean block, Boolean keep_producer_alive) -> Object
STABLE

No description.


publish:define(Charstring name, Integer maxsize, Boolean block) -> Object
STABLE

No description.


PUMP:ACTIVE_FLOWS

pump:active_flows(Charstring name) -> Vector of Charstring
STABLE

No description.


SUBSCRIBE

subscribe(Charstring edge, Charstring flow) -> Object
DEPRECATED

Follow data flow on edge

This was deprecated in version 5.5.0.

Use subscribe("flow@edge")


subscribe(Charstring flow) -> Object
STABLE

Follow data published on flow

ParameterDescription
flowThe name of the dataflow to follow. To follow the flow on an edge, use a value like flow@edgename.

Return: all data that is published to the dataflow after the subscription has started.


SUBSCRIBE:MERGE

subscribe:merge(Vector of Charstring flows) -> Object
STABLE

Follow data published on flows

ParameterDescription
flowsA vector of names of dataflows to follow. To follow the flow on an edge, use a value like flow@edgename.

Return: all data that is published to any of dataflows, in one stream.


SUBSCRIBE:MERGE_TAGGED

subscribe:merge_tagged(Vector of Charstring flows) -> Object
STABLE

Follow data published on all flows

ParameterDescription
flowsA vector of names of dataflows to follow. To follow the flow on an edge, use a value like flow@edgename.

Return: all data that is published to any of dataflows, in one stream, each value tagged with flow name and timestamp.


SUBSCRIBE:PIVOT

subscribe:pivot(Vector of Charstring flows) -> Stream of Vector
STABLE

Follow data published on all flows

ParameterDescription
flowsA vector of names of dataflows to follow. To follow the flow on an edge, use a value like flow@edgename.

Return: all data that is published to any of dataflows, in vectors of values in the same order as the input vector


SUBSCRIBE:TS_PIVOT

subscribe:ts_pivot(Vector of Charstring flows) -> Stream of Timeval of Vector
STABLE

Follow data published on all flows, similar to subscribe:pivot, but with a timeval for each vector in the return stream.