git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   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
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.persistence.influxdb.internal.influx2;
  14
  15 import static com.influxdb.query.dsl.functions.restriction.Restrictions.measurement;
  16 import static com.influxdb.query.dsl.functions.restriction.Restrictions.tag;
  17 import static org.openhab.persistence.influxdb.internal.InfluxDBConstants.*;
  18 import static org.openhab.persistence.influxdb.internal.InfluxDBStateConvertUtils.stateToObject;
  19
  20 import java.time.temporal.ChronoUnit;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.openhab.core.items.MetadataRegistry;
  24 import org.openhab.core.persistence.FilterCriteria;
  25 import org.openhab.persistence.influxdb.internal.FilterCriteriaQueryCreator;
  26 import org.openhab.persistence.influxdb.internal.InfluxDBConfiguration;
  27 import org.openhab.persistence.influxdb.internal.InfluxDBMetadataUtils;
  28 import org.openhab.persistence.influxdb.internal.InfluxDBVersion;
  29
  30 import com.influxdb.query.dsl.Flux;
  31 import com.influxdb.query.dsl.functions.RangeFlux;
  32 import com.influxdb.query.dsl.functions.restriction.Restrictions;
  33
  34 /**
  35  * Implementation of {@link FilterCriteriaQueryCreator} for InfluxDB 2.0
  36  *
  37  * @author Joan Pujol Espinar - Initial contribution
  38  */
  39 @NonNullByDefault
  40 public class Influx2FilterCriteriaQueryCreatorImpl implements FilterCriteriaQueryCreator {
  41
  42     private InfluxDBConfiguration configuration;
  43     private MetadataRegistry metadataRegistry;
  44
  45     public Influx2FilterCriteriaQueryCreatorImpl(InfluxDBConfiguration configuration,
  46             MetadataRegistry metadataRegistry) {
  47         this.configuration = configuration;
  48         this.metadataRegistry = metadataRegistry;
  49     }
  50
  51     @Override
  52     public String createQuery(FilterCriteria criteria, String retentionPolicy) {
  53         Flux flux = Flux.from(retentionPolicy);
  54
  55         RangeFlux range = flux.range();
  56         if (criteria.getBeginDate() != null) {
  57             range = range.withStart(criteria.getBeginDate().toInstant());
  58         } else {
  59             range = flux.range(-100L, ChronoUnit.YEARS); // Flux needs a mandatory start range
  60         }
  61         if (criteria.getEndDate() != null) {
  62             range = range.withStop(criteria.getEndDate().toInstant());
  63         }
  64         flux = range;
  65
  66         String itemName = criteria.getItemName();
  67         if (itemName != null) {
  68             String measurementName = calculateMeasurementName(itemName);
  69             boolean needsToUseItemTagName = !measurementName.equals(itemName);
  70
  71             flux = flux.filter(measurement().equal(measurementName));
  72             if (needsToUseItemTagName) {
  73                 flux = flux.filter(tag(TAG_ITEM_NAME).equal(itemName));
  74             }
  75
  76             if (needsToUseItemTagName) {
  77                 flux = flux.keep(new String[] { FIELD_MEASUREMENT_NAME, COLUMN_TIME_NAME_V2, COLUMN_VALUE_NAME_V2,
  78                         TAG_ITEM_NAME });
  79             } else {
  80                 flux = flux.keep(new String[] { FIELD_MEASUREMENT_NAME, COLUMN_TIME_NAME_V2, COLUMN_VALUE_NAME_V2 });
  81             }
  82         }
  83
  84         if (criteria.getState() != null && criteria.getOperator() != null) {
  85             Restrictions restrictions = Restrictions.and(Restrictions.field().equal(FIELD_VALUE_NAME),
  86                     Restrictions.value().custom(stateToObject(criteria.getState()),
  87                             getOperationSymbol(criteria.getOperator(), InfluxDBVersion.V2)));
  88             flux = flux.filter(restrictions);
  89         }
  90
  91         flux = applyOrderingAndPageSize(criteria, flux);
  92
  93         return flux.toString();
  94     }
  95
  96     private Flux applyOrderingAndPageSize(FilterCriteria criteria, Flux flux) {
  97         var lastOptimization = criteria.getOrdering() == FilterCriteria.Ordering.DESCENDING
  98                 && criteria.getPageSize() == 1;
  99
 100         if (lastOptimization) {
 101             flux = flux.last();
 102         } else {
 103             if (criteria.getOrdering() != null) {
 104                 boolean desc = criteria.getOrdering() == FilterCriteria.Ordering.DESCENDING;
 105                 flux = flux.sort().withDesc(desc).withColumns(new String[] { COLUMN_TIME_NAME_V2 });
 106             }
 107
 108             if (criteria.getPageSize() != Integer.MAX_VALUE) {
 109                 flux = flux.limit(criteria.getPageSize()).withPropertyValue("offset",
 110                         criteria.getPageNumber() * criteria.getPageSize());
 111             }
 112         }
 113         return flux;
 114     }
 115
 116     private String calculateMeasurementName(String itemName) {
 117         String name = itemName;
 118
 119         name = InfluxDBMetadataUtils.calculateMeasurementNameFromMetadataIfPresent(metadataRegistry, name, itemName);
 120
 121         if (configuration.isReplaceUnderscore()) {
 122             name = name.replace('_', '.');
 123         }
 124
 125         return name;
 126     }
 127 }