NetAlertX/docs/DATABASE.md

A high-level description of the datbase structure

⚠ Disclaimer: As I'm not the original author, some of the information might be inaccurate. Feel free to submit a PR to correct anything within this page or documentation in general.

The MAC address is used as a foreign key in most cases.

Tables overview

Table name	Description	Sample data
CurrentScan	Result of the current scan
Devices	The main devices database that also contains the Network tree mappings.
DHCP_Leases	Used for importing devices from DHCP_Leases files. Also leveraged by some plugins.
Events	Used to collect connection/disconnection events.
Nmap_Scan	Contains results of the scheduled Nmap scan, taht is also displayed in the Nmap tab on each device.
Online_History	Used to display the Device presence over time chart
Parameters	Used to pass values between the frontend and backend.
Pholus_Scan	Scan results of the Pholus python network penetration script.
PiHole_Network	Table to copy the devices from the PiHole database
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.
Plugins_History	History of all entries from the Plugins_Events table
Plugins_Language_Strings	Language strings colelcted from the plugin config.json files used for string resolution in the frontend.
Plugins_Objects	Unique objects detected by individual plugins.
ScanCycles	(obsolete) Used to determine and identify different scan cycles.
Sessions	Used to display sessions in the charts
Settings	Database representation of the sum of all settings from pialert.conf and plugins coming from config.json files.