You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/11/16 14:47:01 UTC
[jira] [Commented] (FLINK-9574) Add a dedicated documentation page
for state evolution
[ https://issues.apache.org/jira/browse/FLINK-9574?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16689502#comment-16689502 ]
ASF GitHub Bot commented on FLINK-9574:
---------------------------------------
tzulitai opened a new pull request #7124: [FLINK-9574] [doc] Rework documentation for custom state serializers and state evolution
URL: https://github.com/apache/flink/pull/7124
## What is the purpose of the change
This PR adds a new "State Schema Evolution" page under "State & Fault Tolerance".
It also reworks the "Custom State Serialization" page to reflect the new serializer / serializer snapshot abstractions in 1.7.
- The "State Schema Evolution" page is intended for the majority of users who do not use custom serializers, and just care about what state types they should use if they care about evolvable schema, and their limitations. The list of supported types only includes Avro now, because we only support Avro schema evolution in 1.7.
- The "Custom State Serialization" page is intended for power users who implement their own state serializer. It explains the abstractions and how Flink interacts with them. The document is also targeted for Flink developers who might implement Flink-shipped serializers.
## Documentation
- Does this pull request introduce a new feature? (**yes** / no)
- If yes, how is the feature documented? (not applicable / **docs** / JavaDocs / not documented)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
> Add a dedicated documentation page for state evolution
> ------------------------------------------------------
>
> Key: FLINK-9574
> URL: https://issues.apache.org/jira/browse/FLINK-9574
> Project: Flink
> Issue Type: Sub-task
> Components: Documentation, State Backends, Checkpointing, Type Serialization System
> Reporter: Tzu-Li (Gordon) Tai
> Assignee: Tzu-Li (Gordon) Tai
> Priority: Critical
> Labels: pull-request-available
> Fix For: 1.7.0
>
>
> Currently, the only bit of documentation about serializer upgrades / state evolution, is [https://ci.apache.org/projects/flink/flink-docs-release-1.5/dev/stream/state/custom_serialization.html#handling-serializer-upgrades-and-compatibility.], which only explains things at an API level.
> State evolution over the time has proved to be a rather complex topic that is often overlooked by users. Users would probably benefit from a actual full-grown dedicated page that covers both API, some necessary internal details regarding interplay of state serializers, best practices, and caution notices.
> I propose to add this documentation as a subpage under Streaming/State & Fault-Tolerance/.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)