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