GraphiQL

Der GraphiQL-Explorer kann dazu genutzt werden Daten aus der Datenbank abzufragen oder zu ändern. Das Interafce ist perfekt geeignet um Queries zu testen und Feld- oder Typenbezeichnungen auszulesen.

FrEDAs standard externe Dienste starten zwei Postgraphile-Server, GraphiQL-Interfaces sind daher zu finden unter:

Prodat-DB Postgraphile-Server: http://localhost:4444/postgraphile/graphiql

Freda-DB Postgraphile-Server: http://localhost:5555/postgraphile/graphiql

Oberfläche

Auf der linken Seite ist die aktuelle Abfrage zu sehen. Bei schreiben von Abfragen findet auch eine autovervolls ändigung statt.

Beim drücken des "Play"-Buttons wird die Query/Mutation/Subscription ausgeführt und das Ergebnis wird auf der rechten Seite ausgegeben.

Diese Endpunkte sich unter umständen sehr wichtig, wenn GraphQL-Type Transformings, Merging oder Filter durchgeführt werden, um die Bezeichnung der generierten Felder und Typen auslesen zu können.

Erklärung Nutzen am Prodat-GraphQL-Module

Das Prodat GraphQL-Module, welches sich im GraphQL-Gateway (also in der Middleware) befindet, nutzt bspw. GraphQL-Type Filtering um nur gewhitelisted GraphQL-Types im GraphQL-Gateway durchzureichen und nach außen freizugeben. Bedeutet, dass immer alle GraphQL-Typen in die Whitelist aufgenommen werden müssen, welche zur Ausgabe das Datensatzen benötigt werden (egal ob RootType , Type, oder InputType).

Diese Typen findet man am besten über diese GraphiQL-Oberfläche und deren integrierte Dokumentation am rechten oberen Seitenrand. Man sucht das Feld oder den Typ der entsprechenden Query welche ausgeführt wird und dem GraphQL-Gateway durchgereicht werden soll.

Dieser Schritt wird unter Prodat-GraphQL-Module nochmal genauer erklärt. Dieser wäre nicht nötig wenn alle Tabellen, Funktionen des PostgresSQl-DB-Schemas dem GraphQL-Gateway durchgereicht werden.