Package io.openems.shared.influxdb.proxy

Class InfluxQlProxy

java.lang.Object

io.openems.shared.influxdb.proxy.QueryProxy

io.openems.shared.influxdb.proxy.InfluxQlProxy

public class InfluxQlProxy
extends QueryProxy

Implements queries using InfluxQL, which is reported to be faster than Flux: https://github.com/influxdata/influxdb/issues/18088.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	InfluxQlProxy.Average
static final record	InfluxQlProxy.Pair<A,B>

Nested classes/interfaces inherited from class io.openems.shared.influxdb.proxy.QueryProxy

QueryProxy.RandomLimit

Field Summary

Fields inherited from class io.openems.shared.influxdb.proxy.QueryProxy

AVAILABLE_SINCE_COLUMN_NAME, AVAILABLE_SINCE_MEASUREMENT, CHANNEL_TAG, queryLimit, tag

Constructor Summary

Constructors

Constructor	Description
InfluxQlProxy(String tag)

Method Summary

Modifier and Type	Method	Description
protected String	buildFetchAvailableSinceQuery(String bucket)
protected String	buildFetchFirstValueBefore(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime date, Set<ChannelAddress> channels)
protected String	buildHistoricDataQuery(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)
String	buildHistoricEnergyPerPeriodQuery(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)
protected String	buildHistoricEnergyPerPeriodQuerySingleValueInDay(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)
String	buildHistoricEnergyQuery(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)
protected String	buildHistoricEnergyQuerySingleValueInDay(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)
Map<Integer,Map<String,Long>>	queryAvailableSince(InfluxConnector.InfluxConnection influxConnection, String bucket)	Queries the available since fields from the database.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryFirstValueBefore(String bucket, InfluxConnector.InfluxConnection influxConnection, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime date, Set<ChannelAddress> channels)	Queries the first values before the given date.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricData(InfluxConnector.InfluxConnection influxConnection, String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)	CommonTimedataService.queryHistoricData(String, io.openems.common.jsonrpc.request.QueryHistoricTimeseriesDataRequest).
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryHistoricEnergy(InfluxConnector.InfluxConnection influxConnection, String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)	CommonTimedataService.queryHistoricEnergy(String, ZonedDateTime, ZonedDateTime, Set).
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricEnergyPerPeriod(InfluxConnector.InfluxConnection influxConnection, String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)	CommonTimedataService.queryHistoricEnergyPerPeriod(String, ZonedDateTime, ZonedDateTime, Set, Resolution).
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryHistoricEnergySingleValueInDay(InfluxConnector.InfluxConnection influxConnection, String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)	Queries the historic energy values with a measurement which only has one value saved per day.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryRawHistoricEnergyPerPeriodSingleValueInDay(InfluxConnector.InfluxConnection influxConnection, String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)	Queries the raw historic values without calculating the difference between two values also includes the first value before the time range to help calculating the differences.

Methods inherited from class io.openems.shared.influxdb.proxy.QueryProxy

assertQueryLimit, flux, from, influxQl, isLimitReached

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InfluxQlProxy

public InfluxQlProxy(String tag)

Method Details

queryHistoricEnergy

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryHistoricEnergy(InfluxConnector.InfluxConnection influxConnection,
 String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels)
                                                                          throws OpenemsError.OpenemsNamedException

Description copied from class: QueryProxy

CommonTimedataService.queryHistoricEnergy(String, ZonedDateTime, ZonedDateTime, Set).

Specified by:

queryHistoricEnergy in class QueryProxy

Parameters:

influxConnection - a Influx-Connection

bucket - the bucket name; 'database/retentionPolicy' for InfluxDB v1

measurement - the influx measurement

influxEdgeId - the Edge-ID

fromDate - the From-Date

toDate - the To-Date

channels - the ChannelAddresses

Returns:

the query result

Throws:

OpenemsError.OpenemsNamedException - on error

queryHistoricEnergySingleValueInDay

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryHistoricEnergySingleValueInDay(InfluxConnector.InfluxConnection influxConnection,
 String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels)
                                                                                          throws OpenemsError.OpenemsNamedException

Description copied from class: QueryProxy

Queries the historic energy values with a measurement which only has one value saved per day.

Specified by:

queryHistoricEnergySingleValueInDay in class QueryProxy

Parameters:

influxConnection - a Influx-Connection

bucket - the bucket name; 'database/retentionPolicy' for InfluxDB v1

measurement - the influx measurement

influxEdgeId - the Edge-ID

fromDate - the From-Date

toDate - the To-Date

channels - the ChannelAddresses

Returns:

the query result

Throws:

OpenemsError.OpenemsNamedException - on error

queryHistoricData

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricData(InfluxConnector.InfluxConnection influxConnection,
 String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution)
                                                                                                 throws OpenemsError.OpenemsNamedException

Description copied from class: QueryProxy

CommonTimedataService.queryHistoricData(String, io.openems.common.jsonrpc.request.QueryHistoricTimeseriesDataRequest).

Specified by:

queryHistoricData in class QueryProxy

Parameters:

influxConnection - a Influx-Connection

bucket - the bucket name; 'database/retentionPolicy' for InfluxDB v1

