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 static final String DRIVER_CLASS_NAME = org.hsqldb.jdbcDriver.class.getName();
  36     @SuppressWarnings("unused")
  37     private static final String DATA_SOURCE_CLASS_NAME = org.hsqldb.jdbc.JDBCDataSource.class.getName();
  38
  39     private final Logger logger = LoggerFactory.getLogger(JdbcHsqldbDAO.class);
  40
  41     /********
  42      * INIT *
  43      ********/
  44     public JdbcHsqldbDAO() {
  45         initSqlQueries();
  46         initSqlTypes();
  47         initDbProps();
  48     }
  49
  50     private void initSqlQueries() {
  51         logger.debug("JDBC::initSqlQueries: '{}'", this.getClass().getSimpleName());
  52         // http://hsqldb.org/doc/guide/builtinfunctions-chapt.html
  53         sqlPingDB = "SELECT 1 FROM INFORMATION_SCHEMA.SYSTEM_USERS";
  54         sqlGetDB = "SELECT DATABASE () FROM INFORMATION_SCHEMA.SYSTEM_USERS";
  55         sqlIfTableExists = "SELECT * FROM INFORMATION_SCHEMA.SYSTEM_TABLES WHERE TABLE_NAME='#searchTable#'";
  56         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)";
  57         sqlCreateNewEntryInItemsTable = "INSERT INTO #itemsManageTable# (ItemName) VALUES ('#itemname#')";
  58         // Prevent error against duplicate time value
  59         // http://hsqldb.org/doc/guide/dataaccess-chapt.html#dac_merge_statement
  60         // SQL_INSERT_ITEM_VALUE = "INSERT INTO #tableName# (TIME, VALUE) VALUES( NOW(), CAST( ? as #dbType#) )";
  61         sqlInsertItemValue = "MERGE INTO #tableName# "
  62                 + "USING (VALUES #tablePrimaryValue#, CAST( ? as #dbType#)) temp (TIME, VALUE) ON (#tableName#.TIME=temp.TIME) "
  63                 + "WHEN NOT MATCHED THEN INSERT (TIME, VALUE) VALUES (temp.TIME, temp.VALUE)";
  64     }
  65
  66     /**
  67      * INFO: http://www.java2s.com/Code/Java/Database-SQL-JDBC/StandardSQLDataTypeswithTheirJavaEquivalents.htm
  68      */
  69     private void initSqlTypes() {
  70     }
  71
  72     /**
  73      * INFO: https://github.com/brettwooldridge/HikariCP
  74      */
  75     private void initDbProps() {
  76         // Properties for HikariCP
  77         databaseProps.setProperty("driverClassName", DRIVER_CLASS_NAME);
  78         // driverClassName OR BETTER USE dataSourceClassName
  79         // databaseProps.setProperty("dataSourceClassName", DATA_SOURCE_CLASS_NAME);
  80     }
  81
  82     /**************
  83      * ITEMS DAOs *
  84      **************/
  85     @Override
  86     public @Nullable Integer doPingDB() {
  87         return Yank.queryScalar(sqlPingDB, Integer.class, null);
  88     }
  89
  90     @Override
  91     public ItemsVO doCreateItemsTableIfNot(ItemsVO vo) {
  92         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemsTableIfNot,
  93                 new String[] { "#itemsManageTable#", "#colname#", "#coltype#", "#itemsManageTable#" },
  94                 new String[] { vo.getItemsManageTable(), vo.getColname(), vo.getColtype(), vo.getItemsManageTable() });
  95         logger.debug("JDBC::doCreateItemsTableIfNot sql={}", sql);
  96         Yank.execute(sql, null);
  97         return vo;
  98     }
  99
 100     @Override
 101     public Long doCreateNewEntryInItemsTable(ItemsVO vo) {
 102         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateNewEntryInItemsTable,
 103                 new String[] { "#itemsManageTable#", "#itemname#" },
 104                 new String[] { vo.getItemsManageTable(), vo.getItemname() });
 105         logger.debug("JDBC::doCreateNewEntryInItemsTable sql={}", sql);
 106         return Yank.insert(sql, null);
 107     }
 108
 109     /*************
 110      * ITEM DAOs *
 111      *************/
 112     @Override
 113     public void doStoreItemValue(Item item, State itemState, ItemVO vo) {
 114         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 115         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 116                 new String[] { "#tableName#", "#dbType#", "#tableName#", "#tablePrimaryValue#" },
 117                 new String[] { storedVO.getTableName(), storedVO.getDbType(), storedVO.getTableName(),
 118                         sqlTypes.get("tablePrimaryValue") });
 119         Object[] params = { storedVO.getValue() };
 120         logger.debug("JDBC::doStoreItemValue sql={} value='{}'", sql, storedVO.getValue());
 121         Yank.execute(sql, params);
 122     }
 123
 124     /****************************
 125      * SQL generation Providers *
 126      ****************************/
 127
 128     /*****************
 129      * H E L P E R S *
 130      *****************/
 131
 132     /******************************
 133      * public Getters and Setters *
 134      ******************************/
 135 }