Skip to content

Commit 059c3bb

Browse files
authored
update examples readme to reflect recently added jobs (#90)
1 parent c79c7e3 commit 059c3bb

File tree

1 file changed

+16
-8
lines changed
  • examples/custom-pipelines-hello-world

1 file changed

+16
-8
lines changed

examples/custom-pipelines-hello-world/README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1-
# Custom Pipelines Hello World Example
1+
# Custom Pipelines Example Jobs using the SDK
22

3-
This is a simple Flink job which uses the Decodable Custom Pipelines SDK.
4-
It takes data from one Decodable stream, _purchase-orders_, processes the data (simply upper-casing the customer name of each purchase order record), and writes the modified records to another stream, _purchase\_order\_processed_.
3+
This project contains several basic Flink jobs which use the Decodable Custom Pipelines SDK.
4+
The jobs are all centered around the same example which is about consuming data from one Decodable stream, _purchase-orders_, processing the records (upper-casing the customer name of each purchase order record), and writing the modified records to another stream, _purchase\_order\_processed_.
55

6-
The job is implemented twice, showing two different flavours:
6+
The example is implemented in a few different flavours, demonstrating how to work with:
77

8-
* **[DataStreamJob.java](./src/main/java/co/decodable/examples/cpdemo/DataStreamJob.java)** (using Flink's DataStream API)
9-
* **[TableAPIJob.java](./src/main/java/co/decodable/examples/cpdemo/TableAPIJob.java)** (using Flink's Table API)
8+
* **keyed and keyless append streams** using both Flink's DataStream API and Table API
9+
* [KeyedAppendStreamJob.java](./src/main/java/co/decodable/examples/cpdemo/KeyedAppendStreamJob.java)
10+
* [KeyedAppendStreamJobTableAPI.java](./src/main/java/co/decodable/examples/cpdemo/KeyedAppendStreamJobTableAPI.java)
11+
* [Keyed2KeylessAppendStreamJob.java](./src/main/java/co/decodable/examples/cpdemo/Keyed2KeylessAppendStreamJob.java)
12+
* [KeylessAppendStreamJob.java](./src/main/java/co/decodable/examples/cpdemo/KeylessAppendStreamJob.java)
13+
* [KeylessAppendStreamJobTableAPI.java](./src/main/java/co/decodable/examples/cpdemo/KeylessAppendStreamJobTableAPI.java)
14+
* [Keyless2KeyedAppendStreamJob.java](./src/main/java/co/decodable/examples/cpdemo/Keyless2KeyedAppendStreamJob.java)
15+
16+
* **change streams** using Flink's DataStream API
17+
* [ChangeStreamJob.java](./src/main/java/co/decodable/examples/cpdemo/ChangeStreamJob.java)
1018

1119
## Build
1220

@@ -26,8 +34,8 @@ Run the following to build this example project using [Gradle](https://gradle.or
2634

2735
Set the `job_file_path` property for the pipeline resource in _decodable-resources.yaml_ depending on your chosen build tool:
2836

29-
* `target/custom-pipelines-hello-world-0.2.jar` when using Maven
30-
* `build/libs/custom-pipelines-hello-world-0.2-all.jar` when using Gradle
37+
* `target/custom-pipelines-hello-world-0.3.jar` when using Maven
38+
* `build/libs/custom-pipelines-hello-world-0.3-all.jar` when using Gradle
3139

3240
Deploy the example to Decodable using the CLI:
3341

0 commit comments

Comments
 (0)