openhab-addons/bundles/org.openhab.persistence.mongodb
Stephan Brunner d674814440
[MongoDB Persistence] Fix error 500 and various improvements (#10584)
* [MongoDB Persistence] Rename connectToDatabase to tryConnectToDatabase.

Currently, the implementation throws a RuntimeException.
This fails horribly in query() and store(), because the exception is never caught and connection reestablishment won't happen.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Fix JavaDoc

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Fix Bundle name

The correct database name is "MongoDB" without a space.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Also check for connection validity in isConnected()

When the connection was established successfully once, and the server goes down (e. g. a restart of the DB server), the connection still seems to be OK.
This would throw an exception later on, which is not caught and connection reestablishment won't happen.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Disconnect from database before reconnecting to database.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Disconnect from database when connection procedure fails.

When, for example, the creation of the index fails (disk full, ...), the connection is still there, but the collection isn't created with it's appropriate indices.
Thus, disconnect when the procedure fails to ensure no database connection remains valid.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Fix logic

Create the shared collection with its indices when collectionPerItem is disabled, not enabled.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Access database via getDatabase()

Preparation for synchronization.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Remove global mongoCollection variable.

This allows to easify implementing necessary multithreading locks.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Codestyle improvements.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Move isConnected-Check into tryConnectToDatabase.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Synchronize all connection handling methods.

Though the MongoDB driver is thread-safe, we still need to synchronize connection establishment/closing/...

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Remove all unnecessary @NonNullByDefault attributes.

The given attributes should not be NotNullByDefault, because some may be null, too.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Remove duplicate logging.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Test the db connection after creating the MongoClient.

The mongo always succeeds in creating the connection.
We have to actually force it to test the connection to try to connect to the server.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Fix date query.

Issues:
- Second should have been getEndDate, not getBeginDate
- Send a Date object as the other version wasn't serializable.
- EndDate would have overridden beginDate.

Fixes #10574

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Add debug log for MongoDB query sent to the server.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Reorder index on collections.

The order (Item, Timestamp) makes much more sense and should be better for performance.
All queries are always done with an item, and the dates are optional.
Also, the database server can now execute a range query for the date.

Existing indices are not dropped for backwards compatibility with other systems analyzing the data.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Add @author JavaDoc as per developer guidelines.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Improve logging

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Add @NonNullByDefault

This was removed in 1f8e4525 by mistake.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Do not use isConnected() to test the connection.

The new method throws the real underlying exception instead of a generic one. This allows for detailed logging.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>

* [MongoDB Persistence] Remove useless @inheritDoc as per code analysis tool.

Signed-off-by: Stephan Brunner <s.brunner@stephan-brunner.net>
2021-05-09 19:27:19 +02:00
..
src/main [MongoDB Persistence] Fix error 500 and various improvements (#10584) 2021-05-09 19:27:19 +02:00
NOTICE Codebase as of c53e4aed26 as an initial commit for the shrunk repo 2020-09-20 23:57:58 +02:00
pom.xml Apply Spotless, update skeleton project version, resolve itest runbundles (#9459) 2020-12-22 10:37:44 +01:00
README.md Fix http -> https where applyable. (#10573) 2021-04-24 20:39:51 +02:00

MongoDB Persistence

This service allows you to persist state updates using the MongoDB database. It supports writing information to a MongoDB document store, as well as querying from it.

Configuration

This service can be configured in the file services/mongodb.cfg.

Property Default Required Description
url Yes connection URL to address MongoDB. For example, mongodb://localhost:27017
database Yes database name
collection Yes set collection to "" if it shall generate a collection per item

If you have a username and password it looks like this: url = mongodb://[username]:[password]@[localhost]:27017/[database] The database is required: https://mongodb.github.io/mongo-java-driver/3.9/javadoc/com/mongodb/MongoClientURI.html

All item and event related configuration is done in the file persistence/mongodb.persist.