statunits¶
Delayed evaluations for filtering property status data
Synopsis¶
statunits
Arguments:
ds: dataset name
tm: optional time delay control option, in seconds, float as string
rq_id: ID of request series
filter: optional name of applying filter
- conditions: optional list of applying condition descriptors
in JSON string representation
dtree: optional name of applying decision tree
code: optional code of applying decision tree
no: optional position on tree, int as string
- units: list of property names
list of strings in JSON string representation
- ctx: optional, context descriptor
in JSON string representation
Return value:
{dictionary"rq-id": ID of request series, string"units": evaluated status reports}
Description¶
Requests of this type initiates Status report mechanism (with delays) and form series of requests initiated by request ds_stat or dtree_stat, see details in references.
rq_id argument should be get from result of initiation request. Arguments filter, conditions or dtree, code, no should be the same as in initiation request.
Returning data must contain status report for first property (the first entry in units as property name), other properties can be not evaluated if there is no enough time (see details for argument tm in references).
In case of WS-dataset the request provides status report construction for special name "_tags" as "name of unit". Tags are not subect of filtration process, however status report for tags can be useful in logic of Front-End application. The status report for this case is simpler than Property Status structure, it contains only name and variants properties. See Zone descriptor for details.
If ctx argument contains option "druid-rq": 1 (see details here):
only single unit name is expected in units argument
only context of XL-dataset is expected
the return value for this special case is Druid JSON representation of the request
Note: Function filtering properties are not subject of the request, use statfunc instead.
See also¶
Status report mechanism (with delays)