Add analyze endpoint and query structure

grpc/java/BUILD

@@ -22,6 +22,8 @@ java_grpc_library(
         "//proto:options-proto",
         "//proto:query-proto",
         "//proto:transaction-proto",
+        "//proto:analyze-proto",
+        "//proto:conjunction-proto",
         "//proto:version-proto",
     ],
     # TypeDB Core bundles JARs by maven coordinate, we can remove this when Core is rewritten in Rust

grpc/nodejs/BUILD

@@ -38,6 +38,8 @@ ts_grpc_compile(
         "//proto:options-proto",
         "//proto:query-proto",
         "//proto:transaction-proto",
+        "//proto:analyze-proto",
+        "//proto:conjunction-proto",
         "//proto:version-proto",
     ]
 )

grpc/rust/BUILD

@@ -25,6 +25,8 @@ rust_tonic_compile(
         "//proto:options-proto",
         "//proto:query-proto",
         "//proto:transaction-proto",
+        "//proto:analyze-proto",
+        "//proto:conjunction-proto",
         "//proto:version-proto",
     ]
 )

grpc/rust/build.rs

@@ -4,10 +4,12 @@
 
 fn main() -> std::io::Result<()> {
     let protos = vec![
+        "../../proto/analyze.proto",
         "../../proto/answer.proto",
         "../../proto/authentication.proto",
         "../../proto/concept.proto",
         "../../proto/connection.proto",
+        "../../proto/conjunction.proto",
         "../../proto/database.proto",
         "../../proto/error.proto",
         "../../proto/migration.proto",

proto/BUILD

@@ -103,6 +103,23 @@ proto_library(
     ]
 )
 
+proto_library(
+    name = "analyze-proto",
+    srcs = ["analyze.proto"],
+    deps = [
+        ":conjunction-proto",
+    ],
+)
+
+proto_library(
+    name = "conjunction-proto",
+    srcs = ["conjunction.proto"],
+    deps = [
+        ":answer-proto",
+        ":concept-proto",
+    ],
+)
+
 proto_library(
     name = "version-proto",
     srcs = ["version.proto"],
@@ -114,9 +131,11 @@ proto_library(
 filegroup(
     name = "proto-raw-buffers",
     srcs = [
+        "analyze.proto",
         "answer.proto",
         "concept.proto",
         "connection.proto",
+        "conjunction.proto",
         "options.proto",
         "query.proto",
         "transaction.proto",

proto/analyze.proto

@@ -0,0 +1,129 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+syntax = "proto3";
+
+import "proto/conjunction.proto";
+
+package typedb.protocol;
+
+message Analyze {
+
+  message Req {
+    string query = 1;
+  }
+
+  message Res {
+    PipelineStructure query = 1;
+    repeated FunctionStructure preamble = 2;
+
+    message FunctionStructure {
+      PipelineStructure body = 1;
+      repeated uint32 arguments = 2;
+      oneof returns {// TODO: Does this need to be flattened up?
+        ReturnOpStream stream = 3;
+        ReturnOpSingle single = 4;
+        ReturnOpCheck check = 5;
+        ReturnOpReduce reduce = 6;
+      };
+
+      message ReturnOpStream {
+        repeated uint32 variables = 1;
+      }
+      message ReturnOpSingle {
+        string selector = 1;
+        repeated uint32 variables = 2;
+      }
+      message ReturnOpCheck {}
+      message ReturnOpReduce {
+        repeated Reducer reducer = 1;
+      }
+    }
+
+    message PipelineStructure {
+      repeated ConjunctionStructure conjunctions = 1;
+      repeated PipelineStage stages = 2;
+      map<uint32, VariableInfo> variable_info = 3;
+      repeated uint32 outputs = 4;
+
+      message VariableInfo {
+        string name = 1;
+      }
+
+      message PipelineStage {
+        oneof stage {
+          Match match = 1;
+          Insert insert = 2;
+          Put put = 3;
+          Update update = 4;
+          Delete delete = 5;
+          Select select = 6;
+          Sort sort = 7;
+          Require require = 8;
+          Offset offset = 9;
+          Limit limit = 10;
+          Distinct distinct = 11;
+          Reduce reduce = 12;
+        }
+
+        // They're all the same structure. Should we just use one?
+        message Match {
+          uint32 block = 1;
+        }
+        message Insert {
+          uint32 block = 1;
+        }
+        message Put {
+          uint32 block = 1;
+        }
+        message Update {
+          uint32 block = 1;
+        }
+        message Delete {
+          uint32 block = 1;
+          repeated uint32 deleted_variables = 2;
+        }
+
+        message Select {
+          repeated uint32 variables = 1;
+        }
+        message Sort {
+          repeated SortVariable sort_variables = 1;
+          message SortVariable {
+            uint32 variable = 1;
+            SortDirection direction = 2;
+            enum SortDirection {
+              ASC = 0;
+              DESC = 1;
+            }
+          }
+        }
+        message Require {
+          repeated uint32 variables = 1;
+        }
+        message Offset {
+          uint64 offset = 1;
+        }
+        message Limit {
+          uint64 limit = 1;
+        }
+        message Distinct {}
+        message Reduce {
+          repeated ReduceAssign reducers = 1;
+          repeated uint32 groupby = 2;
+
+          message ReduceAssign {
+            uint32 assigned = 1;
+            Reducer reducer = 2;
+          }
+        }
+      }
+    }
+
+    message Reducer {
+      string reducer = 1;
+      repeated uint32 variables = 2;
+    }
+  }
+}

proto/answer.proto

@@ -10,6 +10,7 @@ package typedb.protocol;
 
 message ConceptRow {
     repeated RowEntry row = 1;
+    bytes involved_blocks = 2;
 }
 
 message RowEntry {

proto/conjunction.proto

@@ -0,0 +1,154 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+syntax = "proto3";
+
+import "proto/answer.proto";
+import "proto/concept.proto";
+
+package typedb.protocol;
+
+message ConjunctionStructure {
+  repeated StructureConstraint constraints = 1;
+
+  message StructureVertex {
+    oneof vertex {
+      uint32 variable = 1;
+      Type label = 2;
+      Value value = 3;
+    }
+  }
+
+  message StructureConstraint {
+    ConstraintSpan span = 1;
+    oneof constraint {
+      Or or = 2;
+      Not not = 3;
+      Try try = 4;
+
+      // Thing
+      Isa isa = 5;
+      Has has = 6;
+      Links links = 7;
+
+      // Type
+      Kind kind = 8;
+      Sub sub = 9;
+      Owns owns = 10;
+      Relates relates = 11;
+      Plays plays = 12;
+
+      // Function
+      Comparison comparison = 13;
+      Expression expression = 14;
+      FunctionCall function_call = 15;
+
+      // Special
+      Is is = 16;
+      IID iid = 17;
+    }
+
+    message ConstraintSpan {
+      uint64 begin = 1;
+      uint64 end = 2;
+    }
+
+    enum ConstraintExactness {
+      EXACT = 0;
+      SUBTYPES = 1;
+    }
+
+    // Nested
+    message Or {
+      repeated uint32 branches = 1;
+    }
+
+    message Not {
+      uint32 conjunction = 1;
+    }
+
+    message Try {
+      uint32 conjunction = 1;
+    }
+
+    // Edges
+    message Isa {
+      StructureVertex thing = 1;
+      StructureVertex type = 2;
+      ConstraintExactness exactness = 3;
+    };
+
+    message Has {
+      StructureVertex owner = 1;
+      StructureVertex attribute = 2;
+      ConstraintExactness exactness = 3;
+    };
+
+    message Links {
+      StructureVertex relation = 1;
+      StructureVertex player = 2;
+      StructureVertex role = 3;
+      ConstraintExactness exactness = 4;
+    };
+
+    // Type
+    message Kind {
+      protocol.ConceptDocument.Node.Leaf.Kind kind = 1;
+      StructureVertex type = 2;
+    }
+
+    message Sub {
+      StructureVertex subtype = 1;
+      StructureVertex supertype = 2;
+      ConstraintExactness exactness = 3;
+    };
+
+    message Owns {
+      StructureVertex owner = 1;
+      StructureVertex attribute = 2;
+      ConstraintExactness exactness = 3;
+    };
+
+    message Relates {
+      StructureVertex relation = 1;
+      StructureVertex role = 2;
+      ConstraintExactness exactness = 3;
+    };
+
+    message Plays {
+      StructureVertex player = 1;
+      StructureVertex role = 2;
+      ConstraintExactness exactness = 3;
+    };
+
+    // Function
+    message Comparison {
+      StructureVertex lhs = 1;
+      StructureVertex rhs = 2;
+    };
+
+    message Expression {
+      string text = 1;
+      repeated StructureVertex assigned = 2;
+      repeated StructureVertex arguments = 3; // Treats constants as part of the text.
+    };
+
+    message FunctionCall {
+      string name = 1;
+      repeated StructureVertex assigned = 2;
+      repeated StructureVertex arguments = 3; // Include constants, since variables are schema-objects
+    };
+
+    // Special
+    message Is {
+      StructureVertex lhs = 1;
+      StructureVertex rhs = 2;
+    };
+
+    message IID {
+      StructureVertex var = 1;
+      bytes IID = 2;
+    };
+  }
+}