# InfluxDB (0.9 and newer) Persistence
-This service allows you to persist and query states using the [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) and [InfluxDB 2.0](https://v2.docs.influxdata.com/v2.0/) time series database. The persisted values can be queried from within openHAB. There also are nice tools on the web for visualizing InfluxDB time series, such as [Grafana](http://grafana.org/).
+This service allows you to persist and query states using the [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) and [InfluxDB 2.0](https://v2.docs.influxdata.com/v2.0/) time series database. The persisted values can be queried from within openHAB.
+There also are nice tools on the web for visualizing InfluxDB time series, such as [Grafana](http://grafana.org/) and new Influx DB 2.0 version introduces [powerful data processing features.](https://docs.influxdata.com/influxdb/v2.0/process-data/get-started/)
## Database Structure
- This service allows you to persist and query states using the time series database.
- The states of an item are persisted in *measurements* points with names equal to the name of the item, or the alias, if one is provided. In both variants, a *tag* named "item" is added, containing the item name.
- All values are stored in a *field* called "value" using integers or doubles if possible,`OnOffType` and `OpenClosedType` values are stored using 0 or 1.
-- If configured extra tags for item category, label or type can be added fore each point.
+ All values are stored in a *field* called "value" using the following types:
+ - **float** for DecimalType and QuantityType
+ - **integer** for `OnOffType` and `OpenClosedType` (values are stored using 0 or 1) and `DateTimeType` (milliseconds since 1970-01-01T00:00:00Z)
+ - **string** for the rest of types
+
+- If configured, extra tags for item category, label or type can be added fore each point.
Some example entries for an item with the name "speedtest" without any further configuration would look like this:
} else if (state instanceof PointType) {
value = point2String((PointType) state);
} else if (state instanceof DecimalType) {
- value = convertBigDecimalToNum(((DecimalType) state).toBigDecimal());
+ value = ((DecimalType) state).toBigDecimal();
} else if (state instanceof QuantityType<?>) {
- value = convertBigDecimalToNum(((QuantityType<?>) state).toBigDecimal());
+ value = ((QuantityType<?>) state).toBigDecimal();
} else if (state instanceof OnOffType) {
value = state == OnOffType.ON ? DIGITAL_VALUE_ON : DIGITAL_VALUE_OFF;
} else if (state instanceof OpenClosedType) {
}
return buf.toString(); // latitude, longitude, altitude
}
-
- /**
- * This method returns an integer if possible if not a double is returned. This is an optimization
- * for influxdb because integers have less overhead.
- *
- * @param value the BigDecimal to be converted
- * @return A double if possible else a double is returned.
- */
- private static Object convertBigDecimalToNum(BigDecimal value) {
- Object convertedValue;
- if (value.scale() == 0) {
- convertedValue = value.toBigInteger();
- } else {
- convertedValue = value.doubleValue();
- }
- return convertedValue;
- }
}
return new InfluxPoint(this);
}
}
+
+ @Override
+ public String toString() {
+ return "InfluxPoint{" + "measurementName='" + measurementName + '\'' + ", time=" + time + ", value=" + value
+ + ", tags=" + tags + '}';
+ }
}
<parameter name="url" type="text" required="true" groupName="connection">
<context>url</context>
<label>Database URL</label>
- <description>The database URL, e.g. http://127.0.0.1:8086 or http://127.0.0.1:9999</description>
+ <description>The database URL, e.g. http://127.0.0.1:8086</description>
<default>http://127.0.0.1:8086</default>
</parameter>
public static Map<String, @Nullable Object> createValidConfigurationParameters() {
Map<String, @Nullable Object> config = new HashMap<>();
- config.put(URL_PARAM, "http://localhost:9999");
+ config.put(URL_PARAM, "http://localhost:8086");
config.put(VERSION_PARAM, InfluxDBVersion.V2.name());
config.put(TOKEN_PARAM, "sampletoken");
config.put(DATABASE_PARAM, "openhab");
package org.openhab.persistence.influxdb.internal;
import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.*;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.is;
import java.math.BigDecimal;
import java.time.Instant;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
import org.openhab.core.library.items.ContactItem;
import org.openhab.core.library.items.DateTimeItem;
import org.openhab.core.library.items.NumberItem;
@Test
public void convertDecimalState() {
DecimalType decimalType = new DecimalType(new BigDecimal("1.12"));
- assertThat((Double) InfluxDBStateConvertUtils.stateToObject(decimalType), closeTo(1.12, 0.01));
+ assertThat(InfluxDBStateConvertUtils.stateToObject(decimalType), is(new BigDecimal("1.12")));
+ }
+
+ @Test
+ public void convertIntegerDecimalState() {
+ DecimalType decimalType = new DecimalType(12L);
+ assertThat(InfluxDBStateConvertUtils.stateToObject(decimalType), is(new BigDecimal("12")));
}
@Test
assertThat(InfluxDBStateConvertUtils.stateToObject(type), equalTo(nowInMillis));
}
- @Test
- public void convertDecimalToState() {
- BigDecimal val = new BigDecimal("1.12");
+ @ParameterizedTest
+ @ValueSource(strings = { "1.12", "25" })
+ public void convertDecimalToState(String number) {
+ BigDecimal val = new BigDecimal(number);
NumberItem item = new NumberItem("name");
assertThat(InfluxDBStateConvertUtils.objectToState(val, item), equalTo(new DecimalType(val)));
}
@NonNullByDefault
public class ItemTestHelper {
- public static NumberItem createNumberItem(String name, int value) {
+ public static NumberItem createNumberItem(String name, Number value) {
NumberItem numberItem = new NumberItem(name);
- numberItem.setState(new DecimalType(value));
+ if (value instanceof Integer || value instanceof Long)
+ numberItem.setState(new DecimalType(value.longValue()));
+ else
+ numberItem.setState(new DecimalType(value.doubleValue()));
return numberItem;
}
}
import static org.hamcrest.Matchers.*;
import static org.mockito.Mockito.when;
-import java.math.BigInteger;
+import java.math.BigDecimal;
import java.util.Map;
+import java.util.stream.Stream;
import org.eclipse.jdt.annotation.DefaultLocation;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.openhab.core.items.Metadata;
metadataRegistry = null;
}
- @Test
- public void convertBasicItem() {
- NumberItem item = ItemTestHelper.createNumberItem("myitem", 5);
+ @ParameterizedTest
+ @MethodSource
+ public void convertBasicItem(Number number) {
+ NumberItem item = ItemTestHelper.createNumberItem("myitem", number);
InfluxPoint point = instance.convert(item, null);
assertThat(point.getMeasurementName(), equalTo(item.getName()));
assertThat("Must Store item name", point.getTags(), hasEntry("item", item.getName()));
- assertThat(point.getValue(), equalTo(new BigInteger("5")));
+ assertThat(point.getValue(), equalTo(new BigDecimal(number.toString())));
+ }
+
+ private static Stream<Number> convertBasicItem() {
+ return Stream.of(5, 5.5, 5L);
}
@Test
projects / openhab-addons.git / commitdiff