Add analyze endpoint and query structure #231
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| // 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"; | ||
| import "proto/concept.proto"; | ||
| import "proto/error.proto"; | ||
|
|
||
| package typedb.protocol; | ||
|
|
||
| message Analyze { | ||
|
|
||
| message Req { | ||
| string query = 1; | ||
| } | ||
|
|
||
| message Res { | ||
| oneof result { | ||
| Error err = 1; | ||
| AnalyzedQuery ok = 2; | ||
| } | ||
|
|
||
| message AnalyzedQuery { | ||
| QueryStructure structure = 1; | ||
| QueryAnnotations annotations = 2; | ||
|
|
||
| message QueryStructure { | ||
| PipelineStructure query = 1; | ||
| repeated FunctionStructure preamble = 2; | ||
|
|
||
| message FunctionStructure { | ||
| PipelineStructure body = 1; | ||
| repeated ConjunctionStructure.Variable arguments = 2; | ||
| oneof returns { | ||
| ReturnOpStream stream = 3; | ||
| ReturnOpSingle single = 4; | ||
| ReturnOpCheck check = 5; | ||
| ReturnOpReduce reduce = 6; | ||
| }; | ||
|
|
||
| message ReturnOpStream { | ||
| repeated ConjunctionStructure.Variable variables = 1; | ||
| } | ||
| message ReturnOpSingle { | ||
| string selector = 1; | ||
| repeated ConjunctionStructure.Variable variables = 2; | ||
| } | ||
| message ReturnOpCheck {} | ||
| message ReturnOpReduce { | ||
| repeated Reducer reducers = 1; | ||
| } | ||
| } | ||
|
|
||
| message PipelineStructure { | ||
| repeated ConjunctionStructure conjunctions = 1; | ||
| repeated PipelineStage stages = 2; | ||
| map<uint32, VariableInfo> variable_info = 3; | ||
| repeated ConjunctionStructure.Variable 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 ConjunctionStructure.Variable deleted_variables = 2; | ||
| } | ||
|
|
||
| message Select { | ||
| repeated ConjunctionStructure.Variable variables = 1; | ||
| } | ||
| message Sort { | ||
| repeated SortVariable sort_variables = 1; | ||
| message SortVariable { | ||
| ConjunctionStructure.Variable variable = 1; | ||
| SortDirection direction = 2; | ||
| enum SortDirection { | ||
| ASC = 0; | ||
| DESC = 1; | ||
| } | ||
| } | ||
| } | ||
| message Require { | ||
| repeated ConjunctionStructure.Variable variables = 1; | ||
| } | ||
| message Offset { | ||
| uint64 offset = 1; | ||
| } | ||
| message Limit { | ||
| uint64 limit = 1; | ||
| } | ||
| message Distinct {} | ||
| message Reduce { | ||
| repeated ReduceAssign reducers = 1; | ||
| repeated ConjunctionStructure.Variable groupby = 2; | ||
|
|
||
| message ReduceAssign { | ||
| ConjunctionStructure.Variable assigned = 1; | ||
| Reducer reducer = 2; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| message Reducer { | ||
| string reducer = 1; | ||
| repeated ConjunctionStructure.Variable variables = 2; | ||
| } | ||
| } | ||
|
|
||
| message QueryAnnotations { | ||
| PipelineAnnotations query = 1; | ||
| repeated FunctionAnnotations preamble = 2; | ||
| FetchAnnotations fetch = 3; | ||
|
|
||
| message FunctionAnnotations { | ||
| repeated VariableAnnotations arguments = 1; | ||
| repeated VariableAnnotations returns = 2; | ||
| bool returns_stream = 3; | ||
| PipelineAnnotations body = 4; | ||
| } | ||
|
|
||
| message PipelineAnnotations { | ||
| repeated ConjunctionAnnotations conjunctions = 1; | ||
| message ConjunctionAnnotations { | ||
|
There was a problem hiding this comment. Should we try to move this to the Conjunction? |
||
| map<uint32, VariableAnnotations> variable_annotations = 1; | ||
| } | ||
| } | ||
|
|
||
| message FetchAnnotations { | ||
| oneof node { | ||
| Object object = 1; | ||
| FetchAnnotations list = 2; | ||
| Leaf leaf = 3; | ||
| } | ||
| message Object { | ||
| map<string, FetchAnnotations> annotations = 1; | ||
| } | ||
| message Leaf { | ||
| repeated ValueType annotations = 1; | ||
| } | ||
| } | ||
|
|
||
| message VariableAnnotations { | ||
| oneof annotations { | ||
| ConceptVariableAnnotations thing = 1; | ||
| ConceptVariableAnnotations type = 2; | ||
| ValueType value_annotations = 3; | ||
|
|
||
| } | ||
| message ConceptVariableAnnotations { | ||
| repeated Type types = 1; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I quite like them separate! In Rust itll be very easy to unpack them identically