New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: refactor lib/module document #136
Merged
+63
−50
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
<!-- markdownlint-disable MD041 --> | ||
|
||
Expression has two forms: | ||
|
||
1. Value expression, which is evaluated into an SqlValue from a row. | ||
2. Aggregate expression, which is evaluated into an SqlValue from set of rows. | ||
|
||
Since SQL parser cannot distinguish column reference and value expression, | ||
`ValueExprOrAlias` is used for value expressions excluding select_list. |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<!-- markdownlint-disable MD041 --> | ||
SpringQL-core implementation. | ||
|
||
## High-level architecture diagram | ||
|
||
![High-level architecture diagram](https://raw.githubusercontent.com/SpringQL/SpringQL.github.io/main/static/img/springql-architecture.svg) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Pipeline concept diagram | ||
|
||
Omit _Task Graph_ here. A pipeline has: | ||
|
||
- Stream | ||
- (native) Stream | ||
- Source/Sink Stream | ||
- Source Reader | ||
- Sink Writer | ||
- Pump | ||
|
||
![Pipeline concept diagram](https://raw.githubusercontent.com/SpringQL/SpringQL.github.io/main/static/img/pipeline-and-task-graph.svg) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!-- markdownlint-disable MD041 --> | ||
|
||
Stream Engine component. | ||
|
||
Responsible for pipeline management and execution. | ||
|
||
Stream engine has 2 executors: | ||
|
||
1. SQL executor | ||
2. Autonomous executor | ||
|
||
SQL executor receives commands from user interface to quickly change some status of a pipeline. | ||
It does not deal with stream data (Row, to be precise). | ||
|
||
Autonomous executor deals with stream data. | ||
|
||
Both SQL executor and autonomous executor instance run at a main thread, while autonomous executor has workers which run at different worker threads. | ||
|
||
## Entities inside Stream Engine | ||
|
||
![Entities inside Stream Engine](https://raw.githubusercontent.com/SpringQL/SpringQL.github.io/main/static/img/stream-engine-architecture-entity.svg) | ||
|
||
## Communication between entities | ||
|
||
Workers in AutonomousExecutor interact via EventQueue (Choreography-based Saga pattern). | ||
|
||
![Communication between entities](https://raw.githubusercontent.com/SpringQL/SpringQL.github.io/main/static/img/stream-engine-architecture-communication.svg) |
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
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.
[nits] I interpreted from "keep a changelog" and semantic versioning that
Changed
sections include "breaking changes", which bump up major versions.But "keep a changelog" is a human readable format (not a machine readable one) and you noted
Refactor:
, it should be OK to add this line in CHANGELOG.