This is an automated email from the ASF dual-hosted git repository.
gongzhongqiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new bc3afba5cb9 [FLINK-35177] Fix DataGen Connector documentation (#24692)
bc3afba5cb9 is described below
commit bc3afba5cb97265c4833818563f61b3fb6b48b6a
Author: Sergei Morozov <[email protected]>
AuthorDate: Tue Aug 27 19:50:43 2024 -0700
[FLINK-35177] Fix DataGen Connector documentation (#24692)
* [FLINK-35177] Fix DataGen Connector documentation
* [FLINK-35177] Consolidate code between example and documentation
---
docs/content.zh/docs/connectors/datastream/datagen.md | 7 +++----
docs/content/docs/connectors/datastream/datagen.md | 7 +++----
.../apache/flink/connector/datagen/source/DataGeneratorSource.java | 6 +++---
.../org/apache/flink/streaming/examples/datagen/DataGenerator.java | 6 +++---
4 files changed, 12 insertions(+), 14 deletions(-)
diff --git a/docs/content.zh/docs/connectors/datastream/datagen.md
b/docs/content.zh/docs/connectors/datastream/datagen.md
index af3129357ed..bd4b76399be 100644
--- a/docs/content.zh/docs/connectors/datastream/datagen.md
+++ b/docs/content.zh/docs/connectors/datastream/datagen.md
@@ -62,17 +62,16 @@ Rate Limiting
-----
`DataGeneratorSource` has built-in support for rate limiting. The following
code will produce a stream of
-`Long` values at the overall source rate (across all source subtasks) not
exceeding 100 events per second.
+`String` values at the overall source rate (across all source subtasks) not
exceeding 100 events per second.
```java
-GeneratorFunction<Long, Long> generatorFunction = index -> index;
-double recordsPerSecond = 100;
+GeneratorFunction<Long, String> generatorFunction = index -> "Number: " +
index;
DataGeneratorSource<String> source =
new DataGeneratorSource<>(
generatorFunction,
Long.MAX_VALUE,
- RateLimiterStrategy.perSecond(recordsPerSecond),
+ RateLimiterStrategy.perSecond(100),
Types.STRING);
```
diff --git a/docs/content/docs/connectors/datastream/datagen.md
b/docs/content/docs/connectors/datastream/datagen.md
index 3847982550e..4a4761e756c 100644
--- a/docs/content/docs/connectors/datastream/datagen.md
+++ b/docs/content/docs/connectors/datastream/datagen.md
@@ -62,17 +62,16 @@ Rate Limiting
-----
`DataGeneratorSource` has built-in support for rate limiting. The following
code will produce a stream of
-`Long` values at the overall source rate (across all source subtasks) not
exceeding 100 events per second.
+`String` values at the overall source rate (across all source subtasks) not
exceeding 100 events per second.
```java
-GeneratorFunction<Long, Long> generatorFunction = index -> index;
-double recordsPerSecond = 100;
+GeneratorFunction<Long, String> generatorFunction = index -> "Number: " +
index;
DataGeneratorSource<String> source =
new DataGeneratorSource<>(
generatorFunction,
Long.MAX_VALUE,
- RateLimiterStrategy.perSecond(recordsPerSecond),
+ RateLimiterStrategy.perSecond(100),
Types.STRING);
```
diff --git
a/flink-connectors/flink-connector-datagen/src/main/java/org/apache/flink/connector/datagen/source/DataGeneratorSource.java
b/flink-connectors/flink-connector-datagen/src/main/java/org/apache/flink/connector/datagen/source/DataGeneratorSource.java
index 9260c8cc5a3..08ab05bc647 100644
---
a/flink-connectors/flink-connector-datagen/src/main/java/org/apache/flink/connector/datagen/source/DataGeneratorSource.java
+++
b/flink-connectors/flink-connector-datagen/src/main/java/org/apache/flink/connector/datagen/source/DataGeneratorSource.java
@@ -73,14 +73,14 @@ import static
org.apache.flink.util.Preconditions.checkNotNull;
*
* <p>This source has built-in support for rate limiting. The following code
will produce an
* effectively unbounded (Long.MAX_VALUE from practical perspective will never
be reached) stream of
- * Long values at the overall source rate (across all source subtasks) of 100
events per second.
+ * String values at the overall source rate (across all source subtasks) of
100 events per second.
*
* <pre>{@code
- * GeneratorFunction<Long, Long> generatorFunction = index -> index;
+ * GeneratorFunction<Long, String> generatorFunction = index -> "Number: " +
index;
*
* DataGeneratorSource<String> source =
* new DataGeneratorSource<>(
- * generatorFunctionStateless,
+ * generatorFunction,
* Long.MAX_VALUE,
* RateLimiterStrategy.perSecond(100),
* Types.STRING);
diff --git
a/flink-examples/flink-examples-streaming/src/main/java/org/apache/flink/streaming/examples/datagen/DataGenerator.java
b/flink-examples/flink-examples-streaming/src/main/java/org/apache/flink/streaming/examples/datagen/DataGenerator.java
index 326e2a2a2a9..befe210ea64 100644
---
a/flink-examples/flink-examples-streaming/src/main/java/org/apache/flink/streaming/examples/datagen/DataGenerator.java
+++
b/flink-examples/flink-examples-streaming/src/main/java/org/apache/flink/streaming/examples/datagen/DataGenerator.java
@@ -35,15 +35,15 @@ public class DataGenerator {
GeneratorFunction<Long, String> generatorFunction = index -> "Number:
" + index;
- DataGeneratorSource<String> generatorSource =
+ DataGeneratorSource<String> source =
new DataGeneratorSource<>(
generatorFunction,
Long.MAX_VALUE,
- RateLimiterStrategy.perSecond(4),
+ RateLimiterStrategy.perSecond(100),
Types.STRING);
DataStreamSource<String> streamSource =
- env.fromSource(generatorSource,
WatermarkStrategy.noWatermarks(), "Data Generator");
+ env.fromSource(source, WatermarkStrategy.noWatermarks(), "Data
Generator");
streamSource.print();
env.execute("Data Generator Source Example");
