flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fhue...@apache.org
Subject [1/2] flink git commit: [hotfix] [docs] Improve description of keyBy().
Date Thu, 05 Apr 2018 09:24:58 GMT
Repository: flink
Updated Branches:
  refs/heads/master 7b0fc58f7 -> dec591a17

[hotfix] [docs] Improve description of keyBy().

Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/7712c027
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/7712c027
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/7712c027

Branch: refs/heads/master
Commit: 7712c027db4b07b92e6f1b2c3d2feb8cc00f409f
Parents: 7b0fc58
Author: Fabian Hueske <fhueske@apache.org>
Authored: Thu Apr 5 10:55:05 2018 +0200
Committer: Fabian Hueske <fhueske@apache.org>
Committed: Thu Apr 5 10:55:05 2018 +0200

 docs/dev/stream/operators/index.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/dev/stream/operators/index.md b/docs/dev/stream/operators/index.md
index b0325ca..aaf3646 100644
--- a/docs/dev/stream/operators/index.md
+++ b/docs/dev/stream/operators/index.md
@@ -100,9 +100,9 @@ dataStream.filter(new FilterFunction<Integer>() {
           <td><strong>KeyBy</strong><br>DataStream &rarr; KeyedStream</td>
-            <p>Logically partitions a stream into disjoint partitions, each partition
containing elements of the same key.
-            Internally, this is implemented with hash partitioning. See <a href="{{ site.baseurl
}}/dev/api_concepts.html#specifying-keys">keys</a> on how to specify keys.
-            This transformation returns a KeyedStream.</p>
+            <p>Logically partitions a stream into disjoint partitions. All records
with the same key are assigned to the same partition. Internally, <em>keyBy()</em>
is implemented with hash partitioning. There are different ways to <a href="{{ site.baseurl
}}/dev/api_concepts.html#specifying-keys">specify keys</a>.</p>
+            <p>
+            This transformation returns a <em>KeyedStream</em>, which is, among
other things, required to use <a href="{{ site.baseurl }}/dev/stream/state/state.html#keyed-state">keyed
state</a>. </p>
     {% highlight java %}
 dataStream.keyBy("someKey") // Key by field "someKey"
 dataStream.keyBy(0) // Key by the first element of a Tuple

View raw message