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 org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.knowm.yank.Yank;
  18 import org.openhab.core.items.Item;
  19 import org.openhab.core.types.State;
  20 import org.openhab.persistence.jdbc.dto.ItemVO;
  21 import org.openhab.persistence.jdbc.dto.ItemsVO;
  22 import org.openhab.persistence.jdbc.utils.StringUtilsExt;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * Extended Database Configuration class. Class represents
  28  * the extended database-specific configuration. Overrides and supplements the
  29  * default settings from JdbcBaseDAO. Enter only the differences to JdbcBaseDAO here.
  30  *
  31  * @author Helmut Lehmeyer - Initial contribution
  32  */
  33 @NonNullByDefault
  34 public class JdbcHsqldbDAO extends JdbcBaseDAO {
  35     private final Logger logger = LoggerFactory.getLogger(JdbcHsqldbDAO.class);
  36
  37     /********
  38      * INIT *
  39      ********/
  40     public JdbcHsqldbDAO() {
  41         super();
  42         initSqlQueries();
  43         initSqlTypes();
  44         initDbProps();
  45     }
  46
  47     private void initSqlQueries() {
  48         logger.debug("JDBC::initSqlQueries: '{}'", this.getClass().getSimpleName());
  49         // http://hsqldb.org/doc/guide/builtinfunctions-chapt.html
  50         sqlPingDB = "SELECT 1 FROM INFORMATION_SCHEMA.SYSTEM_USERS";
  51         sqlGetDB = "SELECT DATABASE () FROM INFORMATION_SCHEMA.SYSTEM_USERS";
  52         sqlIfTableExists = "SELECT * FROM INFORMATION_SCHEMA.SYSTEM_TABLES WHERE TABLE_NAME='#searchTable#'";
  53         sqlCreateItemsTableIfNot = "CREATE TABLE IF NOT EXISTS #itemsManageTable# ( ItemId INT GENERATED BY DEFAULT AS IDENTITY (START WITH 1, INCREMENT BY 1) NOT NULL, #colname# #coltype# NOT NULL)";
  54         sqlCreateNewEntryInItemsTable = "INSERT INTO #itemsManageTable# (ItemName) VALUES ('#itemname#')";
  55         // Prevent error against duplicate time value
  56         // http://hsqldb.org/doc/guide/dataaccess-chapt.html#dac_merge_statement
  57         // SQL_INSERT_ITEM_VALUE = "INSERT INTO #tableName# (TIME, VALUE) VALUES( NOW(), CAST( ? as #dbType#) )";
  58         sqlInsertItemValue = "MERGE INTO #tableName# "
  59                 + "USING (VALUES #tablePrimaryValue#, CAST( ? as #dbType#)) temp (TIME, VALUE) ON (#tableName#.TIME=temp.TIME) "
  60                 + "WHEN NOT MATCHED THEN INSERT (TIME, VALUE) VALUES (temp.TIME, temp.VALUE)";
  61     }
  62
  63     /**
  64      * INFO: http://www.java2s.com/Code/Java/Database-SQL-JDBC/StandardSQLDataTypeswithTheirJavaEquivalents.htm
  65      */
  66     private void initSqlTypes() {
  67     }
  68
  69     /**
  70      * INFO: https://github.com/brettwooldridge/HikariCP
  71      */
  72     private void initDbProps() {
  73         // Properties for HikariCP
  74         databaseProps.setProperty("driverClassName", "org.hsqldb.jdbcDriver");
  75     }
  76
  77     /**************
  78      * ITEMS DAOs *
  79      **************/
  80     @Override
  81     public @Nullable Integer doPingDB() {
  82         return Yank.queryScalar(sqlPingDB, (Class<@Nullable Integer>) Integer.class, null);
  83     }
  84
  85     @Override
  86     public ItemsVO doCreateItemsTableIfNot(ItemsVO vo) {
  87         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemsTableIfNot,
  88                 new String[] { "#itemsManageTable#", "#colname#", "#coltype#", "#itemsManageTable#" },
  89                 new String[] { vo.getItemsManageTable(), vo.getColname(), vo.getColtype(), vo.getItemsManageTable() });
  90         logger.debug("JDBC::doCreateItemsTableIfNot sql={}", sql);
  91         Yank.execute(sql, null);
  92         return vo;
  93     }
  94
  95     @Override
  96     public Long doCreateNewEntryInItemsTable(ItemsVO vo) {
  97         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateNewEntryInItemsTable,
  98                 new String[] { "#itemsManageTable#", "#itemname#" },
  99                 new String[] { vo.getItemsManageTable(), vo.getItemname() });
 100         logger.debug("JDBC::doCreateNewEntryInItemsTable sql={}", sql);
 101         return Yank.insert(sql, null);
 102     }
 103
 104     /*************
 105      * ITEM DAOs *
 106      *************/
 107     @Override
 108     public void doStoreItemValue(Item item, State itemState, ItemVO vo) {
 109         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 110         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 111                 new String[] { "#tableName#", "#dbType#", "#tableName#", "#tablePrimaryValue#" },
 112                 new String[] { storedVO.getTableName(), storedVO.getDbType(), storedVO.getTableName(),
 113                         sqlTypes.get("tablePrimaryValue") });
 114         Object[] params = new Object[] { storedVO.getValue() };
 115         logger.debug("JDBC::doStoreItemValue sql={} value='{}'", sql, storedVO.getValue());
 116         Yank.execute(sql, params);
 117     }
 118
 119     /****************************
 120      * SQL generation Providers *
 121      ****************************/
 122
 123     /*****************
 124      * H E L P E R S *
 125      *****************/
 126
 127     /******************************
 128      * public Getters and Setters *
 129      ******************************/
 130 }