rdblue commented on code in PR #15180:
URL: https://github.com/apache/iceberg/pull/15180#discussion_r3344311659
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -4307,6 +4410,279 @@ components:
items:
$ref: '#/components/schemas/Namespace'
+ LoadFunctionResult:
+ description: |
+ Result returned when a function is loaded from the catalog.
+
+
+ The function metadata JSON is returned in the `metadata` field. The
location of the metadata
+ file is returned in the `metadata-location` field, if available.
+ type: object
+ required:
+ - metadata
+ properties:
+ metadata-location:
+ type: string
+ metadata:
+ $ref: '#/components/schemas/FunctionMetadata'
+
+ FunctionMetadata:
+ description: |
+ Portable UDF metadata format.
+
+
+ Each function is represented by a self-contained metadata file. The
`format-version` field
+ identifies the UDF metadata format.
+ type: object
+ required:
+ - function-uuid
+ - format-version
+ - definitions
+ - definition-log
+ properties:
+ function-uuid:
+ type: string
+ format: uuid
+ description: A UUID that identifies this UDF, generated once at
creation.
+ format-version:
+ type: integer
+ description: UDF specification format version (must be 1).
+ minimum: 1
+ maximum: 1
+ definitions:
+ type: array
+ description: List of function definition entities.
+ items:
+ $ref: '#/components/schemas/FunctionDefinition'
+ definition-log:
+ type: array
+ description: History of versions within the function's definitions.
+ items:
+ $ref: '#/components/schemas/FunctionDefinitionLogEntry'
+ location:
+ type: string
+ description: The function's base location. This is used to store
function metadata files.
+ properties:
+ type: object
+ description: A string-to-string map of properties.
+ additionalProperties:
+ type: string
+ secure:
+ type: boolean
+ description: Whether it is a secure function.
+ default: false
+ doc:
+ type: string
+ description: Documentation string.
+
+ FunctionDefinition:
+ type: object
+ required:
+ - definition-id
+ - parameters
+ - return-type
+ - versions
+ - current-version-id
+ - function-type
+ properties:
+ definition-id:
+ type: string
+ description: A canonical string derived from the parameter types,
formatted as a comma-separated list with no spaces.
+ parameters:
+ type: array
+ description: Ordered list of function parameters. Invocation order
must match this list.
+ items:
+ $ref: '#/components/schemas/FunctionParameter'
+ return-type:
+ $ref: '#/components/schemas/FunctionDataType'
+ return-nullable:
+ type: boolean
+ description: A hint to indicate whether the return value is nullable
or not.
+ default: true
+ versions:
+ type: array
+ description: Versioned implementations of this definition.
+ items:
+ $ref: '#/components/schemas/FunctionDefinitionVersion'
+ current-version-id:
+ type: integer
+ description: Identifier of the current version for this definition.
+ function-type:
+ type: string
+ description: Function type. When set to "udtf", "return-type" must
be a struct describing the output schema.
+ enum: ["udf", "udtf"]
+ doc:
+ type: string
+ description: Documentation string.
+
+ FunctionParameter:
+ type: object
+ required:
+ - type
+ - name
+ properties:
+ type:
+ $ref: '#/components/schemas/FunctionDataType'
+ name:
+ type: string
+ doc:
+ type: string
+ description: Parameter documentation.
+
+ FunctionDataType:
+ description: >
+ A type for function parameters or return value. It is encoded either
as a type string
+ or as a JSON object for nested types (struct, list, map) following the
UDF spec Types section.
+
+
+ Primitive and semi-structured type strings are encoded based on the
Iceberg type JSON
+ representation (e.g., "int", "string", "timestamp", "decimal(9,2)",
"variant"). Type
+ strings must contain no spaces or quote characters.
+
+
+ Nested types are based on the Iceberg type JSON representation, but
the UDF spec only
+ requires a subset of fields (e.g., list requires `type` and `element`;
map requires `type`,
+ `key`, and `value`; struct requires `type` and `fields`). Any other
fields must be ignored.
+ oneOf:
+ - type: string
+ - $ref: '#/components/schemas/FunctionListType'
+ - $ref: '#/components/schemas/FunctionMapType'
+ - $ref: '#/components/schemas/FunctionStructType'
+
+ FunctionListType:
+ description: UDF list type object.
+ type: object
+ required:
+ - type
+ - element
+ properties:
+ type:
+ type: string
+ const: "list"
+ element:
+ $ref: '#/components/schemas/FunctionDataType'
+
+ FunctionMapType:
+ description: UDF map type object.
+ type: object
+ required:
+ - type
+ - key
+ - value
+ properties:
+ type:
+ type: string
+ const: "map"
+ key:
+ $ref: '#/components/schemas/FunctionDataType'
+ value:
+ $ref: '#/components/schemas/FunctionDataType'
+
+ FunctionStructType:
+ description: UDF struct type object.
+ type: object
+ required:
+ - type
+ - fields
+ properties:
+ type:
+ type: string
+ const: "struct"
+ fields:
+ type: array
+ items:
+ $ref: '#/components/schemas/FunctionStructField'
+
+ FunctionStructField:
+ description: UDF struct field.
+ type: object
+ required:
+ - name
+ - type
+ properties:
+ name:
+ type: string
+ type:
+ $ref: '#/components/schemas/FunctionDataType'
+
+ FunctionDefinitionVersion:
+ type: object
+ required:
+ - version-id
+ - representations
+ - timestamp-ms
+ properties:
+ version-id:
+ type: integer
+ description: Monotonically increasing identifier of the definition
version.
+ representations:
+ type: array
+ description: UDF implementations.
+ items:
+ $ref: '#/components/schemas/FunctionRepresentation'
+ deterministic:
+ type: boolean
+ description: Whether the function is deterministic.
+ default: false
+ on-null-input:
+ type: string
+ description: Defines how the UDF behaves when any input parameter is
NULL.
+ enum: ["return-null", "call"]
+ default: "call"
+ timestamp-ms:
+ type: integer
+ format: int64
+ description: Creation timestamp of this version (unix epoch millis).
+
+ FunctionRepresentation:
+ description: UDF implementation representation.
+ oneOf:
+ - $ref: '#/components/schemas/FunctionSqlRepresentation'
+
+ FunctionSqlRepresentation:
Review Comment:
Nit: we usually don't use Java's convention to convert letters in acronyms
to lower case. Usually we would use "SQL" rather than "Sql".
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
