diff options
| author | doufenghu <[email protected]> | 2024-11-23 19:32:43 +0800 |
|---|---|---|
| committer | doufenghu <[email protected]> | 2024-11-25 15:04:18 +0800 |
| commit | 615007ff5a45894e57766941b8cbc9c5ce866e1c (patch) | |
| tree | 414c7ebf43f40f594c85d51de54ba8c7b13b19a2 /docs | |
| parent | 53d7c1778d15ff3dd9b4c411799455592990d03f (diff) | |
Add a description for the groot-api module
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/develop-guide.md | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/docs/develop-guide.md b/docs/develop-guide.md index 927d2d3..6d22f7f 100644 --- a/docs/develop-guide.md +++ b/docs/develop-guide.md @@ -2,18 +2,19 @@ ## Modules Overview -| Module Name | Description | -|:-----------------|:-----------------------------------------------------------------------------------------------------------| -| groot-bootstrap | The main module of groot-stream, which is responsible for starting the groot-stream server. | -| groot-common | Common module of groot-stream, which is responsible for providing common functions. | -| groot-core | Core module of groot-stream, which is responsible for providing core functions. | -| groot-connectors | Connector module of groot-stream, which is responsible for providing connectors. | -| groot-formats | Format module of groot-stream, which is responsible for providing the ability of formatting data. | -| groot-shaded | Shaded module of groot-stream, which is responsible for providing the ability of solving package conflict. | -| groot-examples | Example module of groot-stream, which is responsible for providing examples. | -| groot-tests | Test module of groot-stream, which is responsible for providing test cases. | -| groot-docs | Docs module of groot-stream, which is responsible for providing documents. | -| groot-release | Release module of groot-stream, which is responsible for providing release scripts. | +| Module Name | Description | +|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------| +| groot-api | Application Programming Interface module of groot-stream, which is responsible for implementing user-defined functions, processors, and connectors. | +| groot-bootstrap | The main module of groot-stream, which is responsible for starting the groot-stream server. | +| groot-common | Common module of groot-stream, which is responsible for providing utility functions. | +| groot-core | Core module of groot-stream, which is responsible for providing the core processors and functions. | +| groot-connectors | Connector module of groot-stream, which is responsible for providing the ability of connecting to different data sources and sinks. | +| groot-formats | Format module of groot-stream, which is responsible for providing the ability of formatting data. | +| groot-shaded | Shaded module of groot-stream, which is responsible for providing the ability of solving package conflict. | +| groot-examples | Example module of groot-stream, which is responsible for providing use-case examples. | +| groot-tests | Test module of groot-stream，which is responsible for providing end-to-tend integration tests. | +| groot-docs | Docs module of groot-stream, which is responsible for providing documents. | +| groot-release | Release module of groot-stream, which is responsible for providing release scripts. | ## Event Model Groot Stream based all stream processing on data records common known as events. A event is a collection of key-value pairs(fields). As follows: |