Skip to content

Commit

Permalink
Add the toTopicNameExtractor sink to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@richard-axual
richard-axual committed Jun 28, 2024
1 parent 44ebd63 commit a27b85d
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/pipelines.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,14 @@ See [Operations](operations.md) for a full list of operations that can be applie
After all transformation operations are applied, a pipeline can define a sink to which all messages are sent. There are
four sink types in KSML:

| Sink type | Description |
|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `as` | Allows the pipeline result to be saved under an internal name, which can later be referenced. Pipelines defined after this point may refer to this name in their `from` statement. |
| `branch` | This statement allows the pipeline to be split up in several branches. Each branch filters messages with an `if` statement. Messages will be processed only by the first branch of which the `if` statement is true. |
| `forEach` | Sends every message to a function, without expecting any return type. Because there is no return type, the pipeline always stops after this statement. |
| `print` | Prints out every message according to a given output specification. |
| `to` | Sends all output messages to a specific target. This target can be a pre-defined `stream`, `table` or `globalTable`, an inline-defined topic, or a special function called a `topicNameExtractor`. |
| Sink type | Description |
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `as` | Allows the pipeline result to be saved under an internal name, which can later be referenced. Pipelines defined after this point may refer to this name in their `from` statement. |
| `branch` | This statement allows the pipeline to be split up in several branches. Each branch filters messages with an `if` statement. Messages will be processed only by the first branch of which the `if` statement is true. |
| `forEach` | Sends every message to a function, without expecting any return type. Because there is no return type, the pipeline always stops after this statement. |
| `print` | Prints out every message according to a given output specification. |
| `to` | Sends all output messages to a specific target. This target can be a pre-defined `stream`, `table` or `globalTable`, or an inline-defined topic. |
| `toTopicNameExtractor` | Messages are passed onto a user function, which returns the name of the topic that message needs to be sent to. |

For more information, see the respective documentation on pipeline definitions in
the [definitions section of the KSML language spec](ksml-language-spec.html#definitions/PipelineDefinition).
Expand Down

0 comments on commit a27b85d

Please sign in to comment.