From 297de7b78917c370d37a331b7945e950dd0b330c Mon Sep 17 00:00:00 2001
From: betateilchen <>
Date: Sun, 20 Apr 2014 11:16:36 +0000
Subject: [PATCH] configdb - added commandref docu
for interaction between configDB and other them modules.
Currently 02_RSS.pm and 95_holiday.pm will use configDB to find their data inside the database.
git-svn-id: https://svn.fhem.de/fhem/trunk@5584 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
fhem/FHEM/98_configdb.pm | 52 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 52 insertions(+)
diff --git a/fhem/FHEM/98_configdb.pm b/fhem/FHEM/98_configdb.pm
index 09179d408..880751f60 100644
--- a/fhem/FHEM/98_configdb.pm
+++ b/fhem/FHEM/98_configdb.pm
@@ -297,6 +297,32 @@ sub CommandConfigdb($$) {
Furthermore, configDB offers a versioning of several configuration together with the possibility to restore a former configuration.
Access to database is provided via perl's database interface DBI.
+
+ Interaction with other modules
+
+ Currently modules 02_RSS.pm and 95_holiday.pm will use configDB to read their configuration data from database
+ instead of formerly used configuration files inside the filesystem.
+ This requires you to import your configuration files from filesystem into database.
+
+ Example:
+ configdb fileimport FHEM/nrw.holiday
+ configdb fileimport FHEM/myrss.layout
+
+ This does not affect the definitons of your holiday or RSS entities.
+ The given filenames in the definitions will be translated automatically to find the correct entries inside the database.
+
+ If you want to create a new RSS-layout or a new holiday definition file,
+ you have to do this inside the filesystem and import it into database.
+
+ To change a configuration file stored in database, you have to export it to filesystem, and change it there.
+ Afterwards you have to reimport it into database.
+ A more easy solution for this task will be provided soon.
+
+ To export a file for modification you can use the command:
+ configdb fileexport FHEM/myrss.layout
+
+
+
Prerequisits / Installation
- Please install perl package Text::Diff if not already installed on your system.
@@ -562,6 +588,32 @@ Ver 0 always indicates the currently running configuration.
jederzeit eine ältere Version wiederherstellen zu können.
Der Zugriff auf die Datenbank erfolgt über die perl-eigene Datenbankschnittstelle DBI.
+
+ Zusammenspiel mit anderen fhem Modulen
+
+ Momentan verwenden die Module 02_RSS.pm und 95_holiday.pm die configDB um ihre Konfigurationsdaten von dort zu lesen
+ anstatt aus den bisherigen Konfigurationsdateien im Dateisystem.
+ Hierzu ist es notwendig, die Konfigurationsdateien aus dem Dateisystem in die Datenbank zu importieren.
+
+ Beispiel:
+ configdb fileimport FHEM/nrw.holiday
+ configdb fileimport FHEM/myrss.layout
+
+ Dies hat keinerlei Auswirkungen auf die Definition der holiday oder RSS Instanzen.
+ Die dort verwendeten Dateinamen werden automtisch umgesetzt, um die zugehörigen Daten in der Datenbank zu finden.
+
+ Um ein neues RSS Layout oder eine neue holiday-Datei anzulegen und zu verwenden, muss diese Datei zuerst im Dateisystem angelegt
+ und dann in die Datenbank importiert werden.
+
+ Um eine in der Datenbank vorhandene Datei zu bearbeiten, muss es zuerst aus der Datenbank in das Dateisystem exportiert
+ und anschliessend dort bearbeitet werden. Danach muss die geänderte Datei wieder in die Datenbank importiert werden.
+ Eine Vereinfachung dieser Vorgehensweise ist derzeit in der Entwicklung.
+
+ Der Export einer Datei zur Bearbeitung erfolgt mit dem Befehl
+ configdb fileexport FHEM/myrss.layout
+
+
+
Voraussetzungen / Installation
- Bitte das perl Paket Text::Diff installieren, falls noch nicht auf dem System vorhanden.