[jdbc] Add console maintenance commands

[jlaur]

This introduces some basic tools for verifying integrity of persisted items and corresponding tables.

Example

openhab> openhab:jdbc
Usage: openhab:jdbc tables list [all] - list tables (all = include valid)
Usage: openhab:jdbc tables clean [<itemName>] [force] - clean inconsistent items (remove from index and drop tables)
openhab> openhab:jdbc tables list
Table     Row count  Item                  Status
--------  ---------  --------------------  ----------------------
Item0281      54217  WiserSocket1_Voltage  Item missing
Item0283          0  NotFound              Item and table missing
Item0284          0  NotFound2             Table missing
blah              1                        Orphan table
openhab> openhab:jdbc tables clean
Cleaning up all inconsistent items...
WiserSocket1_Voltage -> skipped/failed.
FindesIkke -> done.
FindesIkke2 -> done.
openhab> openhab:jdbc tables list
Table     Row count  Item                  Status
--------  ---------  --------------------  ----------------------
Item0281      54217  WiserSocket1_Voltage  Item missing
blah              1                        Orphan table
openhab> openhab:jdbc tables clean WiserSocket1_Voltage force
Cleaning up item WiserSocket1_Voltage... done.
openhab> openhab:jdbc tables list
Table     Row count  Item  Status
--------  ---------  ----  ----------------------
blah              1        Orphan table

Test

JAR for testing: org.openhab.persistence.jdbc-3.4.0-SNAPSHOT.jar

Place the corresponding database driver into the addons directory. For example, download the MySQL connector and rename it to mysql-connector-java.jar or the MariaDB connector and rename it to mariadb-java-client.jar.

Resolves #13661

[lsiepel]

Nice, please add a jar when the addon is in a testable state can do some testing. My database has many issues so it is probably the best test case ever. ;-)

[jlaur]

Nice, please add a jar when the addon is in a testable state can do some testing. My database has many issues so it is probably the best test case ever. ;-)

Sure! Currently I'm progressing with the "auto-repair/cleanup" functionality. Basically I have it working, but I need to tidy up the code a bit and propagate results back to the console. I should be able to provide you with a JAR late evening. :-)

[jlaur]

@lsiepel - basic cleanup for trivial inconsistencies is now ready for testing; see updated description with link to JAR. Please test only on test databases for now. No documentation yet, but there is tab completion available, and the example in the description. Core 3.4M4 is needed because API for completion was added recently in openhab/openhab-core#3111.

[lsiepel]

Did some testing and have not found any flaw. I'm using 10.5.15-MariaDB-0+deb11u1 - Debian 11
74 problems detected, in my case with all four variants: item / table / item + table / orphan.

Did some changes and manual fixes. Not something i actually tested yet; but i like the way the cleanup command is leaving the tables with row data as is. You might add a additional argument like 'jdbc forceclean' or similar to skip this rowcount check and force removal.

Once the dryrun is completed i'll continue to do some testing. I did read most code and have not found anything specific to comment about.

[lolodomo]

Should the tag "work in progress" be removed now ?

[jlaur]

You might add a additional argument like 'jdbc forceclean' or similar to skip this rowcount check and force removal.

I had the same thought, and already added that yesterday. 😄 jdbc clean <itemName> force. It was only added for single item cleanup though. Otherwise IMHO it would need to be an attended operation with confirmation per item, I would need to look into possibilities. There is tab completion for item name, btw.

Once the dryrun is completed i'll continue to do some testing.

I'm considering continuing with that in another PR to not let this one grow infinitely. So I would consider this PR as a base for additional console work.

[lsiepel]

LGTM

[lolodomo]

LGTM, thank you