2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.persistence.influxdb.internal.influx1;
15 import static org.influxdb.querybuilder.BuiltQuery.QueryBuilder.*;
16 import static org.openhab.persistence.influxdb.internal.InfluxDBConstants.*;
17 import static org.openhab.persistence.influxdb.internal.InfluxDBStateConvertUtils.stateToObject;
19 import org.eclipse.jdt.annotation.NonNullByDefault;
20 import org.eclipse.jdt.annotation.Nullable;
21 import org.influxdb.dto.Query;
22 import org.influxdb.querybuilder.BuiltQuery;
23 import org.influxdb.querybuilder.Select;
24 import org.influxdb.querybuilder.Where;
25 import org.influxdb.querybuilder.clauses.SimpleClause;
26 import org.openhab.core.items.MetadataRegistry;
27 import org.openhab.core.persistence.FilterCriteria;
28 import org.openhab.persistence.influxdb.internal.FilterCriteriaQueryCreator;
29 import org.openhab.persistence.influxdb.internal.InfluxDBConfiguration;
30 import org.openhab.persistence.influxdb.internal.InfluxDBMetadataUtils;
31 import org.openhab.persistence.influxdb.internal.InfluxDBVersion;
34 * Implementation of {@link FilterCriteriaQueryCreator} for InfluxDB 1.0
36 * @author Joan Pujol Espinar - Initial contribution
39 public class Influx1FilterCriteriaQueryCreatorImpl implements FilterCriteriaQueryCreator {
41 private InfluxDBConfiguration configuration;
42 private MetadataRegistry metadataRegistry;
44 public Influx1FilterCriteriaQueryCreatorImpl(InfluxDBConfiguration configuration,
45 MetadataRegistry metadataRegistry) {
46 this.configuration = configuration;
47 this.metadataRegistry = metadataRegistry;
51 public String createQuery(FilterCriteria criteria, String retentionPolicy) {
52 final String tableName;
53 final String itemName = criteria.getItemName();
54 boolean hasCriteriaName = itemName != null;
56 tableName = calculateTableName(itemName);
58 Select select = select().column("\"" + COLUMN_VALUE_NAME_V1 + "\"::field")
59 .column("\"" + TAG_ITEM_NAME + "\"::tag")
60 .fromRaw(null, fullQualifiedTableName(retentionPolicy, tableName, hasCriteriaName));
62 Where where = select.where();
64 if (itemName != null && !tableName.equals(itemName)) {
65 where = where.and(BuiltQuery.QueryBuilder.eq(TAG_ITEM_NAME, itemName));
68 if (criteria.getBeginDate() != null) {
70 BuiltQuery.QueryBuilder.gte(COLUMN_TIME_NAME_V1, criteria.getBeginDate().toInstant().toString()));
72 if (criteria.getEndDate() != null) {
74 BuiltQuery.QueryBuilder.lte(COLUMN_TIME_NAME_V1, criteria.getEndDate().toInstant().toString()));
77 if (criteria.getState() != null && criteria.getOperator() != null) {
78 where = where.and(new SimpleClause(COLUMN_VALUE_NAME_V1,
79 getOperationSymbol(criteria.getOperator(), InfluxDBVersion.V1),
80 stateToObject(criteria.getState())));
83 if (criteria.getOrdering() == FilterCriteria.Ordering.DESCENDING) {
84 select = select.orderBy(desc());
85 } else if (criteria.getOrdering() == FilterCriteria.Ordering.ASCENDING) {
86 select = select.orderBy(asc());
89 if (criteria.getPageSize() != Integer.MAX_VALUE) {
90 if (criteria.getPageNumber() != 0) {
91 select = select.limit(criteria.getPageSize(), criteria.getPageSize() * criteria.getPageNumber());
93 select = select.limit(criteria.getPageSize());
97 final Query query = (Query) select;
98 return query.getCommand();
101 private String calculateTableName(@Nullable String itemName) {
102 if (itemName == null) {
106 String name = itemName;
108 name = InfluxDBMetadataUtils.calculateMeasurementNameFromMetadataIfPresent(metadataRegistry, name, itemName);
110 if (configuration.isReplaceUnderscore()) {
111 name = name.replace('_', '.');
117 private String fullQualifiedTableName(String retentionPolicy, String tableName, boolean escapeTableName) {
118 StringBuilder sb = new StringBuilder();
119 sb.append('"').append(retentionPolicy).append('"');
121 if (escapeTableName) {
122 sb.append('"').append(tableName).append('"');
124 sb.append(tableName);
126 return sb.toString();