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

   1 /**
   2  * Copyright (c) 2010-2024 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.ZonedDateTime;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  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.types.State;
  23 import org.openhab.persistence.jdbc.internal.dto.ItemVO;
  24 import org.openhab.persistence.jdbc.internal.dto.ItemsVO;
  25 import org.openhab.persistence.jdbc.internal.exceptions.JdbcSQLException;
  26 import org.openhab.persistence.jdbc.internal.utils.StringUtilsExt;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 /**
  31  * Extended Database Configuration class. Class represents
  32  * the extended database-specific configuration. Overrides and supplements the
  33  * default settings from JdbcBaseDAO. Enter only the differences to JdbcBaseDAO here.
  34  *
  35  * @author Helmut Lehmeyer - Initial contribution
  36  */
  37 @NonNullByDefault
  38 public class JdbcSqliteDAO extends JdbcBaseDAO {
  39     private static final String DRIVER_CLASS_NAME = org.sqlite.JDBC.class.getName();
  40     @SuppressWarnings("unused")
  41     private static final String DATA_SOURCE_CLASS_NAME = org.sqlite.SQLiteDataSource.class.getName();
  42
  43     private final Logger logger = LoggerFactory.getLogger(JdbcSqliteDAO.class);
  44
  45     /********
  46      * INIT *
  47      ********/
  48     public JdbcSqliteDAO() {
  49         initSqlQueries();
  50         initSqlTypes();
  51         initDbProps();
  52     }
  53
  54     private void initSqlQueries() {
  55         logger.debug("JDBC::initSqlQueries: '{}'", this.getClass().getSimpleName());
  56         sqlGetDB = "PRAGMA DATABASE_LIST"; // "SELECT SQLITE_VERSION()"; // "PRAGMA DATABASE_LIST"->db Path/Name
  57                                            // "PRAGMA SCHEMA_VERSION";
  58         sqlIfTableExists = "SELECT name FROM sqlite_master WHERE type='table' AND name='#searchTable#'";
  59         sqlCreateItemsTableIfNot = "CREATE TABLE IF NOT EXISTS #itemsManageTable# (ItemId INTEGER PRIMARY KEY AUTOINCREMENT, #colname# #coltype# NOT NULL)";
  60         sqlGetItemTables = "SELECT name AS table_name FROM sqlite_master WHERE type='table' AND name NOT IN ('#itemsManageTable#','sqlite_sequence')";
  61         sqlInsertItemValue = "INSERT OR IGNORE INTO #tableName# (TIME, VALUE) VALUES( #tablePrimaryValue#, CAST( ? as #dbType#) )";
  62     }
  63
  64     /**
  65      * INFO: http://www.java2s.com/Code/Java/Database-SQL-JDBC/StandardSQLDataTypeswithTheirJavaEquivalents.htm
  66      */
  67     private void initSqlTypes() {
  68         logger.debug("JDBC::initSqlTypes: Initialize the type array");
  69         sqlTypes.put("tablePrimaryValue", "strftime('%Y-%m-%d %H:%M:%f' , 'now' , 'localtime')");
  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
  86     @Override
  87     public @Nullable String doGetDB() throws JdbcSQLException {
  88         try {
  89             return Yank.queryColumn(sqlGetDB, "file", String.class, null).get(0);
  90         } catch (YankSQLException e) {
  91             throw new JdbcSQLException(e);
  92         }
  93     }
  94
  95     @Override
  96     public ItemsVO doCreateItemsTableIfNot(ItemsVO vo) throws JdbcSQLException {
  97         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemsTableIfNot,
  98                 new String[] { "#itemsManageTable#", "#colname#", "#coltype#" },
  99                 new String[] { vo.getItemsManageTable(), vo.getColname(), vo.getColtype() });
 100         logger.debug("JDBC::doCreateItemsTableIfNot sql={}", sql);
 101         try {
 102             Yank.execute(sql, null);
 103         } catch (YankSQLException e) {
 104             throw new JdbcSQLException(e);
 105         }
 106         return vo;
 107     }
 108
 109     /*************
 110      * ITEM DAOs *
 111      *************/
 112     @Override
 113     public void doStoreItemValue(Item item, State itemState, ItemVO vo) throws JdbcSQLException {
 114         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 115         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 116                 new String[] { "#tableName#", "#dbType#", "#tablePrimaryValue#" },
 117                 new String[] { storedVO.getTableName(), storedVO.getDbType(), sqlTypes.get("tablePrimaryValue") });
 118         Object[] params = { storedVO.getValue() };
 119         logger.debug("JDBC::doStoreItemValue sql={} value='{}'", sql, storedVO.getValue());
 120         try {
 121             Yank.execute(sql, params);
 122         } catch (YankSQLException e) {
 123             throw new JdbcSQLException(e);
 124         }
 125     }
 126
 127     @Override
 128     public void doStoreItemValue(Item item, State itemState, ItemVO vo, ZonedDateTime date) throws JdbcSQLException {
 129         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 130         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 131                 new String[] { "#tableName#", "#dbType#", "#tablePrimaryValue#" },
 132                 new String[] { storedVO.getTableName(), storedVO.getDbType(), "?" });
 133         java.sql.Timestamp timestamp = new java.sql.Timestamp(date.toInstant().toEpochMilli());
 134         Object[] params = { timestamp, storedVO.getValue() };
 135         logger.debug("JDBC::doStoreItemValue sql={} timestamp={} value='{}'", sql, timestamp, storedVO.getValue());
 136         try {
 137             Yank.execute(sql, params);
 138         } catch (YankSQLException e) {
 139             throw new JdbcSQLException(e);
 140         }
 141     }
 142
 143     /****************************
 144      * SQL generation Providers *
 145      ****************************/
 146
 147     /*****************
 148      * H E L P E R S *
 149      *****************/
 150
 151     /******************************
 152      * public Getters and Setters *
 153      ******************************/
 154 }