Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-6848

Extend the managed state docs with a Scala example

    Details

      Description

      Hi all,

      It would be nice to add a Scala example code snippet in the Managed state docs. This makes it a bit easier to start using managed state in Scala. The code is tested and works.

      Kind regards,
      Fokko

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user Fokko opened a pull request:

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

          FLINK-6848 Update managed state docs

          Hi guys,

          I would like to add an example of how to work with managed state in Scala. The code is tested locally and might be a nice addition to the docs.

          Cheers,
          Fokko Driesprong

          Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
          If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the [How To Contribute guide](http://flink.apache.org/how-to-contribute.html).
          In addition to going through the list, please provide a meaningful description of your changes.

          • [x] General
          • The pull request references the related JIRA issue ("[FLINK-XXX] Jira title text")
          • The pull request addresses only one issue
          • Each commit in the PR has a meaningful commit message (including the JIRA id)
          • [x] Documentation
          • Documentation has been added for new functionality
          • Old documentation affected by the pull request has been updated
          • JavaDoc for public methods has been added
          • [x] Tests & Build
          • Functionality added by the pull request is covered by tests
          • `mvn clean verify` has been executed successfully locally or a Travis build has passed

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

          $ git pull https://github.com/Fokko/flink fd-update-raw-and-managed-state-docs

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

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


          commit 8103fc28d10d131eb1273dba4b477c25ac278bf0
          Author: Fokko Driesprong <fokkodriesprong@godatadriven.com>
          Date: 2017-06-04T14:08:44Z

          Update managed state docs

          Add an example of how to work with managed state in Scala


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user Fokko opened a pull request: https://github.com/apache/flink/pull/4072 FLINK-6848 Update managed state docs Hi guys, I would like to add an example of how to work with managed state in Scala. The code is tested locally and might be a nice addition to the docs. Cheers, Fokko Driesprong Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration. If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the [How To Contribute guide] ( http://flink.apache.org/how-to-contribute.html ). In addition to going through the list, please provide a meaningful description of your changes. [x] General The pull request references the related JIRA issue (" [FLINK-XXX] Jira title text") The pull request addresses only one issue Each commit in the PR has a meaningful commit message (including the JIRA id) [x] Documentation Documentation has been added for new functionality Old documentation affected by the pull request has been updated JavaDoc for public methods has been added [x] Tests & Build Functionality added by the pull request is covered by tests `mvn clean verify` has been executed successfully locally or a Travis build has passed You can merge this pull request into a Git repository by running: $ git pull https://github.com/Fokko/flink fd-update-raw-and-managed-state-docs Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/4072.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 #4072 commit 8103fc28d10d131eb1273dba4b477c25ac278bf0 Author: Fokko Driesprong <fokkodriesprong@godatadriven.com> Date: 2017-06-04T14:08:44Z Update managed state docs Add an example of how to work with managed state in Scala
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user tzulitai commented on the issue:

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

          Hi @Fokko, thanks a lot for this contribution!

          The current changes look good. However, while you're on it, what do you think about also adding a Scala counterpart example for the other code snippets on the page (e.g. managed operator state, source functions)?

          The changes right now are good as is, but I prefer not to merge a "partially documented Scala example", which may give the wrong impression that Scala works only for some cases. What do you think?

          Show
          githubbot ASF GitHub Bot added a comment - Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4072 Hi @Fokko, thanks a lot for this contribution! The current changes look good. However, while you're on it, what do you think about also adding a Scala counterpart example for the other code snippets on the page (e.g. managed operator state, source functions)? The changes right now are good as is, but I prefer not to merge a "partially documented Scala example", which may give the wrong impression that Scala works only for some cases. What do you think?
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user Fokko commented on the issue:

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

          Hi @tzulitai,

          I fully agree. Give me some time to work on the other Scala examples, I need to make sure that they are working properly. I'll wrap it up this week. I'll update the commit and rebase with master.

          Cheers, Fokko

          Show
          githubbot ASF GitHub Bot added a comment - Github user Fokko commented on the issue: https://github.com/apache/flink/pull/4072 Hi @tzulitai, I fully agree. Give me some time to work on the other Scala examples, I need to make sure that they are working properly. I'll wrap it up this week. I'll update the commit and rebase with master. Cheers, Fokko
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user Fokko commented on the issue:

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

          Hi @tzulitai,

          I've added some more Scala examples. If you are still missing something, please let me know.

          Kind regards, Fokko

          Show
          githubbot ASF GitHub Bot added a comment - Github user Fokko commented on the issue: https://github.com/apache/flink/pull/4072 Hi @tzulitai, I've added some more Scala examples. If you are still missing something, please let me know. Kind regards, Fokko
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user tzulitai commented on the issue:

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

          Thanks a lot @Fokko! This looks very good. +1.

          Merging this ...

          Show
          githubbot ASF GitHub Bot added a comment - Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4072 Thanks a lot @Fokko! This looks very good. +1. Merging this ...
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/4072
          Hide
          tzulitai Tzu-Li (Gordon) Tai added a comment -

          Thanks for the contribution Fokko!

          Fixed for master via 23c82e3cc9d632c17850f3c7d2b3a1ab0a0cd5cb.
          Fixed for 1.3 via db975260cfba8b089d4f477a0ebfc011d0bda130.

          Show
          tzulitai Tzu-Li (Gordon) Tai added a comment - Thanks for the contribution Fokko! Fixed for master via 23c82e3cc9d632c17850f3c7d2b3a1ab0a0cd5cb. Fixed for 1.3 via db975260cfba8b089d4f477a0ebfc011d0bda130.

            People

            • Assignee:
              Fokko Fokko Driesprong
              Reporter:
              Fokko Fokko Driesprong
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development