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

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