public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[jdbc] Improve error handling (#13719)

Browse Source 
* Enable wrapped exceptions being thrown by Yank

Fixes #13718

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

* Fix SAT warning about hashCode implementation

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
This commit is contained in:
Jacob Laursen 2022-11-15 08:44:12 +01:00 committed by GitHub
parent 12980e7147
commit 7eb2c9fb81
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 104 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.persistence.jdbc/pom.xml
View File

@ -22,7 +22,7 @@
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<hikari.version>2.4.7</hikari.version> <hikari.version>2.4.7</hikari.version>
<dbutils.version>1.6</dbutils.version> <dbutils.version>1.6</dbutils.version>
<yank.version>3.2.0</yank.version> <yank.version>3.4.0</yank.version>
<!-- JDBC database driver versions --> <!-- JDBC database driver versions -->
<derby.version>10.14.2.0</derby.version> <derby.version>10.14.2.0</derby.version>

39
bundles/org.openhab.persistence.jdbc/src/main/java/org/openhab/persistence/jdbc/console/JdbcCommandExtension.java
View File

@ -19,6 +19,7 @@ import java.util.stream.Stream;
import org.eclipse.jdt.annotation.NonNullByDefault; import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable; import org.eclipse.jdt.annotation.Nullable;
import org.knowm.yank.exceptions.YankSQLException;
import org.openhab.core.io.console.Console; import org.openhab.core.io.console.Console;
import org.openhab.core.io.console.ConsoleCommandCompleter; import org.openhab.core.io.console.ConsoleCommandCompleter;
import org.openhab.core.io.console.StringsCompleter; import org.openhab.core.io.console.StringsCompleter;
@ -70,22 +71,14 @@ public class JdbcCommandExtension extends AbstractConsoleCommandExtension implem
if (persistenceService == null) { if (persistenceService == null) {
return; return;
} }
if (SUBCMD_TABLES_LIST.equalsIgnoreCase(args[1])) { try {
listTables(persistenceService, console, args.length == 3 && PARAMETER_ALL.equalsIgnoreCase(args[2])); if (!execute(persistenceService, args, console)) {
return; printUsage(console);
} else if (SUBCMD_TABLES_CLEAN.equalsIgnoreCase(args[1])) {
if (args.length == 3) {
cleanupItem(persistenceService, console, args[2], false);
return;
} else if (args.length == 4 && PARAMETER_FORCE.equalsIgnoreCase(args[3])) {
cleanupItem(persistenceService, console, args[2], true);
return;
} else {
cleanupTables(persistenceService, console);
return; return;
} }
} catch (YankSQLException e) {
console.println(e.toString());
} }
printUsage(console);
} }
private @Nullable JdbcPersistenceService getPersistenceService() { private @Nullable JdbcPersistenceService getPersistenceService() {
@ -97,12 +90,32 @@ public class JdbcCommandExtension extends AbstractConsoleCommandExtension implem
return null; return null;
} }
private boolean execute(JdbcPersistenceService persistenceService, String[] args, Console console) {
if (SUBCMD_TABLES_LIST.equalsIgnoreCase(args[1])) {
listTables(persistenceService, console, args.length == 3 && PARAMETER_ALL.equalsIgnoreCase(args[2]));
return true;
} else if (SUBCMD_TABLES_CLEAN.equalsIgnoreCase(args[1])) {
if (args.length == 3) {
cleanupItem(persistenceService, console, args[2], false);
return true;
} else if (args.length == 4 && PARAMETER_FORCE.equalsIgnoreCase(args[3])) {
cleanupItem(persistenceService, console, args[2], true);
return true;
} else {
cleanupTables(persistenceService, console);
return true;
}
}
return false;
}
private void listTables(JdbcPersistenceService persistenceService, Console console, Boolean all) { private void listTables(JdbcPersistenceService persistenceService, Console console, Boolean all) {
List<ItemTableCheckEntry> entries = persistenceService.getCheckedEntries(); List<ItemTableCheckEntry> entries = persistenceService.getCheckedEntries();
if (!all) { if (!all) {
entries.removeIf(t -> t.getStatus() == ItemTableCheckEntryStatus.VALID); entries.removeIf(t -> t.getStatus() == ItemTableCheckEntryStatus.VALID);
} }
entries.sort(Comparator.comparing(ItemTableCheckEntry::getTableName)); entries.sort(Comparator.comparing(ItemTableCheckEntry::getTableName));
// FIXME: NoSuchElement when empty table - because of get()
int itemNameMaxLength = Math int itemNameMaxLength = Math
.max(entries.stream().map(t -> t.getItemName().length()).max(Integer::compare).get(), 4); .max(entries.stream().map(t -> t.getItemName().length()).max(Integer::compare).get(), 4);
int tableNameMaxLength = Math int tableNameMaxLength = Math

7
bundles/org.openhab.persistence.jdbc/src/main/java/org/openhab/persistence/jdbc/dto/ItemsVO.java
View File

@ -13,6 +13,7 @@
package org.openhab.persistence.jdbc.dto; package org.openhab.persistence.jdbc.dto;
import java.io.Serializable; import java.io.Serializable;
import java.util.Objects;
/** /**
* Represents the table naming data. * Represents the table naming data.
@ -96,11 +97,7 @@ public class ItemsVO implements Serializable {
*/ */
@Override @Override
public int hashCode() { public int hashCode() {
final int prime = 31; return Objects.hash(itemName, itemId);
int result = 1;
result = prime * result + ((itemName == null) ? 0 : itemName.hashCode());
result = prime * result + (itemId ^ (itemId >>> 32));
return result;
} }
/* /*

68
bundles/org.openhab.persistence.jdbc/src/main/java/org/openhab/persistence/jdbc/internal/JdbcMapper.java
View File

@ -25,6 +25,7 @@ import java.util.stream.Collectors;
import org.eclipse.jdt.annotation.NonNullByDefault; import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable; import org.eclipse.jdt.annotation.Nullable;
import org.knowm.yank.Yank; import org.knowm.yank.Yank;
import org.knowm.yank.exceptions.YankSQLException;
import org.openhab.core.i18n.TimeZoneProvider; import org.openhab.core.i18n.TimeZoneProvider;
import org.openhab.core.items.Item; import org.openhab.core.items.Item;
import org.openhab.core.persistence.FilterCriteria; import org.openhab.core.persistence.FilterCriteria;
@ -66,7 +67,7 @@ public class JdbcMapper {
/***************** /*****************
* MAPPER ITEMS * * MAPPER ITEMS *
*****************/ *****************/
public boolean pingDB() { private boolean pingDB() {
logger.debug("JDBC::pingDB"); logger.debug("JDBC::pingDB");
boolean ret = false; boolean ret = false;
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
@ -90,15 +91,7 @@ public class JdbcMapper {
return ret; return ret;
} }
public String getDB() { private boolean ifItemsTableExists() {
logger.debug("JDBC::getDB");
long timerStart = System.currentTimeMillis();
String res = conf.getDBDAO().doGetDB();
logTime("getDB", timerStart, System.currentTimeMillis());
return res != null ? res : "";
}
public boolean ifItemsTableExists() {
logger.debug("JDBC::ifItemsTableExists"); logger.debug("JDBC::ifItemsTableExists");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
boolean res = conf.getDBDAO().doIfTableExists(new ItemsVO()); boolean res = conf.getDBDAO().doIfTableExists(new ItemsVO());
@ -106,7 +99,7 @@ public class JdbcMapper {
return res; return res;
} }
public boolean ifTableExists(String tableName) { protected boolean ifTableExists(String tableName) {
logger.debug("JDBC::ifTableExists"); logger.debug("JDBC::ifTableExists");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
boolean res = conf.getDBDAO().doIfTableExists(tableName); boolean res = conf.getDBDAO().doIfTableExists(tableName);
@ -114,7 +107,7 @@ public class JdbcMapper {
return res; return res;
} }
public ItemsVO createNewEntryInItemsTable(ItemsVO vo) { private ItemsVO createNewEntryInItemsTable(ItemsVO vo) {
logger.debug("JDBC::createNewEntryInItemsTable"); logger.debug("JDBC::createNewEntryInItemsTable");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
Long i = conf.getDBDAO().doCreateNewEntryInItemsTable(vo); Long i = conf.getDBDAO().doCreateNewEntryInItemsTable(vo);
@ -123,7 +116,7 @@ public class JdbcMapper {
return vo; return vo;
} }
public boolean createItemsTableIfNot(ItemsVO vo) { private boolean createItemsTableIfNot(ItemsVO vo) {
logger.debug("JDBC::createItemsTableIfNot"); logger.debug("JDBC::createItemsTableIfNot");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
conf.getDBDAO().doCreateItemsTableIfNot(vo); conf.getDBDAO().doCreateItemsTableIfNot(vo);
@ -131,7 +124,7 @@ public class JdbcMapper {
return true; return true;
} }
public boolean dropItemsTableIfExists(ItemsVO vo) { private boolean dropItemsTableIfExists(ItemsVO vo) {
logger.debug("JDBC::dropItemsTableIfExists"); logger.debug("JDBC::dropItemsTableIfExists");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
conf.getDBDAO().doDropItemsTableIfExists(vo); conf.getDBDAO().doDropItemsTableIfExists(vo);
@ -139,14 +132,14 @@ public class JdbcMapper {
return true; return true;
} }
public void dropTable(String tableName) { protected void dropTable(String tableName) {
logger.debug("JDBC::dropTable"); logger.debug("JDBC::dropTable");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
conf.getDBDAO().doDropTable(tableName); conf.getDBDAO().doDropTable(tableName);
logTime("doDropTable", timerStart, System.currentTimeMillis()); logTime("doDropTable", timerStart, System.currentTimeMillis());
} }
public ItemsVO deleteItemsEntry(ItemsVO vo) { protected ItemsVO deleteItemsEntry(ItemsVO vo) {
logger.debug("JDBC::deleteItemsEntry"); logger.debug("JDBC::deleteItemsEntry");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
conf.getDBDAO().doDeleteItemsEntry(vo); conf.getDBDAO().doDeleteItemsEntry(vo);
@ -154,7 +147,7 @@ public class JdbcMapper {
return vo; return vo;
} }
public List<ItemsVO> getItemIDTableNames() { private List<ItemsVO> getItemIDTableNames() {
logger.debug("JDBC::getItemIDTableNames"); logger.debug("JDBC::getItemIDTableNames");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
List<ItemsVO> vo = conf.getDBDAO().doGetItemIDTableNames(new ItemsVO()); List<ItemsVO> vo = conf.getDBDAO().doGetItemIDTableNames(new ItemsVO());
@ -162,7 +155,7 @@ public class JdbcMapper {
return vo; return vo;
} }
public List<ItemsVO> getItemTables() { protected List<ItemsVO> getItemTables() {
logger.debug("JDBC::getItemTables"); logger.debug("JDBC::getItemTables");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
ItemsVO vo = new ItemsVO(); ItemsVO vo = new ItemsVO();
@ -175,14 +168,14 @@ public class JdbcMapper {
/**************** /****************
* MAPPERS ITEM * * MAPPERS ITEM *
****************/ ****************/
public void updateItemTableNames(List<ItemVO> vol) { private void updateItemTableNames(List<ItemVO> vol) {
logger.debug("JDBC::updateItemTableNames"); logger.debug("JDBC::updateItemTableNames");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
conf.getDBDAO().doUpdateItemTableNames(vol); conf.getDBDAO().doUpdateItemTableNames(vol);
logTime("updateItemTableNames", timerStart, System.currentTimeMillis()); logTime("updateItemTableNames", timerStart, System.currentTimeMillis());
} }
public ItemVO createItemTable(ItemVO vo) { private ItemVO createItemTable(ItemVO vo) {
logger.debug("JDBC::createItemTable"); logger.debug("JDBC::createItemTable");
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
conf.getDBDAO().doCreateItemTable(vo); conf.getDBDAO().doCreateItemTable(vo);
@ -190,7 +183,7 @@ public class JdbcMapper {
return vo; return vo;
} }
public Item storeItemValue(Item item, State itemState, @Nullable ZonedDateTime date) { protected Item storeItemValue(Item item, State itemState, @Nullable ZonedDateTime date) {
logger.debug("JDBC::storeItemValue: item={} state={} date={}", item, itemState, date); logger.debug("JDBC::storeItemValue: item={} state={} date={}", item, itemState, date);
String tableName = getTable(item); String tableName = getTable(item);
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
@ -208,7 +201,7 @@ public class JdbcMapper {
return conf.getDBDAO().doGetRowCount(tableName); return conf.getDBDAO().doGetRowCount(tableName);
} }
public List<HistoricItem> getHistItemFilterQuery(FilterCriteria filter, int numberDecimalcount, String table, protected List<HistoricItem> getHistItemFilterQuery(FilterCriteria filter, int numberDecimalcount, String table,
Item item) { Item item) {
logger.debug( logger.debug(
"JDBC::getHistItemFilterQuery filter='{}' numberDecimalcount='{}' table='{}' item='{}' itemName='{}'", "JDBC::getHistItemFilterQuery filter='{}' numberDecimalcount='{}' table='{}' item='{}' itemName='{}'",
@ -221,13 +214,12 @@ public class JdbcMapper {
return result; return result;
} }
public boolean deleteItemValues(FilterCriteria filter, String table) { protected void deleteItemValues(FilterCriteria filter, String table) {
logger.debug("JDBC::deleteItemValues filter='{}' table='{}' itemName='{}'", true, table, filter.getItemName()); logger.debug("JDBC::deleteItemValues filter='{}' table='{}' itemName='{}'", true, table, filter.getItemName());
long timerStart = System.currentTimeMillis(); long timerStart = System.currentTimeMillis();
conf.getDBDAO().doDeleteItemValues(filter, table, timeZoneProvider.getTimeZone()); conf.getDBDAO().doDeleteItemValues(filter, table, timeZoneProvider.getTimeZone());
logTime("deleteItemValues", timerStart, System.currentTimeMillis()); logTime("deleteItemValues", timerStart, System.currentTimeMillis());
errCnt = 0; errCnt = 0;
return true;
} }
/*********************** /***********************
@ -239,6 +231,7 @@ public class JdbcMapper {
logger.info("JDBC::openConnection: Driver is available::Yank setupDataSource"); logger.info("JDBC::openConnection: Driver is available::Yank setupDataSource");
try { try {
Yank.setupDefaultConnectionPool(conf.getHikariConfiguration()); Yank.setupDefaultConnectionPool(conf.getHikariConfiguration());
Yank.setThrowWrappedExceptions(true);
conf.setDbConnected(true); conf.setDbConnected(true);
return true; return true;
} catch (PoolInitializationException e) { } catch (PoolInitializationException e) {
@ -271,16 +264,21 @@ public class JdbcMapper {
if (initialized) { if (initialized) {
return true; return true;
} }
// first try {
boolean p = pingDB(); // first
if (p) { boolean p = pingDB();
logger.debug("JDBC::checkDBAcessability, first try connection: {}", p); if (p) {
return (p && !(conf.getErrReconnectThreshold() > 0 && errCnt <= conf.getErrReconnectThreshold())); logger.debug("JDBC::checkDBAcessability, first try connection: {}", p);
} else { return (p && !(conf.getErrReconnectThreshold() > 0 && errCnt <= conf.getErrReconnectThreshold()));
// second } else {
p = pingDB(); // second
logger.debug("JDBC::checkDBAcessability, second try connection: {}", p); p = pingDB();
return (p && !(conf.getErrReconnectThreshold() > 0 && errCnt <= conf.getErrReconnectThreshold())); logger.debug("JDBC::checkDBAcessability, second try connection: {}", p);
return (p && !(conf.getErrReconnectThreshold() > 0 && errCnt <= conf.getErrReconnectThreshold()));
}
} catch (YankSQLException e) {
logger.warn("Unable to ping database", e);
return false;
} }
} }
@ -412,7 +410,7 @@ public class JdbcMapper {
initialized = tmpinit; initialized = tmpinit;
} }
public Set<PersistenceItemInfo> getItems() { protected Set<PersistenceItemInfo> getItems() {
// TODO: in general it would be possible to query the count, earliest and latest values for each item too but it // TODO: in general it would be possible to query the count, earliest and latest values for each item too but it
// would be a very costly operation // would be a very costly operation
return itemNameToTableNameMap.keySet().stream().map(itemName -> new JdbcPersistenceItemInfo(itemName)) return itemNameToTableNameMap.keySet().stream().map(itemName -> new JdbcPersistenceItemInfo(itemName))

66
bundles/org.openhab.persistence.jdbc/src/main/java/org/openhab/persistence/jdbc/internal/JdbcPersistenceService.java
View File

@ -25,6 +25,7 @@ import java.util.stream.Collectors;
import org.eclipse.jdt.annotation.NonNullByDefault; import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable; import org.eclipse.jdt.annotation.Nullable;
import org.knowm.yank.exceptions.YankSQLException;
import org.openhab.core.config.core.ConfigurableService; import org.openhab.core.config.core.ConfigurableService;
import org.openhab.core.i18n.TimeZoneProvider; import org.openhab.core.i18n.TimeZoneProvider;
import org.openhab.core.items.GroupItem; import org.openhab.core.items.GroupItem;
@ -155,11 +156,15 @@ public class JdbcPersistenceService extends JdbcMapper implements ModifiablePers
state, item, errCnt, conf.getErrReconnectThreshold()); state, item, errCnt, conf.getErrReconnectThreshold());
return; return;
} }
long timerStart = System.currentTimeMillis(); try {
storeItemValue(item, state, date); long timerStart = System.currentTimeMillis();
if (logger.isDebugEnabled()) { storeItemValue(item, state, date);
logger.debug("JDBC: Stored item '{}' as '{}' in SQL database at {} in {} ms.", item.getName(), state, if (logger.isDebugEnabled()) {
new Date(), System.currentTimeMillis() - timerStart); logger.debug("JDBC: Stored item '{}' as '{}' in SQL database at {} in {} ms.", item.getName(), state,
new Date(), System.currentTimeMillis() - timerStart);
}
} catch (YankSQLException e) {
logger.warn("JDBC::store: Unable to store item", e);
} }
} }
@ -215,16 +220,20 @@ public class JdbcPersistenceService extends JdbcMapper implements ModifiablePers
return List.of(); return List.of();
} }
long timerStart = System.currentTimeMillis(); try {
List<HistoricItem> items = getHistItemFilterQuery(filter, conf.getNumberDecimalcount(), table, item); long timerStart = System.currentTimeMillis();
if (logger.isDebugEnabled()) { List<HistoricItem> items = getHistItemFilterQuery(filter, conf.getNumberDecimalcount(), table, item);
logger.debug("JDBC: Query for item '{}' returned {} rows in {} ms", itemName, items.size(), if (logger.isDebugEnabled()) {
System.currentTimeMillis() - timerStart); logger.debug("JDBC: Query for item '{}' returned {} rows in {} ms", itemName, items.size(),
System.currentTimeMillis() - timerStart);
}
// Success
errCnt = 0;
return items;
} catch (YankSQLException e) {
logger.warn("JDBC::query: Unable to query item", e);
return List.of();
} }
// Success
errCnt = 0;
return items;
} }
public void updateConfig(Map<Object, Object> configuration) { public void updateConfig(Map<Object, Object> configuration) {
@ -233,9 +242,14 @@ public class JdbcPersistenceService extends JdbcMapper implements ModifiablePers
conf = new JdbcConfiguration(configuration); conf = new JdbcConfiguration(configuration);
if (conf.valid && checkDBAccessability()) { if (conf.valid && checkDBAccessability()) {
namingStrategy = new NamingStrategy(conf); namingStrategy = new NamingStrategy(conf);
checkDBSchema(); try {
// connection has been established ... initialization completed! checkDBSchema();
initialized = true; // connection has been established ... initialization completed!
initialized = true;
} catch (YankSQLException e) {
logger.error("Failed to check database schema", e);
initialized = false;
}
} else { } else {
initialized = false; initialized = false;
} }
@ -269,14 +283,18 @@ public class JdbcPersistenceService extends JdbcMapper implements ModifiablePers
return false; return false;
} }
long timerStart = System.currentTimeMillis(); try {
boolean result = deleteItemValues(filter, table); long timerStart = System.currentTimeMillis();
if (logger.isDebugEnabled()) { deleteItemValues(filter, table);
logger.debug("JDBC: Deleted values for item '{}' in SQL database at {} in {} ms.", itemName, new Date(), if (logger.isDebugEnabled()) {
System.currentTimeMillis() - timerStart); logger.debug("JDBC: Deleted values for item '{}' in SQL database at {} in {} ms.", itemName, new Date(),
System.currentTimeMillis() - timerStart);
}
return true;
} catch (YankSQLException e) {
logger.debug("JDBC::remove: Unable to remove values for item", e);
return false;
} }
return result;
} }
/** /**