Die Motivation hinter einer Datenbank im BeuthBot Projekt kommt durch das Problem, dass Benutzer ihre Wünsche immer wieder komplett ausführen müssen.
Als Beispiel: Wenn der Benutzer die Mensa nach veganen Gerichten anfragt, dann muss er das bei der nächsten Anfrage wiederholen.
Die Datenbank soll das Problem beheben und den Benutzern die Möglichkeit bieten ihre Vorlieben zu persistieren, ohne dass diese sich einen extra Account anlegen müssen.
Dabei muss darauf geachtet werden, dass in der Zukunft noch neue Services dazu kommen können. Die Architektur und die Datenbank sollten so konzipiert werden, dass neue Details die zu neuen Services gehören gespeichert werden können, ohne dass die Datenbank dazu angepasst werden muss.
# Was soll die DB können?
/DBF100/ The system must be able to store details about a user./DBF101/ The system must be able to add a detail related to a user./DBF102/ The system must be able to change a detail related to a user./DBF103/ The system must be able to delete a detail related to a user./DBF104/ The system must be able to load all details about a user./DBF105/ The system must be able to delete all entries related to a user./DBF106/ It must be able to add new services and store related user details without modifying the database./DBF200/ The database must store data related to a user./DBF201/ The database must be able to store a nickname related to a user./DBF202/ The database must be able to store a new detail about a user without scaling the schema./DBF203/ The database must have a capacity of N./DBNF200/ The database must be easily scalable./DBNF201/ The database must be easy replaceable.Referenz WS2019:
/NF500/ The system should comply with DSGVO guidelines/NF501/ The system should be based on security standards/NF502/ Databases should be protected from unwanted access/NF503/ The databases should be password protected/NF504/ The databases should be based on security standards/NF600/ The system should restart the service independently in the event of a service failure/NF700/ The system should be well documented/NF701/ The system should be easy to understand"Als <Rolle> möchte ich <Ziel/Wunsch>, um <Nutzen>"
/DBUS100/ Als Student möchte ich meine Vorlieben speichern, damit ich sie nicht immer wieder ausschreiben muss./DBUS101/ Als Student möchte ich nach einigen Anfragen, dass ich gefragt werde ob ich meine Vorlieben speichern möchte, damit ich sie nicht immer wieder ausschreiben muss./DBUS102/ Als Student möchte ich, dass der Bot mich wiedererkennt ohne einen extra Account anlegen zu müssen, damit ich keine zusätzlichen persönlichen Informationen preisgeben muss./DBUS103/ Als Student möchte ich dem Bot sagen können, dass er meine ALLE meine Daten löschen soll./DBUS103/ Als Student möchte ich dem Bot sagen können, dass er ein Detail über mich löschen soll.Durch die Anforderung, dass die Details, die zu einem User gespeichert werden sehr variabel sein können, ist von einer relationalen Datenbank wie MySQL o.ä. abzuraten. MongoDB ist eine dokumentenorientierte NoSQL-Datenbank. Mit ihr können Sammlungen von JSON-ähnlichen Dokumenten erstellt und verwaltet werden. So können wir die Daten zu einem User in komplexen Hierarchien verschachteln und erweitern ohne uns Gedanken zu einem Tabellen-Schema machen zu müssen.
Die Datenbank wurde mit Docker erstellt. Um diese zum laufen zu bringen müssen folgende Befehle ausgeführt werden:
# clone the repository git clone https://github.com/beuthbot/database.git # go to the folder cd database # start the docker container to run the mongodb and its corresponding database microservice docker-compose up
Damit es auf Windows funktionieren kann müssen folgende Zeilen in der docker-compose.yml Datei geändert werden:
...
volumes:
- mongodata:/data/db # needed for me to run container on Windows 10
#- ./../.database:/data/db # For Mac/Linux
...
# needed for me to run container on Windows 10
volumes:
mongodata:
Außerdem muss ein shared Folder existieren, welcher beispielsweise 'mongodb' genannt werden muss, worin sich der Ordner 'data' mit den Unterordnern 'db' und 'configdb' befindet. Die Ordnerstruktur sollte nun wie folgt aussehen:
E:\mongodb
└───data
├───configdb
└───db
Requests all Users in the collection
GET http://localhost:27000/users
{...},
{
"id": 12345678,
"nickname": "Alan",
"details" : {
"eating_habit" : "vegetarisch",
"city" : "Berlin"
}
},
{...}
{
"error": ...
}
GET http://localhost:27000/users/<id>
Request a single user with the given id.
{
"id": 12345678,
"nickname": "Alan",
"details" : {
"eating_habit" : "vegetarisch",
"city" : "Berlin"
}
}
{
"error": ...
}
Add/Change a Detaile to/from the User with the given id.
POST http://localhost:27000/users/<id>/detail
{
"detail": "eating_habit",
"value": "vegetarisch"
}
If the operation was successful the error will be set to null and the success will be set to true. If the operation failed an error message will be set and the success will be set to false.
{
"error": null,
"success": true | false
}
Deletes all Details from the User with the given id
DELETE http://localhost:27000/user/<id>/detail?q=<value>
If the operation was successful the error will be set to null and the success will be set to true. If the operation failed an error message will be set and the success will be set to false.
{
"error": null,
"success": true | false
}
Deletes one Detail from the User with the given id.
DELETE http://localhost:27000/user/<id>/detail?q=<value>
If the operation was successful the error will be set to null and the success will be set to true. If the operation failed an error message will be set and the success will be set to false.
{
"error": null,
"success": true | false
}