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 java.time.ZoneId;
  16 import java.util.List;
  17
  18 import org.knowm.yank.Yank;
  19 import org.openhab.core.items.Item;
  20 import org.openhab.core.persistence.FilterCriteria;
  21 import org.openhab.core.persistence.FilterCriteria.Ordering;
  22 import org.openhab.core.types.State;
  23 import org.openhab.persistence.jdbc.dto.ItemVO;
  24 import org.openhab.persistence.jdbc.dto.ItemsVO;
  25 import org.openhab.persistence.jdbc.utils.StringUtilsExt;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 /**
  30  * Extended Database Configuration class. Class represents
  31  * the extended database-specific configuration. Overrides and supplements the
  32  * default settings from JdbcBaseDAO. Enter only the differences to JdbcBaseDAO here.
  33  *
  34  * @author Helmut Lehmeyer - Initial contribution
  35  */
  36 public class JdbcPostgresqlDAO extends JdbcBaseDAO {
  37     private final Logger logger = LoggerFactory.getLogger(JdbcPostgresqlDAO.class);
  38
  39     /********
  40      * INIT *
  41      ********/
  42     public JdbcPostgresqlDAO() {
  43         super();
  44         initSqlQueries();
  45         initSqlTypes();
  46         initDbProps();
  47     }
  48
  49     private void initSqlQueries() {
  50         logger.debug("JDBC::initSqlQueries: '{}'", this.getClass().getSimpleName());
  51         // System Information Functions: https://www.postgresql.org/docs/9.2/static/functions-info.html
  52         sqlGetDB = "SELECT CURRENT_DATABASE()";
  53         sqlIfTableExists = "SELECT * FROM PG_TABLES WHERE TABLENAME='#searchTable#'";
  54         sqlCreateItemsTableIfNot = "CREATE TABLE IF NOT EXISTS #itemsManageTable# (itemid SERIAL NOT NULL, #colname# #coltype# NOT NULL, CONSTRAINT #itemsManageTable#_pkey PRIMARY KEY (itemid))";
  55         sqlCreateNewEntryInItemsTable = "INSERT INTO items (itemname) SELECT itemname FROM #itemsManageTable# UNION VALUES ('#itemname#') EXCEPT SELECT itemname FROM items";
  56         sqlGetItemTables = "SELECT table_name FROM information_schema.tables WHERE table_type='BASE TABLE' AND table_schema=(SELECT table_schema "
  57                 + "FROM information_schema.tables WHERE table_type='BASE TABLE' AND table_name='#itemsManageTable#') AND NOT table_name='#itemsManageTable#'";
  58         // http://stackoverflow.com/questions/17267417/how-do-i-do-an-upsert-merge-insert-on-duplicate-update-in-postgresql
  59         // for later use, PostgreSql > 9.5 to prevent PRIMARY key violation use:
  60         // SQL_INSERT_ITEM_VALUE = "INSERT INTO #tableName# (TIME, VALUE) VALUES( NOW(), CAST( ? as #dbType#) ) ON
  61         // CONFLICT DO NOTHING";
  62         sqlInsertItemValue = "INSERT INTO #tableName# (TIME, VALUE) VALUES( #tablePrimaryValue#, CAST( ? as #dbType#) )";
  63     }
  64
  65     /**
  66      * INFO: http://www.java2s.com/Code/Java/Database-SQL-JDBC/StandardSQLDataTypeswithTheirJavaEquivalents.htm
  67      */
  68     private void initSqlTypes() {
  69         // Initialize the type array
  70         sqlTypes.put("CALLITEM", "VARCHAR");
  71         sqlTypes.put("COLORITEM", "VARCHAR");
  72         sqlTypes.put("CONTACTITEM", "VARCHAR");
  73         sqlTypes.put("DATETIMEITEM", "TIMESTAMP");
  74         sqlTypes.put("DIMMERITEM", "SMALLINT");
  75         sqlTypes.put("IMAGEITEM", "VARCHAR");
  76         sqlTypes.put("LOCATIONITEM", "VARCHAR");
  77         sqlTypes.put("NUMBERITEM", "DOUBLE PRECISION");
  78         sqlTypes.put("PLAYERITEM", "VARCHAR");
  79         sqlTypes.put("ROLLERSHUTTERITEM", "SMALLINT");
  80         sqlTypes.put("STRINGITEM", "VARCHAR");
  81         sqlTypes.put("SWITCHITEM", "VARCHAR");
  82         logger.debug("JDBC::initSqlTypes: Initialized the type array sqlTypes={}", sqlTypes.values());
  83     }
  84
  85     /**
  86      * INFO: https://github.com/brettwooldridge/HikariCP
  87      */
  88     private void initDbProps() {
  89         // Performance:
  90         // databaseProps.setProperty("dataSource.cachePrepStmts", "true");
  91         // databaseProps.setProperty("dataSource.prepStmtCacheSize", "250");
  92         // databaseProps.setProperty("dataSource.prepStmtCacheSqlLimit", "2048");
  93
  94         // Properties for HikariCP
  95         databaseProps.setProperty("driverClassName", "org.postgresql.Driver");
  96         // driverClassName OR BETTER USE dataSourceClassName
  97         // databaseProps.setProperty("dataSourceClassName", "org.postgresql.ds.PGSimpleDataSource");
  98         // databaseProps.setProperty("maximumPoolSize", "3");
  99         // databaseProps.setProperty("minimumIdle", "2");
 100     }
 101
 102     /**************
 103      * ITEMS DAOs *
 104      **************/
 105     @Override
 106     public ItemsVO doCreateItemsTableIfNot(ItemsVO vo) {
 107         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemsTableIfNot,
 108                 new String[] { "#itemsManageTable#", "#colname#", "#coltype#", "#itemsManageTable#" },
 109                 new String[] { vo.getItemsManageTable(), vo.getColname(), vo.getColtype(), vo.getItemsManageTable() });
 110         logger.debug("JDBC::doCreateItemsTableIfNot sql={}", sql);
 111         Yank.execute(sql, null);
 112         return vo;
 113     }
 114
 115     @Override
 116     public Long doCreateNewEntryInItemsTable(ItemsVO vo) {
 117         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateNewEntryInItemsTable,
 118                 new String[] { "#itemsManageTable#", "#itemname#" },
 119                 new String[] { vo.getItemsManageTable(), vo.getItemname() });
 120         logger.debug("JDBC::doCreateNewEntryInItemsTable sql={}", sql);
 121         return Yank.insert(sql, null);
 122     }
 123
 124     @Override
 125     public List<ItemsVO> doGetItemTables(ItemsVO vo) {
 126         String sql = StringUtilsExt.replaceArrayMerge(this.sqlGetItemTables,
 127                 new String[] { "#itemsManageTable#", "#itemsManageTable#" },
 128                 new String[] { vo.getItemsManageTable(), vo.getItemsManageTable() });
 129         this.logger.debug("JDBC::doGetItemTables sql={}", sql);
 130         return Yank.queryBeanList(sql, ItemsVO.class, null);
 131     }
 132
 133     /*************
 134      * ITEM DAOs *
 135      *************/
 136     @Override
 137     public void doStoreItemValue(Item item, State itemState, ItemVO vo) {
 138         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 139         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 140                 new String[] { "#tableName#", "#dbType#", "#tablePrimaryValue#" },
 141                 new String[] { storedVO.getTableName(), storedVO.getDbType(), sqlTypes.get("tablePrimaryValue") });
 142         Object[] params = new Object[] { storedVO.getValue() };
 143         logger.debug("JDBC::doStoreItemValue sql={} value='{}'", sql, storedVO.getValue());
 144         Yank.execute(sql, params);
 145     }
 146
 147     /****************************
 148      * SQL generation Providers *
 149      ****************************/
 150
 151     @Override
 152     protected String histItemFilterQueryProvider(FilterCriteria filter, int numberDecimalcount, String table,
 153             String simpleName, ZoneId timeZone) {
 154         logger.debug(
 155                 "JDBC::getHistItemFilterQueryProvider filter = {}, numberDecimalcount = {}, table = {}, simpleName = {}",
 156                 filter.toString(), numberDecimalcount, table, simpleName);
 157
 158         String filterString = "";
 159         if (filter.getBeginDate() != null) {
 160             filterString += filterString.isEmpty() ? " WHERE" : " AND";
 161             filterString += " TIME>'" + JDBC_DATE_FORMAT.format(filter.getBeginDate().withZoneSameInstant(timeZone))
 162                     + "'";
 163         }
 164         if (filter.getEndDate() != null) {
 165             filterString += filterString.isEmpty() ? " WHERE" : " AND";
 166             filterString += " TIME<'" + JDBC_DATE_FORMAT.format(filter.getEndDate().withZoneSameInstant(timeZone))
 167                     + "'";
 168         }
 169         filterString += (filter.getOrdering() == Ordering.ASCENDING) ? " ORDER BY time ASC" : " ORDER BY time DESC";
 170         if (filter.getPageSize() != 0x7fffffff) {
 171             // see:
 172             // http://www.jooq.org/doc/3.5/manual/sql-building/sql-statements/select-statement/limit-clause/
 173             filterString += " OFFSET " + filter.getPageNumber() * filter.getPageSize() + " LIMIT "
 174                     + filter.getPageSize();
 175         }
 176         String queryString = "NUMBERITEM".equalsIgnoreCase(simpleName) && numberDecimalcount > -1
 177                 ? "SELECT time, ROUND(CAST (value AS numeric)," + numberDecimalcount + ") FROM " + table
 178                 : "SELECT time, value FROM " + table;
 179         if (!filterString.isEmpty()) {
 180             queryString += filterString;
 181         }
 182         logger.debug("JDBC::query queryString = {}", queryString);
 183         return queryString;
 184     }
 185
 186     /*****************
 187      * H E L P E R S *
 188      *****************/
 189
 190     /******************************
 191      * public Getters and Setters *
 192      ******************************/
 193 }