[FLINK-35177] Fix DataGen Connector documentation (apache#24692)

* [FLINK-35177] Fix DataGen Connector documentation * [FLINK-35177] Consolidate code between example and documentation
shangeyao · Aug 28, 2024 · bc3afba · bc3afba
1 parent 8c116de
commit bc3afba
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 14 deletions.
diff --git 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
@@ -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/...-datagen/src/main/java/org/apache/flink/connector/datagen/source/DataGeneratorSource.java b/...-datagen/src/main/java/org/apache/flink/connector/datagen/source/DataGeneratorSource.java
@@ -73,14 +73,14 @@
  *
  * <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/...es-streaming/src/main/java/org/apache/flink/streaming/examples/datagen/DataGenerator.java b/...es-streaming/src/main/java/org/apache/flink/streaming/examples/datagen/DataGenerator.java
@@ -35,15 +35,15 @@ public static void main(String[] args) throws Exception {
 
         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");