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