measurement - the influx measurement

influxEdgeId - the Edge-ID

fromDate - the From-Date

toDate - the To-Date

channels - the ChannelAddresses

resolution - the Resolution

Returns:

the query result

Throws:

OpenemsError.OpenemsNamedException - on error

queryHistoricEnergyPerPeriod

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricEnergyPerPeriod(InfluxConnector.InfluxConnection influxConnection,
 String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution)
                                                                                                            throws OpenemsError.OpenemsNamedException

Description copied from class: QueryProxy

CommonTimedataService.queryHistoricEnergyPerPeriod(String, ZonedDateTime, ZonedDateTime, Set, Resolution).

Specified by:

queryHistoricEnergyPerPeriod in class QueryProxy

Parameters:

influxConnection - a Influx-Connection

bucket - the bucket name; 'database/retentionPolicy' for InfluxDB v1

measurement - the influx measurement

influxEdgeId - the Edge-ID

fromDate - the From-Date

toDate - the To-Date

channels - the ChannelAddresses

resolution - the Resolution

Returns:

the query result

Throws:

OpenemsError.OpenemsNamedException - on error

queryRawHistoricEnergyPerPeriodSingleValueInDay

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryRawHistoricEnergyPerPeriodSingleValueInDay(InfluxConnector.InfluxConnection influxConnection,
 String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution)
                                                                                                                               throws OpenemsError.OpenemsNamedException

Description copied from class: QueryProxy

Queries the raw historic values without calculating the difference between two values also includes the first value before the time range to help calculating the differences.

Specified by:

queryRawHistoricEnergyPerPeriodSingleValueInDay in class QueryProxy

Parameters:

influxConnection - a Influx-Connection

bucket - the bucket name; 'database/retentionPolicy' for InfluxDB v1

measurement - the influx measurement

influxEdgeId - the Edge-ID

fromDate - the From-Date

toDate - the To-Date

channels - the ChannelAddresses

resolution - the Resolution

Returns:

the query result

Throws:

OpenemsError.OpenemsNamedException - on error

queryAvailableSince

public Map<Integer,Map<String,Long>> queryAvailableSince(InfluxConnector.InfluxConnection influxConnection,
 String bucket)
                                                  throws OpenemsError.OpenemsNamedException

Description copied from class: QueryProxy

Queries the available since fields from the database.

Specified by:

queryAvailableSince in class QueryProxy

Parameters:

influxConnection - a Influx-Connection

bucket - the bucket name; 'database/retentionPolicy' for InfluxDB v1

Returns:

the map where the key is the edgeId and the value the timestamp of available since

Throws:

OpenemsError.OpenemsNamedException

queryFirstValueBefore

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryFirstValueBefore(String bucket,
 InfluxConnector.InfluxConnection influxConnection,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime date,
 Set<ChannelAddress> channels)
                                                                            throws OpenemsError.OpenemsNamedException

Description copied from class: QueryProxy

Queries the first values before the given date.

Specified by:

queryFirstValueBefore in class QueryProxy

Parameters:

bucket - the bucket name; 'database/retentionPolicy' for InfluxDB v1

influxConnection - a Influx-Connection

measurement - the influx measurement

influxEdgeId - the Edge-ID

date - the bounding date exclusive

channels - the ChannelAddresses

Returns:

the values

Throws:

OpenemsError.OpenemsNamedException

buildHistoricDataQuery

protected String buildHistoricDataQuery(String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution)
                                 throws OpenemsException

Specified by:

buildHistoricDataQuery in class QueryProxy

Throws:

OpenemsException

buildHistoricEnergyQuery

public String buildHistoricEnergyQuery(String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels)
                                throws OpenemsException

Specified by:

buildHistoricEnergyQuery in class QueryProxy

Throws:

OpenemsException

buildHistoricEnergyQuerySingleValueInDay

protected String buildHistoricEnergyQuerySingleValueInDay(String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels)
                                                   throws OpenemsException

Specified by:

buildHistoricEnergyQuerySingleValueInDay in class QueryProxy

Throws:

OpenemsException

buildHistoricEnergyPerPeriodQuery

public String buildHistoricEnergyPerPeriodQuery(String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution)
                                         throws OpenemsException

Specified by:

buildHistoricEnergyPerPeriodQuery in class QueryProxy

Throws:

OpenemsException

buildHistoricEnergyPerPeriodQuerySingleValueInDay

protected String buildHistoricEnergyPerPeriodQuerySingleValueInDay(String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution)
                                                            throws OpenemsException

Specified by:

buildHistoricEnergyPerPeriodQuerySingleValueInDay in class QueryProxy

Throws:

OpenemsException

buildFetchAvailableSinceQuery

protected String buildFetchAvailableSinceQuery(String bucket)

Specified by:

buildFetchAvailableSinceQuery in class QueryProxy

buildFetchFirstValueBefore

protected String buildFetchFirstValueBefore(String bucket,
 String measurement,
 Optional<Integer> influxEdgeId,
 ZonedDateTime date,
 Set<ChannelAddress> channels)

Specified by:

buildFetchFirstValueBefore in class QueryProxy