gravitino.api.function.function_type.FunctionType

class gravitino.api.function.function_type.FunctionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Function type supported by Gravitino.

__init__(*args, **kwds)

Methods

from_string(type_str)	Parse the function type from a string value.
type_name()	Returns the canonical string representation used by APIs.

Attributes

SCALAR	Scalar function that returns a single value per row.
AGGREGATE	Aggregate function that combines multiple rows into a single value.
TABLE	Table-valued function that returns a table of rows.

AGGREGATE = 'aggregate'

Aggregate function that combines multiple rows into a single value.

SCALAR = 'scalar'

Scalar function that returns a single value per row.

TABLE = 'table'

Table-valued function that returns a table of rows.

classmethod from_string(type_str: str) → FunctionType

Parse the function type from a string value.

Args:

type_str: The string to parse.

Returns:

The parsed FunctionType.

Raises:

ValueError: If the value cannot be parsed.

type_name() → str

Returns the canonical string representation used by APIs.