#1816 - Updated the DataManipulationBot to subclass DatabaseClient. Extended logging. Dropped the Link loading logging as it was clogging up the terminal output.

docs/source/simulation_components/system/database_client_server.rst

@@ -0,0 +1,70 @@
+.. only:: comment
+
+    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+
+
+Database Client Server
+======================
+
+Database Service
+----------------
+
+The ``DatabaseService`` provides a SQL database server simulation by extending the base Service class.
+
+Key capabilities
+^^^^^^^^^^^^^^^^
+
+- Initialises a SQLite database file in the ``Node``'s ``FileSystem`` upon creation.
+- Handles connecting clients by maintaining a dictionary of connections mapped to session IDs.
+- Authenticates connections using a configurable password.
+- Executes SQL queries against the SQLite database.
+- Returns query results and status codes back to clients.
+- Leverages the Service base class for install/uninstall, status tracking, etc.
+
+Usage
+^^^^^
+- Install on a Node via the ``SoftwareManager`` to start the database service.
+- Clients connect, execute queries, and disconnect.
+- Service runs on TCP port 5432 by default.
+
+Implementation
+^^^^^^^^^^^^^^
+
+- Uses SQLite for persistent storage.
+- Creates the database file within the node's file system.
+- Manages client connections in a dictionary by session ID.
+- Processes SQL queries via the SQLite cursor and connection.
+- Returns results and status codes in a standard dictionary format.
+- Extends Service class for integration with ``SoftwareManager``.
+
+Database Client
+---------------
+
+The DatabaseClient provides a client interface for connecting to the ``DatabaseService``.
+
+Key features
+^^^^^^^^^^^^
+
+- Connects to the ``DatabaseService`` via the ``SoftwareManager``.
+- Executes SQL queries and retrieves result sets.
+- Handles connecting, querying, and disconnecting.
+- Provides a simple ``query`` method for running SQL.
+
+
+Usage
+^^^^^
+
+- Initialise with server IP address and optional password.
+- Connect to the ``DatabaseService`` with ``connect``.
+- Execute SQL queries via ``query``.
+- Retrieve results in a dictionary.
+- Disconnect when finished.
+
+Implementation
+^^^^^^^^^^^^^^
+
+- Leverages ``SoftwareManager`` for sending payloads over the network.
+- Connect and disconnect methods manage sessions.
+- Provides easy interface for applications to query database.
+- Payloads serialised as dictionaries for transmission.
+- Extends base Application class.