Introduce database import and export protocol messages #224
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 |
|---|---|---|
|
|
@@ -10,7 +10,6 @@ package typedb.protocol; | |
|
|
||
| message ConceptRow { | ||
| repeated RowEntry row = 1; | ||
| } | ||
|
|
||
| message RowEntry { | ||
|
|
||
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,15 @@ | ||
| // 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"; | ||
|
|
||
| package typedb.protocol; | ||
|
|
||
| // This is an emulation of the google ErrorDetails message. Generally, ErrorDetails are submitted via the GRPC error | ||
| // mechanism, but a manual error sending is required in streams | ||
| message Error { | ||
|
There was a problem hiding this comment. I was planning to reuse this error, but I understood that I don't need non-terminal errors in my protocol. However, I think that it's reasonable to generalize error messages for the whole TypeDB protocol. |
||
| string error_code = 1; | ||
| string domain = 2; | ||
| repeated string stack_trace = 3; | ||
| } | ||
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,144 @@ | ||
| // 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"; | ||
|
|
||
| package typedb.protocol; | ||
|
|
||
| import "proto/concept.proto"; | ||
|
|
||
| message Migration { | ||
| message Export { | ||
| message Req { | ||
| string name = 1; | ||
| } | ||
|
|
||
| message Server { | ||
| oneof server { | ||
| InitialRes initial_res = 1; | ||
| ResPart res_part = 2; | ||
| Done done = 3; | ||
| } | ||
| } | ||
|
|
||
| message InitialRes { | ||
| string schema = 1; | ||
| } | ||
|
|
||
| message ResPart { | ||
| repeated Item items = 1; | ||
| } | ||
|
|
||
| message Done {} | ||
| } | ||
|
|
||
| message Import { | ||
| message Client { | ||
| oneof client { | ||
| InitialReq initial_req = 1; | ||
| ReqPart req_part = 2; | ||
| Done done = 3; | ||
| } | ||
|
|
||
| message InitialReq { | ||
| string name = 1; | ||
| string schema = 2; | ||
| } | ||
|
|
||
| message ReqPart { | ||
| repeated Item items = 1; | ||
| } | ||
|
|
||
| message Done { } | ||
| } | ||
|
|
||
| message Server { | ||
| Done done = 1; | ||
|
|
||
| message Done { } | ||
| } | ||
| } | ||
|
|
||
| // _ _____ _____ _____ _ _ _____ ___ ___ _ _ _ | ||
| // / \|_ _|_ _| ____| \ | |_ _|_ _/ _ \| \ | | | | ||
| // / _ \ | | | | | _| | \| | | | | | | | | \| | | | ||
| // / ___ \| | | | | |___| |\ | | | | | |_| | |\ |_| | ||
| // /_/ \_\_| |_| |_____|_| \_| |_| |___\___/|_| \_(_) | ||
| // | ||
| // ATTENTION: the messages below are used to import multiple versions of TypeDB. | ||
| // DO NOT reorder or delete existing and reserved indices. Be careful while extending this. | ||
| // | ||
|
Comment on lines
+69
to
+71
There was a problem hiding this comment. bigger please!! like we had it in server - this is very dangerous There was a problem hiding this comment. ASCII art here we go??? |
||
|
|
||
| message Item { | ||
| oneof item { | ||
| Attribute attribute = 1; | ||
| Entity entity = 2; | ||
| Relation relation = 3; | ||
|
|
||
| Header header = 15; | ||
| Checksums checksums = 16; | ||
| } | ||
|
|
||
| message Entity { | ||
| string id = 1; | ||
| string label = 2; | ||
| repeated OwnedAttribute attributes = 3; | ||
| } | ||
|
|
||
| message Attribute { | ||
| string id = 1; | ||
| string label = 2; | ||
| repeated OwnedAttribute attributes = 3; // empty in 3.x, used for backwards compatibility | ||
| MigrationValue value = 4; | ||
| } | ||
|
|
||
| message Relation { | ||
| string id = 1; | ||
| string label = 2; | ||
| repeated OwnedAttribute attributes = 3; | ||
| repeated Role roles = 4; | ||
| message Role { | ||
| string label = 1; | ||
| repeated Player players = 2; | ||
| message Player { | ||
| string id = 1; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| message OwnedAttribute { | ||
| string id = 1; | ||
| } | ||
|
|
||
| message Header { | ||
| string typedb_version = 1; | ||
| string original_database = 2; | ||
| } | ||
|
|
||
| message Checksums { | ||
| int64 entity_count = 1; | ||
| int64 attribute_count = 2; | ||
| int64 relation_count = 3; | ||
| int64 role_count = 4; | ||
| int64 ownership_count = 5; | ||
| reserved 6; // was deleted and cannot be used until a breaking change occurs | ||
| } | ||
| } | ||
|
|
||
| message MigrationValue { | ||
| oneof value { | ||
| string string = 1; | ||
| bool boolean = 2; | ||
| int64 integer = 3; | ||
| double double = 4; | ||
| int64 datetime_millis = 5; // compatibility with 2.x, milliseconds since epoch | ||
| Value.Decimal decimal = 6; | ||
| Value.Date date = 8; | ||
| Value.Datetime datetime = 9; | ||
| Value.Datetime_TZ datetime_tz = 10; | ||
| Value.Duration duration = 11; | ||
| Value.Struct struct = 12; | ||
| } | ||
| } | ||
| } | ||
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've placed all migration-related messages in a single file, so it's "encapsulated". However, this introduces an additional layer of optional
clientandserverin Rust while unpacking this message, so it's a little irritating. Not sure if it's worth it or not. I like this design more, I guess.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 like what you have here, very readable