Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-11292][doc] Update document about how to use new CompositeType… #7475

Closed
wants to merge 3 commits into from

Conversation

Myasuka
Copy link
Member

@Myasuka Myasuka commented Jan 13, 2019

What is the purpose of the change

This pull request update document how to use the new CompositeTypeSerializerSnapshot.

Brief change log

  • update custom_serialization.md of new CompositeTypeSerializerSnapshot.

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no

@Myasuka
Copy link
Member Author

Myasuka commented Jan 13, 2019

I'm not sure whether the updated part of document is enough for users, @tzulitai please feel free to add any comments if you think more details should be provided within this doc or anything else to improve.

the snapshot of the most outer serializer should also contain snapshots of the nested serializers.

The `CompositeSerializerSnapshot` can be used specifically for this scenario. It wraps the logic of resolving
`CompositeTypeSerializerSnapshot` could be extended for all nested `TypeSerializer`s in this scenario. It wraps the logic of resolving
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is a bit strange (the "for all nested TypeSerializer" part).
I would like to stick with the original sentence ("could be used specifically for this scenario").

docs/dev/stream/state/custom_serialization.md Outdated Show resolved Hide resolved
@Myasuka
Copy link
Member Author

Myasuka commented Jan 16, 2019

refactored according to your comments @tzulitai

Copy link
Contributor

@alpinegizmo alpinegizmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions for improving the readability.

docs/dev/stream/state/custom_serialization.md Outdated Show resolved Hide resolved
docs/dev/stream/state/custom_serialization.md Outdated Show resolved Hide resolved
docs/dev/stream/state/custom_serialization.md Outdated Show resolved Hide resolved
docs/dev/stream/state/custom_serialization.md Outdated Show resolved Hide resolved
docs/dev/stream/state/custom_serialization.md Outdated Show resolved Hide resolved
docs/dev/stream/state/custom_serialization.md Outdated Show resolved Hide resolved
docs/dev/stream/state/custom_serialization.md Outdated Show resolved Hide resolved
@Myasuka
Copy link
Member Author

Myasuka commented Jan 18, 2019

@alpinegizmo Thanks for your patient and kind review! Already refactored doc according to your comments.

tzulitai added a commit to tzulitai/flink that referenced this pull request Feb 20, 2019
… to a top-level subsection

This commit adds an independent, top-level subsection named "Predefined
convenient TypeSerializerSnapshot classes" to the "Custom Serialization
for Managed State" page.

This section covers details about using the SimpleTypeSerializerSnapshot
and CompositeTypeSerializerSnapshot classes, what they do, and in which
cases they are suitable to be used by a serializer.

This closes apache#7475.
@asfgit asfgit closed this in c0a7182 Feb 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants