fruska commented on code in PR #12:
URL:
https://github.com/apache/flink-connector-kudu/pull/12#discussion_r2005998430
##########
docs/content/docs/connectors/datastream/kudu.md:
##########
@@ -70,6 +71,57 @@ Table table = tEnv.sqlQuery("SELECT * FROM MyKuduTable");
DataStream<Row> ds = tEnv.toDataStream(table);
```
+### Kudu Source
+
+{{< hint info >}}
+This part describes the `KuduSource` usage, which is based on the new [data
source]({{< ref "docs/dev/datastream/sources.md" >}}) API.
+{{< /hint >}}
+
+The `KuduSource` provides a builder class that helps in the construction of
the object.
+The below code snippet shows how to build a `KuduSource` to read data from an
existing Kudu table.
+The `KuduReaderConfig` class provides a way to configure Kudu-specific options
that controls the read behavior.
+
+```java
+KuduTableInfo tableInfo = KuduTableInfo.forTable("my_kudu_table");
+KuduReaderConfig readerConfig = KuduReaderConfig.Builder
+ .setMasters("localhost:7051")
+ .build();
+
+KuduSource<Row> source =
+ KuduSource.<Row>builder()
+ .setTableInfo(tableInfo)
+ .setReaderConfig(readerConfig)
+ .setRowResultConverter(new RowResultRowConverter())
+ .build();
+
+env.fromSource(source, WatermarkStrategy.noWatermarks(), "Kudu Source");
+```
+
+{{< hint info >}}
+It is also possible to create a non-existing Kudu table. To learn more about
that, check the [Create Kudu table]({{< ref
"docs/dev/connectors/datastream/kudu" >}}#create-kudu-table) section.
+{{< /hint >}}
+
+#### Boundedness
+
+Although Kudu is a bounded source, it can still be useful to run in a
streaming manner, when the job does not stop until a failure, or if it is
stopped/cancelled.
+By default `KuduSource` is running in bounded mode, but
`.setBoundedness(Boundedness)` can trigger streaming mode if it is set to
`CONTINUOUS_UNBOUNDED`.
+
+In `CONTINUOUS_UNBOUNDED` mode, the source follows a CDC-like behavior. This
means at job start it will perform a snapshot of the source table and mark that
snapshot time.
Review Comment:
I would add a that here: `This means that...`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
