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 org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.knowm.yank.Yank;
  18 import org.openhab.core.items.Item;
  19 import org.openhab.core.types.State;
  20 import org.openhab.persistence.jdbc.dto.ItemVO;
  21 import org.openhab.persistence.jdbc.dto.ItemsVO;
  22 import org.openhab.persistence.jdbc.utils.StringUtilsExt;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * Extended Database Configuration class. Class represents
  28  * the extended database-specific configuration. Overrides and supplements the
  29  * default settings from JdbcBaseDAO. Enter only the differences to JdbcBaseDAO here.
  30  *
  31  * @author Helmut Lehmeyer - Initial contribution
  32  */
  33 @NonNullByDefault
  34 public class JdbcSqliteDAO extends JdbcBaseDAO {
  35     private static final String DRIVER_CLASS_NAME = org.sqlite.JDBC.class.getName();
  36     @SuppressWarnings("unused")
  37     private static final String DATA_SOURCE_CLASS_NAME = org.sqlite.SQLiteDataSource.class.getName();
  38
  39     private final Logger logger = LoggerFactory.getLogger(JdbcSqliteDAO.class);
  40
  41     /********
  42      * INIT *
  43      ********/
  44     public JdbcSqliteDAO() {
  45         initSqlQueries();
  46         initSqlTypes();
  47         initDbProps();
  48     }
  49
  50     private void initSqlQueries() {
  51         logger.debug("JDBC::initSqlQueries: '{}'", this.getClass().getSimpleName());
  52         sqlGetDB = "PRAGMA DATABASE_LIST"; // "SELECT SQLITE_VERSION()"; // "PRAGMA DATABASE_LIST"->db Path/Name
  53                                            // "PRAGMA SCHEMA_VERSION";
  54         sqlIfTableExists = "SELECT name FROM sqlite_master WHERE type='table' AND name='#searchTable#'";
  55         sqlCreateItemsTableIfNot = "CREATE TABLE IF NOT EXISTS #itemsManageTable# (ItemId INTEGER PRIMARY KEY AUTOINCREMENT, #colname# #coltype# NOT NULL)";
  56         sqlInsertItemValue = "INSERT OR IGNORE INTO #tableName# (TIME, VALUE) VALUES( #tablePrimaryValue#, CAST( ? as #dbType#) )";
  57     }
  58
  59     /**
  60      * INFO: http://www.java2s.com/Code/Java/Database-SQL-JDBC/StandardSQLDataTypeswithTheirJavaEquivalents.htm
  61      */
  62     private void initSqlTypes() {
  63         logger.debug("JDBC::initSqlTypes: Initialize the type array");
  64         sqlTypes.put("tablePrimaryValue", "strftime('%Y-%m-%d %H:%M:%f' , 'now' , 'localtime')");
  65     }
  66
  67     /**
  68      * INFO: https://github.com/brettwooldridge/HikariCP
  69      */
  70     private void initDbProps() {
  71         // Properties for HikariCP
  72         databaseProps.setProperty("driverClassName", DRIVER_CLASS_NAME);
  73         // driverClassName OR BETTER USE dataSourceClassName
  74         // databaseProps.setProperty("dataSourceClassName", DATA_SOURCE_CLASS_NAME);
  75     }
  76
  77     /**************
  78      * ITEMS DAOs *
  79      **************/
  80
  81     @Override
  82     public @Nullable String doGetDB() {
  83         return Yank.queryColumn(sqlGetDB, "file", String.class, null).get(0);
  84     }
  85
  86     @Override
  87     public ItemsVO doCreateItemsTableIfNot(ItemsVO vo) {
  88         String sql = StringUtilsExt.replaceArrayMerge(sqlCreateItemsTableIfNot,
  89                 new String[] { "#itemsManageTable#", "#colname#", "#coltype#" },
  90                 new String[] { vo.getItemsManageTable(), vo.getColname(), vo.getColtype() });
  91         logger.debug("JDBC::doCreateItemsTableIfNot sql={}", sql);
  92         Yank.execute(sql, null);
  93         return vo;
  94     }
  95
  96     /*************
  97      * ITEM DAOs *
  98      *************/
  99     @Override
 100     public void doStoreItemValue(Item item, State itemState, ItemVO vo) {
 101         ItemVO storedVO = storeItemValueProvider(item, itemState, vo);
 102         String sql = StringUtilsExt.replaceArrayMerge(sqlInsertItemValue,
 103                 new String[] { "#tableName#", "#dbType#", "#tablePrimaryValue#" },
 104                 new String[] { storedVO.getTableName(), storedVO.getDbType(), sqlTypes.get("tablePrimaryValue") });
 105         Object[] params = { storedVO.getValue() };
 106         logger.debug("JDBC::doStoreItemValue sql={} value='{}'", sql, storedVO.getValue());
 107         Yank.execute(sql, params);
 108     }
 109
 110     /****************************
 111      * SQL generation Providers *
 112      ****************************/
 113
 114     /*****************
 115      * H E L P E R S *
 116      *****************/
 117
 118     /******************************
 119      * public Getters and Setters *
 120      ******************************/
 121 }