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