Package io.openems.shared.influxdb.proxy

Class QueryProxy

java.lang.Object

io.openems.shared.influxdb.proxy.QueryProxy

Direct Known Subclasses:

FluxProxy, InfluxQlProxy

public abstract class QueryProxy
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryProxy.RandomLimit

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AVAILABLE_SINCE_COLUMN_NAME
static final String	AVAILABLE_SINCE_MEASUREMENT
static final String	CHANNEL_TAG
final QueryProxy.RandomLimit	queryLimit
protected final String	tag

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueryProxy(String tag)

Method Summary

Modifier and Type	Method	Description
protected void	assertQueryLimit()
protected abstract String	buildFetchAvailableSinceQuery(String bucket)
protected abstract String	buildFetchFirstValueBefore(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime date, Set<ChannelAddress> channels)
protected abstract String	buildHistoricDataQuery(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)
protected abstract String	buildHistoricEnergyPerPeriodQuery(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)
protected abstract String	buildHistoricEnergyPerPeriodQuerySingleValueInDay(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)
protected abstract String	buildHistoricEnergyQuery(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)
protected abstract String	buildHistoricEnergyQuerySingleValueInDay(String bucket, String measurement, Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)
static QueryProxy	flux(String tag)	Builds a FluxProxy.
static QueryProxy	from(QueryLanguageConfig config, String tag)	Builds a QueryProxy from a QueryLanguageConfig.
static QueryProxy	influxQl(String tag)	Builds a InfluxQlProxy.
boolean	isLimitReached()
abstract Map<Integer,Map<String,Long>>	queryAvailableSince(InfluxConnector.InfluxConnection influxConnection, String bucket)	Queries the available since fields from the database.
abstract 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.
abstract 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).
abstract 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).
abstract 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).
abstract 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.
abstract 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 java.lang.Object

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

Field Details

CHANNEL_TAG

public static final String CHANNEL_TAG

See Also:

• Constant Field Values

AVAILABLE_SINCE_MEASUREMENT

public static final String AVAILABLE_SINCE_MEASUREMENT

See Also:

• Constant Field Values

AVAILABLE_SINCE_COLUMN_NAME

public static final String AVAILABLE_SINCE_COLUMN_NAME

See Also:

• Constant Field Values

tag

protected final String tag

queryLimit

public final QueryProxy.RandomLimit queryLimit

Constructor Details

QueryProxy

protected QueryProxy(String tag)

Method Details

from

public static QueryProxy from(QueryLanguageConfig config,
 String tag)

Builds a QueryProxy from a QueryLanguageConfig.

Parameters:

config - a QueryLanguageConfig

tag - the InfluxDB tag

Returns:

a QueryProxy instance

flux

public static QueryProxy flux(String tag)

Builds a FluxProxy.

Parameters:

tag - the InfluxDB tag

Returns:

a FluxProxy

influxQl

public static QueryProxy influxQl(String tag)

Builds a InfluxQlProxy.

Parameters:

tag - the InfluxDB tag

Returns:

a InfluxQlProxy

queryHistoricEnergy

public abstract 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

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

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 abstract 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

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

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 abstract 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

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

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 abstract 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

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

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 abstract 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

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.

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 abstract Map<Integer,Map<String,Long>> queryAvailableSince(InfluxConnector.InfluxConnection influxConnection,
 String bucket)
                                                           throws OpenemsError.OpenemsNamedException

Queries the available since fields from the database.

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 abstract 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

Queries the first values before the given date.

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

isLimitReached

public boolean isLimitReached()

assertQueryLimit

protected void assertQueryLimit()
                         throws OpenemsException

Throws:

OpenemsException

buildHistoricDataQuery

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

Throws:

OpenemsException

buildHistoricEnergyQuery

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

Throws:

OpenemsException

buildHistoricEnergyQuerySingleValueInDay

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

Throws:

OpenemsException

buildHistoricEnergyPerPeriodQuery

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

Throws:

OpenemsException

buildHistoricEnergyPerPeriodQuerySingleValueInDay

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

Throws:

OpenemsException

buildFetchAvailableSinceQuery

protected abstract String buildFetchAvailableSinceQuery(String bucket)

buildFetchFirstValueBefore

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