You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by zentol <gi...@git.apache.org> on 2017/11/13 15:54:48 UTC
[GitHub] flink pull request #5006: [hotfix][docs][QS] MInor cleanup of QS documentati...
GitHub user zentol opened a pull request:
https://github.com/apache/flink/pull/5006
[hotfix][docs][QS] MInor cleanup of QS documentation
## What is the purpose of the change
This PR fixes a few smaller issues in the Queryable State documentation/javadocs.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/zentol/flink hf_qs_dc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5006.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5006
----
commit 6bf183a23a19625a9970d00a17de572048c1a51e
Author: zentol <ch...@apache.org>
Date: 2017-11-13T15:49:32Z
[hotfix][docs][QS] Minor cleanup of QS documentation
- replace usage of deprecated ValueStateDescriptor constructor
- fix artifact-id containing 2 underscores
- remove final keyword from method reference
- add missing space to note
commit a4f430f22fcec0f7b854ba06d44474286c6aa5dd
Author: zentol <ch...@apache.org>
Date: 2017-11-13T15:50:12Z
[FLINK-8061][QS] Remove trailing asterisks in javadocs
commit e61432895c357db0fea590a3224240e5f8295891
Author: zentol <ch...@apache.org>
Date: 2017-11-13T15:52:00Z
[FLINK-8064][docs][QS] List flink-core as dependency
----
---
[GitHub] flink pull request #5006: [hotfix][docs][QS] MInor cleanup of QS documentati...
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/5006#discussion_r152406271
--- Diff: docs/dev/stream/state/queryable_state.md ---
@@ -162,14 +161,19 @@ So far, you have set up your cluster to run with queryable state and you have de
queryable. Now it is time to see how to query this state.
For this you can use the `QueryableStateClient` helper class. This is available in the `flink-queryable-state-client`
-jar which you have to explicitly include as a dependency in the `pom.xml` of your project, as shown below:
+jar which you have to explicitly include as a dependency in the `pom.xml` of your project along with `flink-core`, as shown below:
<div data-lang="java" markdown="1">
{% highlight xml %}
<dependency>
<groupId>org.apache.flink</groupId>
- <artifactId>flink-queryable-state-client-java_{{ site.scala_version_suffix }}</artifactId>
- <version>{{site.version }}</version>
+ <artifactId>flink-core</artifactId>
+ <version>{{ site.version }}</version>
+</dependency>
+<dependency>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-queryable-state-client-java{{ site.scala_version_suffix }}</artifactId>
--- End diff --
no, the underscore is included in `site.scala_version_suffix`.
---
[GitHub] flink pull request #5006: [hotfix][docs][QS] MInor cleanup of QS documentati...
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:
https://github.com/apache/flink/pull/5006#discussion_r152402801
--- Diff: docs/dev/stream/state/queryable_state.md ---
@@ -162,14 +161,19 @@ So far, you have set up your cluster to run with queryable state and you have de
queryable. Now it is time to see how to query this state.
For this you can use the `QueryableStateClient` helper class. This is available in the `flink-queryable-state-client`
-jar which you have to explicitly include as a dependency in the `pom.xml` of your project, as shown below:
+jar which you have to explicitly include as a dependency in the `pom.xml` of your project along with `flink-core`, as shown below:
<div data-lang="java" markdown="1">
{% highlight xml %}
<dependency>
<groupId>org.apache.flink</groupId>
- <artifactId>flink-queryable-state-client-java_{{ site.scala_version_suffix }}</artifactId>
- <version>{{site.version }}</version>
+ <artifactId>flink-core</artifactId>
+ <version>{{ site.version }}</version>
+</dependency>
+<dependency>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-queryable-state-client-java{{ site.scala_version_suffix }}</artifactId>
--- End diff --
Do we need to preserve the underscore after `java`?
---
[GitHub] flink pull request #5006: [hotfix][docs][QS] MInor cleanup of QS documentati...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/flink/pull/5006
---
[GitHub] flink pull request #5006: [hotfix][docs][QS] MInor cleanup of QS documentati...
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:
https://github.com/apache/flink/pull/5006#discussion_r152402516
--- Diff: docs/dev/stream/state/queryable_state.md ---
@@ -162,14 +161,19 @@ So far, you have set up your cluster to run with queryable state and you have de
queryable. Now it is time to see how to query this state.
For this you can use the `QueryableStateClient` helper class. This is available in the `flink-queryable-state-client`
-jar which you have to explicitly include as a dependency in the `pom.xml` of your project, as shown below:
+jar which you have to explicitly include as a dependency in the `pom.xml` of your project along with `flink-core`, as shown below:
--- End diff --
"you have to explicitly include" -> "must be explicitly included"?
---
[GitHub] flink issue #5006: [hotfix][docs][QS] MInor cleanup of QS documentation
Posted by tzulitai <gi...@git.apache.org>.
Github user tzulitai commented on the issue:
https://github.com/apache/flink/pull/5006
+1, LGTM. Will address Greg's last comment and merge this ..
---
[GitHub] flink pull request #5006: [hotfix][docs][QS] MInor cleanup of QS documentati...
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:
https://github.com/apache/flink/pull/5006#discussion_r152402097
--- Diff: docs/dev/stream/state/queryable_state.md ---
@@ -60,7 +60,7 @@ The Queryable State feature consists of three main entities:
returning it to the client, and
3. the `QueryableStateServer` which runs on each `TaskManager` and is responsible for serving the locally stored state.
-In a nutshell, the client will connect to one of the proxies and send a request for the state associated with a specific
+The client will connect to one of the proxies and send a request for the state associated with a specific
--- End diff --
"will connect" -> "connects" (and "send" -> "sends")?
---
[GitHub] flink pull request #5006: [hotfix][docs][QS] MInor cleanup of QS documentati...
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:
https://github.com/apache/flink/pull/5006#discussion_r152591791
--- Diff: docs/dev/stream/state/queryable_state.md ---
@@ -162,14 +161,19 @@ So far, you have set up your cluster to run with queryable state and you have de
queryable. Now it is time to see how to query this state.
For this you can use the `QueryableStateClient` helper class. This is available in the `flink-queryable-state-client`
-jar which you have to explicitly include as a dependency in the `pom.xml` of your project, as shown below:
+jar which must explicitly included as a dependency in the `pom.xml` of your project along with `flink-core`, as shown below:
--- End diff --
"must" -> "must be"
---