Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-6674 Update release 1.3 docs
  3. FLINK-6570

QueryableStateClient constructor in documentation doesn't match actual signature

    Details

      Description

      The queryable state documentation states to use the following ctor

      QueryableStateClient client = new QueryableStateClient(config);
      

      However, this ctor doesn't exist anymore (since 1.3)

        Issue Links

          Activity

          Hide
          Zentol Chesnay Schepler added a comment -

          Follow-up:
          1.3: a390cee333f4bf8f76609cccb7b68883dc2454d8
          1.4: 2d741d0caabc325d0b0e96ffd47eae5609883c1d

          Show
          Zentol Chesnay Schepler added a comment - Follow-up: 1.3: a390cee333f4bf8f76609cccb7b68883dc2454d8 1.4: 2d741d0caabc325d0b0e96ffd47eae5609883c1d
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/flink/pull/4028

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/4028
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user zentol commented on the issue:

          https://github.com/apache/flink/pull/4028

          merging to 1.3 and master.

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on the issue: https://github.com/apache/flink/pull/4028 merging to 1.3 and master.
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user NicoK opened a pull request:

          https://github.com/apache/flink/pull/4028

          FLINK-6570 update queryable state documentation

          • adapt a left-over `QueryableStateClient client = new QueryableStateClient(config);`
          • remove use of `TestingUtils` as it is only available to Flink tests

          please also apply to the `master` branch

          You can merge this pull request into a Git repository by running:

          $ git pull https://github.com/NicoK/flink flink-6570

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/flink/pull/4028.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 #4028


          commit 6225888bb7b54bcc1af843086815efc1c046e010
          Author: Nico Kruber <nico@data-artisans.com>
          Date: 2017-05-31T12:53:26Z

          FLINK-6570 update queryable state documentation

          • adapt a left-over "QueryableStateClient client = new QueryableStateClient(config);"
          • remove use of TestingUtils as it is only available to Flink tests

          Show
          githubbot ASF GitHub Bot added a comment - GitHub user NicoK opened a pull request: https://github.com/apache/flink/pull/4028 FLINK-6570 update queryable state documentation adapt a left-over `QueryableStateClient client = new QueryableStateClient(config);` remove use of `TestingUtils` as it is only available to Flink tests please also apply to the `master` branch You can merge this pull request into a Git repository by running: $ git pull https://github.com/NicoK/flink flink-6570 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/4028.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 #4028 commit 6225888bb7b54bcc1af843086815efc1c046e010 Author: Nico Kruber <nico@data-artisans.com> Date: 2017-05-31T12:53:26Z FLINK-6570 update queryable state documentation adapt a left-over "QueryableStateClient client = new QueryableStateClient(config);" remove use of TestingUtils as it is only available to Flink tests
          Hide
          rmetzger Robert Metzger added a comment -

          Can you open a pull request to fix it?

          Show
          rmetzger Robert Metzger added a comment - Can you open a pull request to fix it?
          Hide
          NicoK Nico Kruber added a comment -

          actually, this issues still persists:

          1) there still is one QueryableStateClient client = new QueryableStateClient(config); in the doc
          2) the example uses TestingUtils which is only available to Flink tests

          Show
          NicoK Nico Kruber added a comment - actually, this issues still persists: 1) there still is one QueryableStateClient client = new QueryableStateClient(config); in the doc 2) the example uses TestingUtils which is only available to Flink tests
          Hide
          till.rohrmann Till Rohrmann added a comment -

          1.4.0: 85e281be3835fe8bb0a5bcaede072e5f26b7f087
          1.3.0: a30a8be98c4a7416e4621c48e961dd8a802b56b4

          Show
          till.rohrmann Till Rohrmann added a comment - 1.4.0: 85e281be3835fe8bb0a5bcaede072e5f26b7f087 1.3.0: a30a8be98c4a7416e4621c48e961dd8a802b56b4
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/flink/pull/3926

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/3926
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user tillrohrmann commented on the issue:

          https://github.com/apache/flink/pull/3926

          Thanks for your contribution @gosubpl. Changes look good to me. Merging this and addressing my comment while doing so.

          Show
          githubbot ASF GitHub Bot added a comment - Github user tillrohrmann commented on the issue: https://github.com/apache/flink/pull/3926 Thanks for your contribution @gosubpl. Changes look good to me. Merging this and addressing my comment while doing so.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user tillrohrmann commented on a diff in the pull request:

          https://github.com/apache/flink/pull/3926#discussion_r117180703

          — Diff: docs/dev/stream/queryable_state.md —
          @@ -208,10 +208,16 @@ Once used in a job, you can retrieve the job ID and then query any key's current

          {% highlight java %}

          final Configuration config = new Configuration();
          -config.setString(ConfigConstants.JOB_MANAGER_IPC_ADDRESS_KEY, queryAddress);
          -config.setInteger(ConfigConstants.JOB_MANAGER_IPC_PORT_KEY, queryPort);
          +config.setString(JobManagerOptions.ADDRESS, queryAddress);
          +config.setInteger(JobManagerOptions.PORT, queryPort);

          -QueryableStateClient client = new QueryableStateClient(config);
          +final HighAvailabilityServices highAvailabilityServices =
          + HighAvailabilityServicesUtils.createHighAvailabilityServices(
          + config,
          + TestingUtils.defaultExecutor(),
          + HighAvailabilityServicesUtils.AddressResolution.NO_ADDRESS_RESOLUTION);
          — End diff –

          Better to do `TRY_ADDRESS_RESOLUTION` here so that we fail fast in case the JM is not reachable from the node we are currently running on.

          Show
          githubbot ASF GitHub Bot added a comment - Github user tillrohrmann commented on a diff in the pull request: https://github.com/apache/flink/pull/3926#discussion_r117180703 — Diff: docs/dev/stream/queryable_state.md — @@ -208,10 +208,16 @@ Once used in a job, you can retrieve the job ID and then query any key's current {% highlight java %} final Configuration config = new Configuration(); -config.setString(ConfigConstants.JOB_MANAGER_IPC_ADDRESS_KEY, queryAddress); -config.setInteger(ConfigConstants.JOB_MANAGER_IPC_PORT_KEY, queryPort); +config.setString(JobManagerOptions.ADDRESS, queryAddress); +config.setInteger(JobManagerOptions.PORT, queryPort); -QueryableStateClient client = new QueryableStateClient(config); +final HighAvailabilityServices highAvailabilityServices = + HighAvailabilityServicesUtils.createHighAvailabilityServices( + config, + TestingUtils.defaultExecutor(), + HighAvailabilityServicesUtils.AddressResolution.NO_ADDRESS_RESOLUTION); — End diff – Better to do `TRY_ADDRESS_RESOLUTION` here so that we fail fast in case the JM is not reachable from the node we are currently running on.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user rmetzger commented on the issue:

          https://github.com/apache/flink/pull/3926

          Sadly, our tests are a little bit unstable. The issue is not related to your change.

          @tillrohrmann could you talk a quick look here?

          Show
          githubbot ASF GitHub Bot added a comment - Github user rmetzger commented on the issue: https://github.com/apache/flink/pull/3926 Sadly, our tests are a little bit unstable. The issue is not related to your change. @tillrohrmann could you talk a quick look here?
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user gosubpl commented on the issue:

          https://github.com/apache/flink/pull/3926

          Please note that the only change in this PR is a documentation change. Not sure why this should result in test failing. How can another test run be requested (a flaky test perhaps)?

          Show
          githubbot ASF GitHub Bot added a comment - Github user gosubpl commented on the issue: https://github.com/apache/flink/pull/3926 Please note that the only change in this PR is a documentation change. Not sure why this should result in test failing. How can another test run be requested (a flaky test perhaps)?
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user gosubpl opened a pull request:

          https://github.com/apache/flink/pull/3926

          FLINK-6570 QueryableStateClient docs with matching constructor sign…

          Resolves FLINK-6570 by modifying the example for `QuerableStateClient` usage by adding the `highAvailabilityServices` argument.
          Tested with `querablestatedemo` project.

          You can merge this pull request into a Git repository by running:

          $ git pull https://github.com/gosubpl/flink FLINK-6570

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/flink/pull/3926.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 #3926


          commit 789d62dac1ff49e1870573d2e9092ab63f58dbcd
          Author: gosubpl <github@gosub.pl>
          Date: 2017-05-17T00:03:45Z

          FLINK-6570 QueryableStateClient docs with matching constructor signature


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user gosubpl opened a pull request: https://github.com/apache/flink/pull/3926 FLINK-6570 QueryableStateClient docs with matching constructor sign… Resolves FLINK-6570 by modifying the example for `QuerableStateClient` usage by adding the `highAvailabilityServices` argument. Tested with `querablestatedemo` project. You can merge this pull request into a Git repository by running: $ git pull https://github.com/gosubpl/flink FLINK-6570 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3926.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 #3926 commit 789d62dac1ff49e1870573d2e9092ab63f58dbcd Author: gosubpl <github@gosub.pl> Date: 2017-05-17T00:03:45Z FLINK-6570 QueryableStateClient docs with matching constructor signature

            People

            • Assignee:
              Unassigned
              Reporter:
              rmetzger Robert Metzger
            • Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development