raminqaf commented on code in PR #29864: URL: https://github.com/apache/flink/pull/29864#discussion_r4601088199
########## docs/data/functions/utility/typeof.yml: ########## @@ -0,0 +1,89 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License + +name: TYPEOF +summary: Returns the data type of an expression as a string. + +syntax: + sql: TYPEOF(input [, force_serializable]) + java: | + call("TYPEOF", $("input")) + call("TYPEOF", $("input"), true) + python: | + call("TYPEOF", col("input")) + call("TYPEOF", col("input"), True) + +arguments: + - name: input + type: Any type + required: true + description: The expression whose type to return. + - name: force_serializable + type: BOOLEAN literal + required: false + default: "`FALSE`" + description: "`TRUE` returns the full string that can be parsed back into the type, instead of the short one." + +returns: + description: The data type of `input`, including `NOT NULL` for a type that can't be NULL. + nulls: Returns NULL if `force_serializable` is `TRUE` and the type has no serializable string, such as `CHAR(0)`, the type of the literal `''`. + type: "`STRING`, nullable." + +notes: + - The type is computed when the statement is planned, so every row gets the same string. Review Comment: Fixed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
