[FLINK-32978] Deprecate RichFunction#open(Configuration parameters)

• Type: Technical Debt
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.19.0
• Fix Version/s: 1.19.0
• Component/s: API / Core
• Labels: pull-request-available

Release Note

The RichFunction#open(Configuration parameters) method has been deprecated and will be removed in future versions. Users are encouraged to migrate to the new RichFunction#open(OpenContext openContext) method, which provides a more comprehensive context for initialization.

Here are the key changes and recommendations for migration:

The open(Configuration parameters) method is now marked as deprecated.
A new method open(OpenContext openContext) has been added as a default method to the RichFunction interface.
Users should implement the new open(OpenContext openContext) method for function initialization tasks. The new method will be called automatically before the execution of any processing methods (map, join, etc.).
If the new open(OpenContext openContext) method is not implemented, Flink will fall back to invoking the deprecated open(Configuration parameters) method.

• Assignee: Wencong Liu
• Reporter: Wencong Liu
• Created: 28/Aug/23 10:19
• Updated: 30/Jan/24 09:00
• Resolved: 30/Jan/24 08:59

Description

The FLIP-344 has decided that the parameter in RichFunction#open will be removed in the next major version. We should deprecate it now and remove it in Flink 2.0. The removal will be tracked in FLINK-6912.

Issue Links

• is related to: FLINK-6912 Consider changing the RichFunction#open method signature to take no arguments.
• links to: GitHub Pull Request #23058
• mentioned in: Page Loading...