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

   1 /**
   2  * Copyright (c) 2010-2024 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.internal.db;
  14
  15 import java.time.ZonedDateTime;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.knowm.yank.Yank;
  20 import org.knowm.yank.exceptions.YankSQLException;
  21 import org.openhab.core.items.Item;
  22 import org.openhab.core.types.State;
  23 import org.openhab.persistence.jdbc.internal.dto.ItemVO;
  24 import org.openhab.persistence.jdbc.internal.dto.ItemsVO;
  25 import org.openhab.persistence.jdbc.internal.exceptions.JdbcSQLException;
  26 import org.openhab.persistence.jdbc.internal.utils.StringUtilsExt;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 /**
  31  * Extended Database Configuration class. Class represents
  32  * the extended database-specific configuration. Overrides and supplements the
  33  * default settings from JdbcBaseDAO. Enter only the differences to JdbcBaseDAO here.
  34  *
  35  * @author Helmut Lehmeyer - Initial contribution
  36  */
  37 @NonNullByDefault
  38 public class JdbcHsqldbDAO extends JdbcBaseDAO {
  39     private static final String DRIVER_CLASS_NAME = org.hsqldb.jdbcDriver.class.getName();
  40     @SuppressWarnings("unused")
  41     private static final String DATA_SOURCE_CLASS_NAME = org.hsqldb.jdbc.JDBCDataSource.class.getName();
  42
  43     private final Logger logger = LoggerFactory.getLogger(JdbcHsqldbDAO.class);
  44
  45     /********
  46      * INIT *
  47      ********/
  48     public JdbcHsqldbDAO() {
  49         initSqlQueries();
  50         initSqlTypes();
  51         initDbProps();
  52     }
  53
  54     private void initSqlQueries() {
  55         logger.debug("JDBC::initSqlQueries: '{}'", this.getClass().getSimpleName());
  56         // http://hsqldb.org/doc/guide/builtinfunctions-chapt.html
  57         sqlPingDB = "SELECT 1 FROM INFORMATION_SCHEMA.SYSTEM_USERS";
  58         sqlGetDB = "SELECT DATABASE () FROM INFORMATION_SCHEMA.SYSTEM_USERS";
  59         sqlIfTableExists = "SELECT * FROM INFORMATION_SCHEMA.SYSTEM_TABLES WHERE TABLE_NAME='#searchTable#'";
  60         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)";
  61         sqlCreateNewEntryInItemsTable = "INSERT INTO #itemsManageTable# (ItemName) VALUES ('#itemname#')";
  62         // Prevent error against duplicate time value
  63         // http://hsqldb.org/doc/guide/dataaccess-chapt.html#dac_merge_statement
  64         // SQL_INSERT_ITEM_VALUE = "INSERT INTO #tableName# (TIME, VALUE) VALUES( NOW(), CAST( ? as #dbType#) )";
  65         sqlInsertItemValue = """
  66                 MERGE INTO #tableName# \
  67                 USING (VALUES #tablePrimaryValue#, CAST( ? as #dbType#)) temp (TIME, VALUE) ON (#tableName#.TIME=temp.TIME) \
  68                 WHEN NOT MATCHED THEN INSERT (TIME, VALUE) VALUES (temp.TIME, temp.VALUE)\
  69                 """;
  70     }
  71
  72     /**
  73      * INFO: http://www.java2s.com/Code/Java/Database-SQL-JDBC/StandardSQLDataTypeswithTheirJavaEquivalents.htm
  74      */
  75     private void initSqlTypes() {
  76     }
  77
  78     /**
  79      * INFO: https://github.com/brettwooldridge/HikariCP
  80      */
  81     private void initDbProps() {
  82         // Properties for HikariCP
  83         databaseProps.setProperty("driverClassName", DRIVER_CLASS_NAME);
  84         // driverClassName OR BETTER USE dataSourceClassName
  85         // databaseProps.setProperty("dataSourceClassName", DATA_SOURCE_CLASS_NAME);
  86     }
  87
  88     /**************
  89      * ITEMS DAOs *
  90      **************/
  91     @Override
  92     public @Nullable Integer doPingDB() throws JdbcSQLException {
  93         try {
  94             return Yank.queryScalar(sqlPingDB, Integer.class, null);
  95         } catch (YankSQLException e) {
  96             throw new JdbcSQLException(e);
  97         }
  98     }
  99
 100     @Override
 101     public ItemsVO doCreateItemsTableIfNot(ItemsVO vo) throws JdbcSQLException {
 102         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemsTableIfNot,
 103                 new String[] { "#itemsManageTable#", "#colname#", "#coltype#", "#itemsManageTable#" },
 104                 new String[] { vo.getItemsManageTable(), vo.getColname(), vo.getColtype(), vo.getItemsManageTable() });
 105         logger.debug("JDBC::doCreateItemsTableIfNot sql={}", sql);
 106         try {
 107             Yank.execute(sql, null);
 108         } catch (YankSQLException e) {
 109             throw new JdbcSQLException(e);
 110         }
 111         return vo;
 112     }
 113
 114     @Override
 115     public Long doCreateNewEntryInItemsTable(ItemsVO vo) throws JdbcSQLException {
 116         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateNewEntryInItemsTable,
 117                 new String[] { "#itemsManageTable#", "#itemname#" },
 118                 new String[] { vo.getItemsManageTable(), vo.getItemName() });
 119         logger.debug("JDBC::doCreateNewEntryInItemsTable sql={}", sql);
 120         try {
 121             return Yank.insert(sql, null);
 122         } catch (YankSQLException e) {
 123             throw new JdbcSQLException(e);
 124         }
 125     }
 126
 127     /*************
 128      * ITEM DAOs *
 129      *************/
 130     @Override
 131     public void doStoreItemValue(Item item, State itemState, ItemVO vo) throws JdbcSQLException {
 132         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 133         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 134                 new String[] { "#tableName#", "#dbType#", "#tableName#", "#tablePrimaryValue#" },
 135                 new String[] { storedVO.getTableName(), storedVO.getDbType(), storedVO.getTableName(),
 136                         sqlTypes.get("tablePrimaryValue") });
 137         Object[] params = { storedVO.getValue() };
 138         logger.debug("JDBC::doStoreItemValue sql={} value='{}'", sql, storedVO.getValue());
 139         try {
 140             Yank.execute(sql, params);
 141         } catch (YankSQLException e) {
 142             throw new JdbcSQLException(e);
 143         }
 144     }
 145
 146     @Override
 147     public void doStoreItemValue(Item item, State itemState, ItemVO vo, ZonedDateTime date) throws JdbcSQLException {
 148         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 149         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 150                 new String[] { "#tableName#", "#dbType#", "#tableName#", "#tablePrimaryValue#" },
 151                 new String[] { storedVO.getTableName(), storedVO.getDbType(), storedVO.getTableName(), "?" });
 152         java.sql.Timestamp timestamp = new java.sql.Timestamp(date.toInstant().toEpochMilli());
 153         Object[] params = { timestamp, storedVO.getValue() };
 154         logger.debug("JDBC::doStoreItemValue sql={} timestamp={} value='{}'", sql, timestamp, storedVO.getValue());
 155         try {
 156             Yank.execute(sql, params);
 157         } catch (YankSQLException e) {
 158             throw new JdbcSQLException(e);
 159         }
 160     }
 161
 162     /****************************
 163      * SQL generation Providers *
 164      ****************************/
 165
 166     /*****************
 167      * H E L P E R S *
 168      *****************/
 169
 170     /******************************
 171      * public Getters and Setters *
 172      ******************************/
 173 }