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 import java.util.Objects;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.openhab.core.persistence.FilterCriteria;
  25 import org.openhab.core.types.State;
  26 import org.openhab.persistence.influxdb.internal.FilterCriteriaQueryCreator;
  27 import org.openhab.persistence.influxdb.internal.InfluxDBConfiguration;
  28 import org.openhab.persistence.influxdb.internal.InfluxDBMetadataService;
  29 import org.openhab.persistence.influxdb.internal.InfluxDBVersion;
  30
  31 import com.influxdb.query.dsl.Flux;
  32 import com.influxdb.query.dsl.functions.RangeFlux;
  33 import com.influxdb.query.dsl.functions.restriction.Restrictions;
  34
  35 /**
  36  * Implementation of {@link FilterCriteriaQueryCreator} for InfluxDB 2.0
  37  *
  38  * @author Joan Pujol Espinar - Initial contribution
  39  */
  40 @NonNullByDefault
  41 public class InfluxDB2FilterCriteriaQueryCreatorImpl implements FilterCriteriaQueryCreator {
  42     private final InfluxDBConfiguration configuration;
  43     private final InfluxDBMetadataService influxDBMetadataService;
  44
  45     public InfluxDB2FilterCriteriaQueryCreatorImpl(InfluxDBConfiguration configuration,
  46             InfluxDBMetadataService influxDBMetadataService) {
  47         this.configuration = configuration;
  48         this.influxDBMetadataService = influxDBMetadataService;
  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.withStart(criteria.getBeginDate().toInstant());
  58         } else {
  59             range.withStart(-100L, ChronoUnit.YEARS); // Flux needs a mandatory start range
  60         }
  61         if (criteria.getEndDate() != null) {
  62             range.withStop(criteria.getEndDate().toInstant());
  63         } else {
  64             range.withStop(100L, ChronoUnit.YEARS);
  65         }
  66         flux = range;
  67
  68         String itemName = Objects.requireNonNull(criteria.getItemName()); // we checked non-null before
  69         String name = influxDBMetadataService.getMeasurementNameOrDefault(itemName, itemName);
  70         String measurementName = configuration.isReplaceUnderscore() ? name.replace('_', '.') : name;
  71         flux = flux.filter(measurement().equal(measurementName));
  72         if (!measurementName.equals(itemName)) {
  73             flux = flux.filter(tag(TAG_ITEM_NAME).equal(itemName));
  74             flux = flux.keep(
  75                     new String[] { FIELD_MEASUREMENT_NAME, COLUMN_TIME_NAME_V2, COLUMN_VALUE_NAME_V2, TAG_ITEM_NAME });
  76         } else {
  77             flux = flux.keep(new String[] { FIELD_MEASUREMENT_NAME, COLUMN_TIME_NAME_V2, COLUMN_VALUE_NAME_V2 });
  78         }
  79
  80         State filterState = criteria.getState();
  81         if (filterState != null && criteria.getOperator() != null) {
  82             Restrictions restrictions = Restrictions.and(Restrictions.field().equal(FIELD_VALUE_NAME),
  83                     Restrictions.value().custom(stateToObject(filterState),
  84                             getOperationSymbol(criteria.getOperator(), InfluxDBVersion.V2)));
  85             flux = flux.filter(restrictions);
  86         }
  87
  88         flux = applyOrderingAndPageSize(criteria, flux);
  89
  90         return flux.toString();
  91     }
  92
  93     private Flux applyOrderingAndPageSize(FilterCriteria criteria, Flux flux) {
  94         var lastOptimization = criteria.getOrdering() == FilterCriteria.Ordering.DESCENDING
  95                 && criteria.getPageSize() == 1;
  96
  97         if (lastOptimization) {
  98             flux = flux.last();
  99         } else {
 100             if (criteria.getOrdering() != null) {
 101                 boolean desc = criteria.getOrdering() == FilterCriteria.Ordering.DESCENDING;
 102                 flux = flux.sort().withDesc(desc).withColumns(new String[] { COLUMN_TIME_NAME_V2 });
 103             }
 104
 105             if (criteria.getPageSize() != Integer.MAX_VALUE) {
 106                 flux = flux.limit(criteria.getPageSize()).withPropertyValue("offset",
 107                         criteria.getPageNumber() * criteria.getPageSize());
 108             }
 109         }
 110         return flux;
 111     }
 112 }