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