Add graph results

Author: Tobias Hafner

org/polypheny/prism/graph_frame.proto

@@ -3,6 +3,7 @@ Messages related to graph frames as used to represent results form the labeled p
 */
 
 syntax = "proto3";
+import "org/polypheny/prism/value.proto";
 
 option java_multiple_files = true;
 option java_package = "org.polypheny.prism";
@@ -14,10 +15,20 @@ option csharp_namespace = "Polypheny.Prism";
 package org.polypheny.prism;
 
 /*
-The GraphFrame message is a placeholder intended to represent graph frames as part of the labeled property graph model.
-As of now, the graph model is not fully implemented, making this message void of fields.
-It acts as a provision for future developments where fields related to the graph model will be added.
-Currently, this message does not contain any fields. It is reserved for future use when the graph model is more completely realized.
-*/
+ * The GraphFrame represents the non-relational result of a query in the labeled property graph model.
+ * If the query returns a relational result, such as when aggregations are used or specific properties are returned,
+ * a relational frame is used. The GraphFrame is used for results where a set of nodes, edges, or paths is returned.
+ * This selection is exclusive, meaning only one of the lists can be populated at a time. If a result produces multiple
+ * frames (used to transmit large results), all results will be of the same type (relational vs. graph) and contain the
+ * same element type (nodes, edges or paths).
+ */
 message GraphFrame {
+  // Field used to represent a set of nodes as part of a result. If this field is populated all others must not be set.
+  repeated ProtoNode nodes = 1;
+  // Field used to represent a set of edges as part of a result. If this field is populated all others must not be set.
+  repeated ProtoEdge edges = 2;
+  // Field used to represent a set of paths as part of a result. If this field is populated all others must not be set.
+  repeated ProtoPath paths = 3;
 }
+
+

org/polypheny/prism/value.proto

@@ -288,3 +288,51 @@ message ProtoFile {
   // The content of the file in binary.
   bytes binary = 1;
 }
+
+/*
+ * This message represents a node in the labeled property graph model.
+ * Apart form a unique identifier and a name, a set of entries and list are used to represent properties and labels.
+ */
+message ProtoNode {
+  // The system internal unique identifier for that node.
+  string id = 1;
+  // The name of the node as specified on creation.
+  string name = 2;
+  // A map of key-value pairs of proto values. These are used as a map to store properties with their corresponding names.
+  repeated ProtoEntry properties = 3;
+  // This list contains all labels associated with this node. Normal strings are used instead of ProtoStrings.
+  repeated string labels = 4;
+}
+
+/*
+ * This message represents an edge in the labeled property graph model.
+ * Apart form a unique identifier and a name, a set of entries and list are used to represent properties and labels.
+ * Source, target and direction fields provide information about the nodes connected by this edge.
+ */
+message ProtoEdge {
+  // The system internal unique identifier for that node.
+  string id = 1;
+  // The name of the node as specified on creation.
+  string name = 2;
+  // A map of key-value pairs of proto values. These are used as a map to store properties with their corresponding names.
+  repeated ProtoEntry properties = 3;
+  // This list contains all labels associated with this node. Normal strings are used instead of ProtoStrings.
+  repeated string labels = 4;
+  // The system internal unique identifier of the node from which this edge originates.
+  string source = 5;
+  // The system internal unique identifier of the node to which this edge is incident.
+  string target = 6;
+  // The direction of this edge. Possible options are LEFT_TO_RIGHT, RIGHT_TO_LEFT or NONE.
+  Direction direction = 7;
+
+  enum Direction {
+    UNSPECIFIED = 0;
+    LEFT_TO_RIGHT = 1;
+    RIGHT_TO_LEFT = 2;
+    NONE = 3;
+  }
+}
+
+message ProtoPath {
+
+}