Skip to content

Commit b51bc41

Browse files
committed
[FLINK-33117][docs] Fix scala example for NamedParameterClass
1 parent 7fa4f78 commit b51bc41

File tree

2 files changed

+17
-5
lines changed
  • docs
    • content.zh/docs/dev/table/functions
    • content/docs/dev/table/functions

2 files changed

+17
-5
lines changed

docs/content.zh/docs/dev/table/functions/udfs.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -635,13 +635,14 @@ public static class NamedParameterClass extends ScalarFunction {
635635
{{< tab "Scala" >}}
636636
```scala
637637
import org.apache.flink.table.annotation.ArgumentHint;
638+
import org.apache.flink.table.annotation.DataTypeHint;
638639
import org.apache.flink.table.functions.ScalarFunction;
639640

640641
class NamedParameterClass extends ScalarFunction {
641642

642643
// 使用 @ArgumentHint 注解指定参数的名称,参数类型,以及是否是必需的参数
643-
def eval(@ArgumentHint(name = "param1", isOptional = false, `type` = @DataTypeHint("STRING")) s1: String,
644-
@ArgumentHint(name = "param2", isOptional = true, `type` = @DataTypeHint("INTEGER")) s2: Integer) = {
644+
def eval(@ArgumentHint(name = "param1", isOptional = false, `type` = new DataTypeHint("STRING")) s1: String,
645+
@ArgumentHint(name = "param2", isOptional = true, `type` = new DataTypeHint("INTEGER")) s2: Integer) = {
645646
s1 + ", " + s2
646647
}
647648
}
@@ -655,6 +656,8 @@ class NamedParameterClass extends ScalarFunction {
655656
{{< tab "Java" >}}
656657
```java
657658
import org.apache.flink.table.annotation.ArgumentHint;
659+
import org.apache.flink.table.annotation.DataTypeHint;
660+
import org.apache.flink.table.annotation.FunctionHint;
658661
import org.apache.flink.table.functions.ScalarFunction;
659662

660663
public static class NamedParameterClass extends ScalarFunction {
@@ -675,6 +678,8 @@ public static class NamedParameterClass extends ScalarFunction {
675678
{{< tab "Scala" >}}
676679
```scala
677680
import org.apache.flink.table.annotation.ArgumentHint;
681+
import org.apache.flink.table.annotation.DataTypeHint;
682+
import org.apache.flink.table.annotation.FunctionHint;
678683
import org.apache.flink.table.functions.ScalarFunction;
679684

680685
class NamedParameterClass extends ScalarFunction {

docs/content/docs/dev/table/functions/udfs.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -645,13 +645,14 @@ public static class NamedParameterClass extends ScalarFunction {
645645
{{< tab "Scala" >}}
646646
```scala
647647
import org.apache.flink.table.annotation.ArgumentHint;
648+
import org.apache.flink.table.annotation.DataTypeHint;
648649
import org.apache.flink.table.functions.ScalarFunction;
649650

650651
class NamedParameterClass extends ScalarFunction {
651652

652653
// Use the @ArgumentHint annotation to specify the name, type, and whether a parameter is required.
653-
def eval(@ArgumentHint(name = "param1", isOptional = false, `type` = @DataTypeHint("STRING")) s1: String,
654-
@ArgumentHint(name = "param2", isOptional = true, `type` = @DataTypeHint("INTEGER")) s2: Integer) = {
654+
def eval(@ArgumentHint(name = "param1", isOptional = false, `type` = new DataTypeHint("STRING")) s1: String,
655+
@ArgumentHint(name = "param2", isOptional = true, `type` = new DataTypeHint("INTEGER")) s2: Integer) = {
655656
s1 + ", " + s2
656657
}
657658
}
@@ -673,7 +674,7 @@ public static class NamedParameterClass extends ScalarFunction {
673674
@FunctionHint(
674675
arguments = {
675676
@ArgumentHint(name = "param1", isOptional = false, type = @DataTypeHint("STRING")),
676-
@ArgumentHint(name = "param2", isOptional = true, type = @DataTypeHint("INTEGER"))
677+
@ArgumentHint(name = "param2", isOptional = true, type = @DataTypeHint("INTEGER"))
677678
}
678679
)
679680
public String eval(String s1, Integer s2) {
@@ -685,6 +686,8 @@ public static class NamedParameterClass extends ScalarFunction {
685686
{{< tab "Scala" >}}
686687
```scala
687688
import org.apache.flink.table.annotation.ArgumentHint;
689+
import org.apache.flink.table.annotation.DataTypeHint;
690+
import org.apache.flink.table.annotation.FunctionHint;
688691
import org.apache.flink.table.functions.ScalarFunction;
689692

690693
class NamedParameterClass extends ScalarFunction {
@@ -710,6 +713,8 @@ class NamedParameterClass extends ScalarFunction {
710713
{{< tab "Java" >}}
711714
```java
712715
import org.apache.flink.table.annotation.ArgumentHint;
716+
import org.apache.flink.table.annotation.DataTypeHint;
717+
import org.apache.flink.table.annotation.FunctionHint;
713718
import org.apache.flink.table.functions.ScalarFunction;
714719

715720
// Use the @ArgumentHint annotation to specify the name, type, and whether a parameter is required.
@@ -730,6 +735,8 @@ public static class NamedParameterClass extends ScalarFunction {
730735
{{< tab "Scala" >}}
731736
```scala
732737
import org.apache.flink.table.annotation.ArgumentHint;
738+
import org.apache.flink.table.annotation.DataTypeHint;
739+
import org.apache.flink.table.annotation.FunctionHint;
733740
import org.apache.flink.table.functions.ScalarFunction;
734741

735742
// Use the @ArgumentHint annotation to specify the name, type, and whether a parameter is required.

0 commit comments

Comments
 (0)