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

   1 /**
   2  * Copyright (c) 2010-2022 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.jdbc.db;
  14
  15 import java.time.ZoneId;
  16 import java.util.List;
  17 import java.util.Objects;
  18 import java.util.stream.Collectors;
  19
  20 import javax.measure.Quantity;
  21 import javax.measure.Unit;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.knowm.yank.Yank;
  26 import org.openhab.core.items.Item;
  27 import org.openhab.core.library.items.NumberItem;
  28 import org.openhab.core.persistence.FilterCriteria;
  29 import org.openhab.core.persistence.FilterCriteria.Ordering;
  30 import org.openhab.core.persistence.HistoricItem;
  31 import org.openhab.core.types.State;
  32 import org.openhab.persistence.jdbc.dto.ItemVO;
  33 import org.openhab.persistence.jdbc.dto.ItemsVO;
  34 import org.openhab.persistence.jdbc.dto.JdbcHistoricItem;
  35 import org.openhab.persistence.jdbc.utils.StringUtilsExt;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Extended Database Configuration class. Class represents
  41  * the extended database-specific configuration. Overrides and supplements the
  42  * default settings from JdbcBaseDAO. Enter only the differences to JdbcBaseDAO here.
  43  *
  44  * @author Helmut Lehmeyer - Initial contribution
  45  */
  46 @NonNullByDefault
  47 public class JdbcDerbyDAO extends JdbcBaseDAO {
  48     private static final String DRIVER_CLASS_NAME = org.apache.derby.jdbc.EmbeddedDriver.class.getName();
  49     @SuppressWarnings("unused")
  50     private static final String DATA_SOURCE_CLASS_NAME = org.apache.derby.jdbc.EmbeddedDataSource.class.getName();
  51
  52     private final Logger logger = LoggerFactory.getLogger(JdbcDerbyDAO.class);
  53
  54     /********
  55      * INIT *
  56      ********/
  57     public JdbcDerbyDAO() {
  58         initSqlTypes();
  59         initDbProps();
  60         initSqlQueries();
  61     }
  62
  63     private void initSqlQueries() {
  64         logger.debug("JDBC::initSqlQueries: '{}'", this.getClass().getSimpleName());
  65         sqlPingDB = "values 1";
  66         sqlGetDB = "VALUES SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY( 'DataDictionaryVersion' )"; // returns version
  67         sqlIfTableExists = "SELECT * FROM SYS.SYSTABLES WHERE TABLENAME='#searchTable#'";
  68         sqlCreateItemsTableIfNot = "CREATE TABLE #itemsManageTable# ( ItemId INTEGER NOT NULL GENERATED ALWAYS AS IDENTITY (START WITH 1, INCREMENT BY 1), #colname# #coltype# NOT NULL)";
  69         sqlCreateItemTable = "CREATE TABLE #tableName# (time #tablePrimaryKey# NOT NULL, value #dbType#, PRIMARY KEY(time))";
  70         // Prevent error against duplicate time value (seldom): No powerful Merge found:
  71         // http://www.codeproject.com/Questions/162627/how-to-insert-new-record-in-my-table-if-not-exists
  72         sqlInsertItemValue = "INSERT INTO #tableName# (TIME, VALUE) VALUES( #tablePrimaryValue#, CAST( ? as #dbType#) )";
  73     }
  74
  75     private void initSqlTypes() {
  76         sqlTypes.put("DATETIMEITEM", "TIMESTAMP");
  77         sqlTypes.put("DIMMERITEM", "SMALLINT");
  78         sqlTypes.put("IMAGEITEM", "VARCHAR(32000)");
  79         sqlTypes.put("ROLLERSHUTTERITEM", "SMALLINT");
  80         sqlTypes.put("STRINGITEM", "VARCHAR(32000)");
  81         sqlTypes.put("tablePrimaryValue", "CURRENT_TIMESTAMP");
  82         logger.debug("JDBC::initSqlTypes: Initialized the type array sqlTypes={}", sqlTypes.values());
  83     }
  84
  85     /**
  86      * INFO: https://github.com/brettwooldridge/HikariCP
  87      */
  88     private void initDbProps() {
  89         // Properties for HikariCP
  90         // Use driverClassName
  91         databaseProps.setProperty("driverClassName", DRIVER_CLASS_NAME);
  92         // OR dataSourceClassName
  93         // databaseProps.setProperty("dataSourceClassName", DATA_SOURCE_CLASS_NAME);
  94         databaseProps.setProperty("maximumPoolSize", "1");
  95         databaseProps.setProperty("minimumIdle", "1");
  96     }
  97
  98     @Override
  99     public void initAfterFirstDbConnection() {
 100         logger.debug("JDBC::initAfterFirstDbConnection: Initializing step, after db is connected.");
 101         // Initialize sqlTypes, depending on DB version for example
 102         // derby does not like this... dbMeta = new DbMetaData();// get DB information
 103     }
 104
 105     /**************
 106      * ITEMS DAOs *
 107      **************/
 108     @Override
 109     public @Nullable Integer doPingDB() {
 110         return Yank.queryScalar(sqlPingDB, Integer.class, null);
 111     }
 112
 113     @Override
 114     public boolean doIfTableExists(ItemsVO vo) {
 115         String sql = StringUtilsExt.replaceArrayMerge(sqlIfTableExists, new String[] { "#searchTable#" },
 116                 new String[] { vo.getItemsManageTable().toUpperCase() });
 117         logger.debug("JDBC::doIfTableExists sql={}", sql);
 118         final @Nullable String result = Yank.queryScalar(sql, String.class, null);
 119         return Objects.nonNull(result);
 120     }
 121
 122     @Override
 123     public Long doCreateNewEntryInItemsTable(ItemsVO vo) {
 124         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateNewEntryInItemsTable,
 125                 new String[] { "#itemsManageTable#", "#itemname#" },
 126                 new String[] { vo.getItemsManageTable().toUpperCase(), vo.getItemname() });
 127         logger.debug("JDBC::doCreateNewEntryInItemsTable sql={}", sql);
 128         return Yank.insert(sql, null);
 129     }
 130
 131     @Override
 132     public ItemsVO doCreateItemsTableIfNot(ItemsVO vo) {
 133         // boolean tableExists = Yank.queryScalar(SQL_IF_TABLE_EXISTS.replace("#searchTable#",
 134         // vo.getItemsManageTable().toUpperCase()), String.class, null) == null;
 135         boolean tableExists = doIfTableExists(vo);
 136         if (!tableExists) {
 137             String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemsTableIfNot,
 138                     new String[] { "#itemsManageTable#", "#colname#", "#coltype#" },
 139                     new String[] { vo.getItemsManageTable().toUpperCase(), vo.getColname(), vo.getColtype() });
 140             logger.debug("JDBC::doCreateItemsTableIfNot tableExists={} therefore sql={}", tableExists, sql);
 141             Yank.execute(sql, null);
 142         } else {
 143             logger.debug("JDBC::doCreateItemsTableIfNot tableExists={}, did not CREATE TABLE", tableExists);
 144         }
 145         return vo;
 146     }
 147
 148     /*************
 149      * ITEM DAOs *
 150      *************/
 151     @Override
 152     public void doCreateItemTable(ItemVO vo) {
 153         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemTable,
 154                 new String[] { "#tableName#", "#dbType#", "#tablePrimaryKey#" },
 155                 new String[] { vo.getTableName(), vo.getDbType(), sqlTypes.get("tablePrimaryKey") });
 156         Yank.execute(sql, null);
 157     }
 158
 159     @Override
 160     public void doStoreItemValue(Item item, State itemState, ItemVO vo) {
 161         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 162         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 163                 new String[] { "#tableName#", "#dbType#", "#tablePrimaryValue#" },
 164                 new String[] { storedVO.getTableName().toUpperCase(), storedVO.getDbType(),
 165                         sqlTypes.get("tablePrimaryValue") });
 166         Object[] params = { storedVO.getValue() };
 167         logger.debug("JDBC::doStoreItemValue sql={} value='{}'", sql, storedVO.getValue());
 168         Yank.execute(sql, params);
 169     }
 170
 171     @Override
 172     public List<HistoricItem> doGetHistItemFilterQuery(Item item, FilterCriteria filter, int numberDecimalcount,
 173             String table, String name, ZoneId timeZone) {
 174         String sql = histItemFilterQueryProvider(filter, numberDecimalcount, table, name, timeZone);
 175         List<Object[]> m = Yank.queryObjectArrays(sql, null);
 176         logger.debug("JDBC::doGetHistItemFilterQuery got Array length={}", m.size());
 177         // we already retrieve the unit here once as it is a very costly operation
 178         String itemName = item.getName();
 179         Unit<? extends Quantity<?>> unit = item instanceof NumberItem ? ((NumberItem) item).getUnit() : null;
 180         return m.stream().map(o -> {
 181             logger.debug("JDBC::doGetHistItemFilterQuery 0='{}' 1='{}'", o[0], o[1]);
 182             return new JdbcHistoricItem(itemName, objectAsState(item, unit, o[1]), objectAsZonedDateTime(o[0]));
 183         }).collect(Collectors.<HistoricItem> toList());
 184     }
 185
 186     /****************************
 187      * SQL generation Providers *
 188      ****************************/
 189
 190     @Override
 191     protected String histItemFilterQueryProvider(FilterCriteria filter, int numberDecimalcount, String table,
 192             String simpleName, ZoneId timeZone) {
 193         logger.debug(
 194                 "JDBC::getHistItemFilterQueryProvider filter = {}, numberDecimalcount = {}, table = {}, simpleName = {}",
 195                 StringUtilsExt.filterToString(filter), numberDecimalcount, table, simpleName);
 196
 197         String filterString = "";
 198         if (filter.getBeginDate() != null) {
 199             filterString += filterString.isEmpty() ? " WHERE" : " AND";
 200             filterString += " TIME>'" + JDBC_DATE_FORMAT.format(filter.getBeginDate().withZoneSameInstant(timeZone))
 201                     + "'";
 202         }
 203         if (filter.getEndDate() != null) {
 204             filterString += filterString.isEmpty() ? " WHERE" : " AND";
 205             filterString += " TIME<'" + JDBC_DATE_FORMAT.format(filter.getEndDate().withZoneSameInstant(timeZone))
 206                     + "'";
 207         }
 208         filterString += (filter.getOrdering() == Ordering.ASCENDING) ? " ORDER BY time ASC" : " ORDER BY time DESC";
 209         if (filter.getPageSize() != 0x7fffffff) {
 210             // TODO: TESTING!!!
 211             // filterString += " LIMIT " + filter.getPageNumber() *
 212             // filter.getPageSize() + "," + filter.getPageSize();
 213             // SELECT time, value FROM ohscriptfiles_sw_ace_paths_0001 ORDER BY
 214             // time DESC OFFSET 1 ROWS FETCH NEXT 0 ROWS ONLY
 215             // filterString += " OFFSET " + filter.getPageSize() +" ROWS FETCH
 216             // FIRST||NEXT " + filter.getPageNumber() * filter.getPageSize() + "
 217             // ROWS ONLY";
 218             filterString += " OFFSET " + filter.getPageSize() + " ROWS FETCH FIRST "
 219                     + (filter.getPageNumber() * filter.getPageSize() + 1) + " ROWS ONLY";
 220         }
 221
 222         // http://www.seemoredata.com/en/showthread.php?132-Round-function-in-Apache-Derby
 223         // simulated round function in Derby: CAST(value 0.0005 AS DECIMAL(15,3))
 224         // simulated round function in Derby: "CAST(value 0.0005 AS DECIMAL(15,"+numberDecimalcount+"))"
 225
 226         String queryString = "SELECT time,";
 227         if ("NUMBERITEM".equalsIgnoreCase(simpleName) && numberDecimalcount > -1) {
 228             // rounding HALF UP
 229             queryString += "CAST(value 0.";
 230             for (int i = 0; i < numberDecimalcount; i++) {
 231                 queryString += "0";
 232             }
 233             queryString += "5 AS DECIMAL(31," + numberDecimalcount + "))"; // 31 is DECIMAL max precision
 234                                                                            // https://db.apache.org/derby/docs/10.0/manuals/develop/develop151.html
 235         } else {
 236             queryString += " value FROM " + table.toUpperCase();
 237         }
 238
 239         if (!filterString.isEmpty()) {
 240             queryString += filterString;
 241         }
 242         logger.debug("JDBC::query queryString = {}", queryString);
 243         return queryString;
 244     }
 245
 246     /*****************
 247      * H E L P E R S *
 248      *****************/
 249
 250     /******************************
 251      * public Getters and Setters *
 252      ******************************/
 253 }