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

   1 /**
   2  * Copyright (c) 2010-2023 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 = "MERGE INTO #tableName# "
  66                 + "USING (VALUES #tablePrimaryValue#, CAST( ? as #dbType#)) temp (TIME, VALUE) ON (#tableName#.TIME=temp.TIME) "
  67                 + "WHEN NOT MATCHED THEN INSERT (TIME, VALUE) VALUES (temp.TIME, temp.VALUE)";
  68     }
  69
  70     /**
  71      * INFO: http://www.java2s.com/Code/Java/Database-SQL-JDBC/StandardSQLDataTypeswithTheirJavaEquivalents.htm
  72      */
  73     private void initSqlTypes() {
  74     }
  75
  76     /**
  77      * INFO: https://github.com/brettwooldridge/HikariCP
  78      */
  79     private void initDbProps() {
  80         // Properties for HikariCP
  81         databaseProps.setProperty("driverClassName", DRIVER_CLASS_NAME);
  82         // driverClassName OR BETTER USE dataSourceClassName
  83         // databaseProps.setProperty("dataSourceClassName", DATA_SOURCE_CLASS_NAME);
  84     }
  85
  86     /**************
  87      * ITEMS DAOs *
  88      **************/
  89     @Override
  90     public @Nullable Integer doPingDB() throws JdbcSQLException {
  91         try {
  92             return Yank.queryScalar(sqlPingDB, Integer.class, null);
  93         } catch (YankSQLException e) {
  94             throw new JdbcSQLException(e);
  95         }
  96     }
  97
  98     @Override
  99     public ItemsVO doCreateItemsTableIfNot(ItemsVO vo) throws JdbcSQLException {
 100         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemsTableIfNot,
 101                 new String[] { "#itemsManageTable#", "#colname#", "#coltype#", "#itemsManageTable#" },
 102                 new String[] { vo.getItemsManageTable(), vo.getColname(), vo.getColtype(), vo.getItemsManageTable() });
 103         logger.debug("JDBC::doCreateItemsTableIfNot sql={}", sql);
 104         try {
 105             Yank.execute(sql, null);
 106         } catch (YankSQLException e) {
 107             throw new JdbcSQLException(e);
 108         }
 109         return vo;
 110     }
 111
 112     @Override
 113     public Long doCreateNewEntryInItemsTable(ItemsVO vo) throws JdbcSQLException {
 114         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateNewEntryInItemsTable,
 115                 new String[] { "#itemsManageTable#", "#itemname#" },
 116                 new String[] { vo.getItemsManageTable(), vo.getItemName() });
 117         logger.debug("JDBC::doCreateNewEntryInItemsTable sql={}", sql);
 118         try {
 119             return Yank.insert(sql, null);
 120         } catch (YankSQLException e) {
 121             throw new JdbcSQLException(e);
 122         }
 123     }
 124
 125     /*************
 126      * ITEM DAOs *
 127      *************/
 128     @Override
 129     public void doStoreItemValue(Item item, State itemState, ItemVO vo) throws JdbcSQLException {
 130         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 131         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 132                 new String[] { "#tableName#", "#dbType#", "#tableName#", "#tablePrimaryValue#" },
 133                 new String[] { storedVO.getTableName(), storedVO.getDbType(), storedVO.getTableName(),
 134                         sqlTypes.get("tablePrimaryValue") });
 135         Object[] params = { storedVO.getValue() };
 136         logger.debug("JDBC::doStoreItemValue sql={} value='{}'", sql, storedVO.getValue());
 137         try {
 138             Yank.execute(sql, params);
 139         } catch (YankSQLException e) {
 140             throw new JdbcSQLException(e);
 141         }
 142     }
 143
 144     @Override
 145     public void doStoreItemValue(Item item, State itemState, ItemVO vo, ZonedDateTime date) throws JdbcSQLException {
 146         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 147         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 148                 new String[] { "#tableName#", "#dbType#", "#tableName#", "#tablePrimaryValue#" },
 149                 new String[] { storedVO.getTableName(), storedVO.getDbType(), storedVO.getTableName(), "?" });
 150         java.sql.Timestamp timestamp = new java.sql.Timestamp(date.toInstant().toEpochMilli());
 151         Object[] params = { timestamp, storedVO.getValue() };
 152         logger.debug("JDBC::doStoreItemValue sql={} timestamp={} value='{}'", sql, timestamp, storedVO.getValue());
 153         try {
 154             Yank.execute(sql, params);
 155         } catch (YankSQLException e) {
 156             throw new JdbcSQLException(e);
 157         }
 158     }
 159
 160     /****************************
 161      * SQL generation Providers *
 162      ****************************/
 163
 164     /*****************
 165      * H E L P E R S *
 166      *****************/
 167
 168     /******************************
 169      * public Getters and Setters *
 170      ******************************/
 171 }