git.basschouten.com Git - openhab-addons.git/blob

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