...
This unit has 2 input ports:
do: Input events entering through this port will launch a new execution of the query, overriding the query that is already running.
stop: The reception of an event through this port stops the current query.
An event enters through the do port do port. Then, an event is sent to the init port init port to signal the start of the query. The query specified in the properties is executed. An event is sent through the data port for each result row.
The error port outputs an event every time there's an error running the query, retrieving new records, etc. The unit adds the field "action" to the output events with the value 'error', plus other standard error fields containing details about the error.
Finally, it is sent through the end port every time a query ends, be it after an error, or when there are no more results. These events are the same as the input events, without any modification.
Alternatively, if an event enters through the stop portstop port, the query ends.
...
Configuration
...
Output ports
Port | Description |
|---|---|
init | Outputs an event every time a new query is launched (on each input event). These events are the same as the input events, without any modification. |
data | Outputs an event for each query result row. The events generated are the input events extended with fields including the query results. Further required columns can be specified in the unit configuration options. |
error | Outputs an event every time there's an error running the query, retrieving new records, etc. The generated event is an input event enriched with standard error messages. |
end | Outputs an event every time a query ends, be it after an error, or when there are no more results. These events are the same as the input events, without any modification. |
stall | Outputs an event every time a query that was launched enters into stall mode. The generated event has the field 'eventdate' with the current Timestamp. |