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