Query Utilities

Classes and utilities for working with TempoIQ’s query interface.

Query Builder

class tempoiq.protocol.query.builder.QueryBuilder(client, object_type)

Class to build queries. All instance methods in this class return the instance itself. This allows you to construct queries fluently, by chaining method calls.

aggregate(function)

Aggregate the data in the query with the specified aggregation function

convert_timezone(tz)

Convert the result’s data points to the specified time zone.

Parameters:tz (String) – Time zone

delete(**kwargs)

Execute an API call to delete the objects that are a result of this query. Currently only supported for deleting entire devices. equivalent to passing this QueryBuilder to tempoiq.client.Client.delete_device()

filter(selector)

Filter the query based on the provided selector. The argument may be a ScalarSelector or the result of combining several selectors with or_() or and_().

Parameters:selector –

interpolate(function, period, start=None, end=None)

Interpolate the sensor data

Parameters:

• function (String) – Interpolation function (“zoh” or “linear”)
• period (String) – Time period to interpolate

latest(include_selection=False)

Deprecated. Use the single() call instead.

multi_rollup(functions, period, start=None)

Apply multiple rollups to the same sensor data.

Parameters:

• functions (list) – list of rollup functions to apply
• period (String) – Time period of the rollups

read(**kwargs)

Make the API call to the TempoIQ backend for this query.

Parameters:

• start (DateTime) – required when reading sensor data. Start of time range to read.
• end (DateTime) – required when reading sensor data. End of time range to read.

rollup(function, period, start=None)

Apply a rollup function to the query.

Parameters:

• function (String) – The rollup function to apply
• period (String) – The time period of the rollup
• start (DateTime) – (optional) A timestamp to use as the start of

the first rollup period. Default is the same as the start of the read.

single(self2, *args, **kwargs)

Make a single-point API call to the TempoIQ backend for this query.

Parameters:

• function (String) – Method for finding the point to return for each sensor. Ex: earliest, latest, before, after
• timestamp (DateTime) – required for all functions except earliest

Query Functions

Selectors

class tempoiq.protocol.query.selection.ScalarSelector(selection_type, key, value)

A condition to filter on. The recommended way to construct a ScalarSelector is with the == operator on a selectable field, e.g:

selector = (Device.attributes['model'] == "v1")
selector2 = (Sensor.key == "humidity")

tempoiq.protocol.query.selection.and_(selectors)

Returns a selector that’s the AND of all provided selectors.

Parameters:selectors (List of ScalarSelector) –

tempoiq.protocol.query.selection.or_(selectors)

Returns a selector that’s the OR of all provided selectors.

Parameters:selectors (List of ScalarSelector) –