[FLINK-34055] Introduce a new annotation for named parameters

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Implemented
• Fix Version/s: 1.19.0
• Component/s: Table SQL / Planner
• Labels: pull-request-available
• Assignee: Feng Jin
• Reporter: Feng Jin
• Created: 11/Jan/24 02:22
• Updated: 25/Jan/24 12:20
• Resolved: 25/Jan/24 12:20

Description

Introduce a new annotation to specify the parameter name, indicate if it is optional, and potentially support specifying default values in the future.

Deprecate the argumentNames method in FunctionHints as it is not user-friendly for specifying argument names with optional configuration.

 

public @interface ArgumentHint {
    /**
     * The name of the parameter, default is an empty string.
     */
    String name() default "";
 
    /**
     * Whether the parameter is optional, default is false.
     */
    boolean isOptional() default false;
 
    /**
     * The data type hint for the parameter.
     */
    DataTypeHint type() default @DataTypeHint();
}

public @interface FunctionHint {
  
    /**
     * Deprecated attribute for specifying the names of the arguments.
     * It is no longer recommended to use this attribute.
     */
    @Deprecated
    String[] argumentNames() default {""};
  
    /**
     * Attribute for specifying the hints and additional information for function arguments.
     */
    ArgumentHint[] arguments() default {};
}

Issue Links

• links to: GitHub Pull Request #24106