This repository has been archived by the owner on Jan 28, 2021. It is now read-only.
docs: document the architecture of the project #651
Merged
Conversation
This file contains 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
kuba--
reviewed
Apr 3, 2019
ARCHITECTURE.md
Outdated
| @@ -0,0 +1,137 @@ | |||
| # Architecture overview | |||
|
|
|||
| This document provides an overview of all parts and pueces of the project as well as how they fit together. It is meant to help new contributors understand where things may be, and how changes in some components may interact with other components of the system. | |||
juanjux
reviewed
Apr 4, 2019
ARCHITECTURE.md
Outdated
| This is where the engine lives. The engine is the piece that coordinates and makes all other pieces work together as well as the main API users of the system will use to create and configure an engine and perform queries. | ||
|
|
||
| Because this is the point where all components fit together, it is also where integration tests are. Those integration tests can be found in `engine_test.go`. | ||
| Every time a feature is added or a bug that comes from a particular query is fixed, a test should be added there. |
There was a problem hiding this comment.
Maybe: "a test should be added there, plus in any specific where the feature/issue belonged, if needed".
juanjux
reviewed
Apr 4, 2019
ARCHITECTURE.md
Outdated
|
|
||
| ### `sql/analyzer` | ||
|
|
||
| The analyzer is perhaps the more complex component of the project. It contains a main component, which is the `Analyzer`, in charge of executing its registered rules on execution trees for resolving some parts, removing redundant data, optimizing things for performance, etc. |
There was a problem hiding this comment.
Maybe without "perphaps" :) because IMO it's the more complex one by a long shot.
juanjux
reviewed
Apr 4, 2019
juanjux
approved these changes
Apr 4, 2019
Signed-off-by: Miguel Molina <miguel@erizocosmi.co>
erizocosmico
force-pushed
the
docs/architecture
branch
from
0dbff25
to
0a5f6e8
Compare
|
Requested changes fixed |
kuba--
approved these changes
Apr 5, 2019
juanjux
approved these changes
Apr 5, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Signed-off-by: Miguel Molina miguel@erizocosmi.co