mirror of
https://github.com/openhab/openhab-addons.git
synced 2025-01-11 15:42:10 +01:00
45 lines
2.7 KiB
Markdown
45 lines
2.7 KiB
Markdown
|
# Java Persistence API (JPA) Persistence
|
||
|
|
|
||
|
|
This service allows you to persist state updates using a SQL or NoSQL database through the [Java Persistence API](https://en.wikipedia.org/wiki/Java_Persistence_API).
|
||
|
|
The service uses an abstraction layer that theoretically allows it to support many available SQL or NoSQL databases.
|
||
|
|
|
||
|
|
It will create one table named `historic_item` where all item states are stored.
|
||
|
|
The item state is stored in a string representation.
|
||
|
|
|
||
|
|
The service currently supports MySQL, Apache Derby and PostgreSQL databases.
|
||
|
|
Only the embedded Apache Derby database driver is included.
|
||
|
|
Other drivers must be installed manually.
|
||
|
|
(See below for more information on that.)
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
This service can be configured in the file `services/jpa.cfg`.
|
||
|
|
|
||
|
|
| Property | Default | Required | Description |
|
||
|
|
| -------- | ------- | :-------: | ------------------------------------------------------------ |
|
||
|
|
| url | | Yes | JDBC connection URL. Examples:<br/><br/>`jdbc:postgresql://hab.local:5432/openhab`<br/>`jdbc:derby://hab.local:1527/openhab;create=true`<br/>`jdbc:mysql://localhost:3306/openhab` |
|
||
|
|
| driver | | Yes | database driver. Examples:<br/><br/>`org.postgresql.Driver`<br/>`org.apache.derby.jdbc.ClientDriver`<br/>`com.mysql.jdbc.Driver`<br/></br>Only the Apache Derby driver is included with the service. Drivers for other databases must be installed manually. This is a trivial process. Normally JDBC database drivers are packaged as OSGi bundles and can just be dropped into the `addons` folder. This has the advantage that users can update their drivers as needed. The following database drivers are known to work:<br/><br/>`postgresql-9.4-1203-jdbc41.jar`<br/>`postgresql-9.4-1206-jdbc41.jar` |
|
||
|
|
| user | | if needed | database user name for connection |
|
||
|
|
| password | | if needed | database user password for connection |
|
||
|
|
|
||
|
|
## Adding support for other JPA supported databases
|
||
|
|
|
||
|
|
All item- and event-related configuration is done in the file `persistence/jpa.persist`.
|
||
|
|
|
||
|
|
If a database driver is not an OSGi bundle, the technique below can be used to extend the openHAB classpath.
|
||
|
|
|
||
|
|
Other database drivers can be added by expanding the openHAB classpath.
|
||
|
|
|
||
|
|
Use the following classpath setup in start.sh / start_debug.sh of openHAB:
|
||
|
|
|
||
|
|
```
|
||
|
|
cp=$(echo lib/*.jar | tr ' ' ':'):$(find $eclipsehome -name "org.eclipse.equinox.launcher_*.jar" | sort | tail -1);
|
||
|
|
```
|
||
|
|
|
||
|
|
This will add all .jar files in a folder "lib" in the root of openhab.
|
||
|
|
|
||
|
|
All databases that are supported by JPA can be added.
|
||
|
|
|
||
|
|
Define `driver` and `url` according to the database definitions.
|
||
|
|
|