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