From b7caaaa8819aba5b023d01402df006e2f3cb0c13 Mon Sep 17 00:00:00 2001
From: betateilchen <>
Date: Sat, 8 Mar 2014 17:43:03 +0000
Subject: [PATCH] configDB.pm - updated commandref docu
git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@5166 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
configDB.pm | 146 ++--------------------------------------------------
1 file changed, 4 insertions(+), 142 deletions(-)
diff --git a/configDB.pm b/configDB.pm
index 28a9b26aa..0dcdb4362 100644
--- a/configDB.pm
+++ b/configDB.pm
@@ -691,76 +691,8 @@ sub cfgDB_Diff($$) {
Additional functions provided
- All functions are called from fhem commandline!
-
- {cfgDB_Info}
- Returns some database statistics
-
---------------------------------------------------------------------------------
- configDB Database Information
---------------------------------------------------------------------------------
- dbconn: SQLite:dbname=/opt/fhem/configDB.db
- dbuser:
- dbpass:
- dbtype: SQLITE
---------------------------------------------------------------------------------
- fhemconfig: 7707 entries
-
- Ver 0 saved: Sat Mar 1 11:37:00 2014 def: 293 attr: 1248
- Ver 1 saved: Fri Feb 28 23:55:13 2014 def: 293 attr: 1248
- Ver 2 saved: Fri Feb 28 23:49:01 2014 def: 293 attr: 1248
- Ver 3 saved: Fri Feb 28 22:24:40 2014 def: 293 attr: 1247
- Ver 4 saved: Fri Feb 28 22:14:03 2014 def: 293 attr: 1246
---------------------------------------------------------------------------------
- fhemstate: 1890 entries saved: Sat Mar 1 12:05:00 2014
---------------------------------------------------------------------------------
-
-Ver 0 always indicates the currently running configuration.
-
-
- {cfgDB_List [device],[version]}
- Search for device named [device] in configuration version [version]
- in database archive.
- Default value for [device] = % to show all devices.
- Default value for [version] = 0 to show devices from current version.
- Examples for valid requests:
-
- {cfgDB_List}
- {cfgDB_List 'global'}
- {cfgDB_List '',1}
- {cfgDB_List 'global',1}
-
-
- {cfgDB_Diff <device>,<version>}
- Compare configuration dataset for device <device> from current version 0 with version <version>
- Example for valid request:
-
- {cfgDB_Diff 'telnetPort',1}
-
- will show a result like this:
-
-compare device: telnetPort in current version 0 (left) to version: 1 (right)
-+--+--------------------------------------+--+--------------------------------------+
-| 1|define telnetPort telnet 7072 global | 1|define telnetPort telnet 7072 global |
-* 2|attr telnetPort room telnet * | |
-+--+--------------------------------------+--+--------------------------------------+
-
- {cfgDB_Reorg [keep]}
- Deletes all stored versions with version number higher than [keep].
- Default value for optional parameter keep = 3.
- In above example. {cfgDB_Reorg 2} will delete versions #3 and #4.
- This function can be used to create a nightly running job for
- database reorganisation when called from an at-Definition.
-
-
- {cfgDB_Recover <version>}
- Restores an older version from database archive.
- {cfgDB_Recover 3} will copy version #3 from database
- to version #0.
- Original version #0 will be lost.
- Important!
- The restored version will NOT be activated automatically!
- You must do a rereadcfg or - even better - shutdown restart yourself.
+ You can define an extension with module 98_configDBwrap
+ to gain access to some additional functionality.
@@ -897,76 +829,8 @@ compare device: telnetPort in current version 0 (left) to version: 1 (right)
Zusätzliche Funktionen
- Alle Funktionen werden in der Befehelszeile aufgerufen!
-
- {cfgDB_Info}
- Liefert eine Datenbankstatistik
-
---------------------------------------------------------------------------------
- configDB Database Information
---------------------------------------------------------------------------------
- dbconn: SQLite:dbname=/opt/fhem/configDB.db
- dbuser:
- dbpass:
- dbtype: SQLITE
---------------------------------------------------------------------------------
- fhemconfig: 7707 entries
-
- Ver 0 saved: Sat Mar 1 11:37:00 2014 def: 293 attr: 1248
- Ver 1 saved: Fri Feb 28 23:55:13 2014 def: 293 attr: 1248
- Ver 2 saved: Fri Feb 28 23:49:01 2014 def: 293 attr: 1248
- Ver 3 saved: Fri Feb 28 22:24:40 2014 def: 293 attr: 1247
- Ver 4 saved: Fri Feb 28 22:14:03 2014 def: 293 attr: 1246
---------------------------------------------------------------------------------
- fhemstate: 1890 entries saved: Sat Mar 1 12:05:00 2014
---------------------------------------------------------------------------------
-
-Ver 0 bezeichnet immer die aktuell geladene Konfiguration.
-
-
- {cfgDB_List [device],[version]}
- Sucht das Gerät [device] in der Konfiguration der Version [version]
- in der Datenbank.
- Standardwert für [device] = % um alle Geräte anzuzeigen
- Standardwert für [version] = 0 Geräte in der aktuellen Version anzuzeigen.
- Beispiele für gültige Aufrufe:
-
- {cfgDB_List}
- {cfgDB_List 'global'}
- {cfgDB_List '',1}
- {cfgDB_List 'global',1}
-
-
- {cfgDB_Diff <device>,<version>}
- Vergleicht die Konfigurationsdaten des Gerätes <device> aus der aktuellen Version 0 mit den Daten aus Version <version>
- Beispielaufruf:
-
- {cfgDB_Diff 'telnetPort',1}
-
- liefert ein Ergebnis ähnlich dieser Ausgabe:
-
-compare device: telnetPort in current version 0 (left) to version: 1 (right)
-+--+--------------------------------------+--+--------------------------------------+
-| 1|define telnetPort telnet 7072 global | 1|define telnetPort telnet 7072 global |
-* 2|attr telnetPort room telnet * | |
-+--+--------------------------------------+--+--------------------------------------+
-
- {cfgDB_Reorg [keep]}
- Löscht alle gespeicherten Versionen mit Versionsnummer > [keep].
- Standardwert für den optionalen Parameter keep = 3.
- Im obigen Beispiel würde {cfgDB_Reorg 2} die Versionen #3 und #4 löschen.
- Diese Funktion kann z.B. verwendet werden, um eine regelmäßige nächtliche
- Datenbankreorganisation mit Hilfe einer at-Definition einzuplanen.
-
-
- {cfgDB_Recover <version>}
- Stellt eine ältere Version aus dem Datenbankarchiv wieder her.
- {cfgDB_Recover 3} kopiert die Version #3 aus der Datenbank
- zur Version #0.
- Die ursprüngliche Version #0 wird dabei gelöscht.
- Wichtig!
- Die zurückgeholte Version wird NICHT automatisch aktiviert!
- Ein rereadcfg oder - besser - shutdown restart muss manuell erfolgen.
+ Es kann mit Hilfe des Moduls 98_configDBwrap eine Erweiterung
+ definiert werden, die zusätzliche Funktionen bereitstellt.
@@ -982,8 +846,6 @@ compare device: telnetPort in current version 0 (left) to version: 1 (right)
Durch das Schreiben der Versionsinformationen dauert das ein paar Sekunden.
Der Abschluss des Speichern wird durch eine entsprechende Meldung angezeigt.
- Für die Nutzung von cfgDB_Diff() wird das perl Paket Text::Diff benötigt.
-
Diese Erweiterung wird laufend weiterentwickelt. Speziell an der Verbesserung der Performance wird gearbeitet.
Viel Spass!