oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs for Database

Browse Source
This commit is contained in:
Marek Wolan
2023-11-18 03:46:24 +00:00
parent 7d800cbbc9
commit fdb48c0ded
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/source/simulation_components/system/database_client_server.rst
View File

@@ -14,10 +14,10 @@ The ``DatabaseService`` provides a SQL database server simulation by extending t
Key capabilities Key capabilities
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
- Initialises a SQLite database file in the ``Node`` 's ``FileSystem`` upon creation. - Creates a database file in the ``Node`` 's ``FileSystem`` upon creation.
- Handles connecting clients by maintaining a dictionary of connections mapped to session IDs. - Handles connecting clients by maintaining a dictionary of connections mapped to session IDs.
- Authenticates connections using a configurable password. - Authenticates connections using a configurable password.
- Executes SQL queries against the SQLite database. - Simulates ``SELECT`` and ``DELETE`` SQL queries.
- Returns query results and status codes back to clients. - Returns query results and status codes back to clients.
- Leverages the Service base class for install/uninstall, status tracking, etc. - Leverages the Service base class for install/uninstall, status tracking, etc.
@@ -30,10 +30,9 @@ Usage
Implementation Implementation
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
- Uses SQLite for persistent storage.
- Creates the database file within the node's file system. - Creates the database file within the node's file system.
- Manages client connections in a dictionary by session ID. - Manages client connections in a dictionary by session ID.
- Processes SQL queries via the SQLite cursor and connection. - Processes SQL queries.
- Returns results and status codes in a standard dictionary format. - Returns results and status codes in a standard dictionary format.
- Extends Service class for integration with ``SoftwareManager``. - Extends Service class for integration with ``SoftwareManager``.