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