diff --git a/docs/DATABASE.md b/docs/DATABASE.md index 46aac145..c062df4a 100755 --- a/docs/DATABASE.md +++ b/docs/DATABASE.md @@ -1,7 +1,7 @@ - + # A high-level description of the database structure - An overview of the most important database tables as well as an detailed overview of the Devices table. The MAC address is used as a foreign key in most cases. + An overview of the most important database tables as well as an detailed overview of the Devices table. The MAC address is used as a foreign key in most cases. ## Devices database table @@ -50,7 +50,7 @@ > - `devStatus` — derived string: `On-line`, `Sleeping`, `Down`, or `Off-line`. -To understand how values of these fields influuence application behavior, such as Notifications or Network topology, see also: +To understand how values of these fields influuence application behavior, such as Notifications or Network topology, see also: - [Device Management](./DEVICE_MANAGEMENT.md) - [Network Tree Topology Setup](./NETWORK_TREE.md) @@ -58,32 +58,32 @@ To understand how values of these fields influuence application behavior, such a ## Other Tables overview - + | Table name | Description | Sample data | - |----------------------|----------------------| ----------------------| - | CurrentScan | Result of the current scan | ![Screen1][screen1] | - | Devices | The main devices database that also contains the Network tree mappings. If `ScanCycle` is set to `0` device is not scanned. | ![Screen2][screen2] | - | Events | Used to collect connection/disconnection events. | ![Screen4][screen4] | - | Online_History | Used to display the `Device presence` chart | ![Screen6][screen6] | - | Parameters | Used to pass values between the frontend and backend. | ![Screen7][screen7] | - | Plugins_Events | For capturing events exposed by a plugin via the `last_result.log` file. If unique then saved into the `Plugins_Objects` table. Entries are deleted once processed and stored in the `Plugins_History` and/or `Plugins_Objects` tables. | ![Screen10][screen10] | - | Plugins_History | History of all entries from the `Plugins_Events` table | ![Screen11][screen11] | - | Plugins_Language_Strings | Language strings collected from the plugin `config.json` files used for string resolution in the frontend. | ![Screen12][screen12] | - | Plugins_Objects | Unique objects detected by individual plugins. | ![Screen13][screen13] | - | Sessions | Used to display sessions in the charts | ![Screen15][screen15] | - | Settings | Database representation of the sum of all settings from `app.conf` and plugins coming from `config.json` files. | ![Screen16][screen16] | + |----------------------|----------------------| ----------------------| + | CurrentScan | Result of the current scan | ![Screen1][screen1] | + | Devices | The main devices database that also contains the Network tree mappings. If `ScanCycle` is set to `0` device is not scanned. | ![Screen2][screen2] | + | Events | Used to collect connection/disconnection events. | ![Screen4][screen4] | + | Online_History | Used to display the `Device presence` chart | ![Screen6][screen6] | + | Parameters | Used to pass values between the frontend and backend. | ![Screen7][screen7] | + | Plugins_Events | For capturing events exposed by a plugin via the `last_result.log` file. If unique then saved into the `Plugins_Objects` table. Entries are deleted once processed and stored in the `Plugins_History` and/or `Plugins_Objects` tables. | ![Screen10][screen10] | + | Plugins_History | History of all entries from the `Plugins_Events` table | ![Screen11][screen11] | + | Plugins_Language_Strings | Language strings collected from the plugin `config.json` files used for string resolution in the frontend. | ![Screen12][screen12] | + | Plugins_Objects | Unique objects detected by individual plugins. | ![Screen13][screen13] | + | Sessions | Used to display sessions in the charts | ![Screen15][screen15] | + | Settings | Database representation of the sum of all settings from `app.conf` and plugins coming from `config.json` files. | ![Screen16][screen16] | [screen1]: ./img/DATABASE/CurrentScan.png [screen2]: ./img/DATABASE/Devices.png - [screen4]: ./img/DATABASE/Events.png + [screen4]: ./img/DATABASE/Events.png [screen6]: ./img/DATABASE/Online_History.png [screen7]: ./img/DATABASE/Parameters.png [screen10]: ./img/DATABASE/Plugins_Events.png [screen11]: ./img/DATABASE/Plugins_History.png [screen12]: ./img/DATABASE/Plugins_Language_Strings.png - [screen13]: ./img/DATABASE/Plugins_Objects.png + [screen13]: ./img/DATABASE/Plugins_Objects.png [screen15]: ./img/DATABASE/Sessions.png [screen16]: ./img/DATABASE/Settings.png