Update protocol with ConceptMap -> AnswerRow

Author: flyingsilverfin

proto/BUILD

@@ -74,7 +74,6 @@ proto_library(
     ],
 )
 
-
 proto_library(
     name = "transaction-proto",
     srcs = ["transaction.proto"],

proto/answer.proto

@@ -8,10 +8,31 @@ import "proto/concept.proto";
 
 package typedb.protocol;
 
-message ConceptMap {
-    map<string, Concept> map = 1;
+message AnswerRow {
+    repeated Answer row = 1;
 //    Explainables explainables = 2;
 }
+
+message Answer {
+    oneof answer {
+        Empty empty = 1;
+        Concept concept = 2;
+        Value value = 3;
+        ConceptList concept_list = 4;
+        ValueList value_list = 5;
+    }
+
+    message Empty {}
+
+    message ConceptList {
+        repeated Concept concepts = 1;
+    }
+
+    message ValueList {
+        repeated Value values = 1;
+    }
+}
+
 //
 //message Explainables {
 //    map<string, Explainable> relations = 1;

proto/concept.proto

@@ -16,8 +16,6 @@ message Concept {
         Entity entity = 5;
         Relation relation = 6;
         Attribute attribute = 7;
-
-        Value value = 8;
     }
 }
 
@@ -31,17 +29,23 @@ message Thing {
 
 message Entity {
     bytes iid = 1;
-    EntityType entity_type = 2; // TODO: not sure we should include types by default, since now they can get quite large with annotations included in every single response!
+    // TODO: not sure we should include types by default, since now they can get quite large with annotations included in every single response!
+    //       perhaps it's a query option?
+    optional EntityType entity_type = 2;
 }
 
 message Relation {
     bytes iid = 1;
-    RelationType relation_type = 2; // TODO: not sure we should include types by default, since now they can get quite large with annotations included in every single response!
+    // TODO: not sure we should include types by default, since now they can get quite large with annotations included in every single response!
+    //       perhaps it's a query option?
+    optional RelationType relation_type = 2;
 }
 
 message Attribute {
     bytes iid = 1;
-    AttributeType attribute_type = 2; // TODO: not sure we should include types by default, since now they can get quite large with annotations included in every single response!
+    // TODO: not sure we should include types by default, since now they can get quite large with annotations included in every single response!
+    //       perhaps it's a query option?
+    optional AttributeType attribute_type = 2;
     Value value = 3;
 }
 
@@ -105,7 +109,7 @@ message Type {
 }
 
 message RoleType {
-    string label = 1;
+    string name = 1;
     string scope = 2;
     repeated Annotation annotations = 3;
 }
@@ -122,7 +126,7 @@ message RelationType {
 
 message AttributeType {
     string label = 1;
-    ValueType value_type = 2;
+    optional ValueType value_type = 2;
     repeated Annotation annotations = 3;
 }
 
@@ -134,8 +138,8 @@ message ValueType {
         Decimal decimal = 4;
         String string = 5;
         Date date = 6;
-        Datetime datetime = 7;
-        Datetime_TZ datetime_tz = 8;
+        DateTime datetime = 7;
+        DateTime_TZ datetime_tz = 8;
         Duration duration = 9;
         Struct struct = 10;
     }
@@ -145,8 +149,8 @@ message ValueType {
     message Decimal {};
     message String {};
     message Date {};
-    message Datetime {};
-    message Datetime_TZ {};
+    message DateTime {};
+    message DateTime_TZ {};
     message Duration {};
     message Struct {
         string name = 1;

proto/logic.proto

@@ -94,8 +94,8 @@ message Rule {
 message Explanation {
     Rule rule = 1;
     map<string, VarList> var_mapping = 2;
-    ConceptMap condition = 3;
-    ConceptMap conclusion = 4;
+    AnswerRow condition = 3;
+    AnswerRow conclusion = 4;
 
     message VarList {
         repeated string vars = 1;

proto/query.proto

@@ -5,7 +5,6 @@
 syntax = "proto3";
 
 import "proto/answer.proto";
-//import "proto/logic.proto";
 import "proto/options.proto";
 import "proto/concept.proto";
 
@@ -19,15 +18,17 @@ message Query {
     }
 
     message Res {
-        Error error = 1;
-        Ok ok = 2;
+        oneof res {
+            Error error = 1;
+            Ok ok = 2;
+        }
 
         message Ok {
             oneof ok {
                 Empty empty = 1;
                 Values values = 2;
                 ReadableConceptTreeStream readable_concept_tree_stream = 3;
-                ConceptMapStream concept_map_stream = 4;
+                AnswerRowStream concept_map_stream = 4;
             }
 
             message Empty {
@@ -47,8 +48,8 @@ message Query {
                 // note: we could use this first response to record debug info, type annotations, warnings, etc
             }
 
-            message ConceptMapStream {
-                // note: we could use this first response to record debug info, type annotations, warnings, etc
+            message AnswerRowStream {
+                repeated string column_variable_names = 1;
             }
         }
     }
@@ -58,16 +59,17 @@ message Query {
 
         message Res {
             oneof res {
-                Error error = 1;
                 ReadableConceptTree tree = 2;
-                ConceptMap concept_map = 3;
+                AnswerRow answer_row = 3;
             }
         }
     }
+}
 
-    message Error {
-        string source_code = 1;
-        string message = 2; // TODO: stack trace?
-        // TODO
-    }
+// This is an emulation of the google ErrorDetails message. Sometimes we submit ErrorDetails via the GRPC error mechanism
+// and sometimes (in streams) we have to manually send errors
+message Error {
+    string error_code = 1;
+    string domain = 2;
+    repeated string stack_trace = 3;
 }

proto/transaction.proto

@@ -30,7 +30,7 @@ message Transaction {
         oneof req {
             Open.Req open_req = 3;
             Query.Req query_req = 4;
-            Stream.Req stream_req = 5;
+            StreamSignal.Req stream_req = 5;
             Commit.Req commit_req = 6;
             Rollback.Req rollback_req = 7;
             Close.Req close_req = 8;
@@ -49,8 +49,10 @@ message Transaction {
 
     message ResPart {
         bytes req_id = 1;
-        Query.ResPart res = 2;
-        Stream.ResPart stream_res = 4;
+        oneof res_part {
+            Query.ResPart query_res = 2;
+            StreamSignal.ResPart stream_res = 3;
+        }
     }
 
     enum Type {
@@ -96,16 +98,19 @@ message Transaction {
         string message = 2;
     }
 
-    message Stream {
+    message StreamSignal {
         message Req {}
 
         message ResPart {
-            State state = 1;
-
-            enum State {
-                CONTINUE = 0;
-                DONE = 1;
+            oneof state {
+                Continue continue = 1;
+                Done done = 2;
+                Error error = 3;
             }
+
+            message Continue {}
+
+            message Done {}
         }
     }
 }