Package io.trino.spi.function

Class FunctionMetadata

java.lang.Object

io.trino.spi.function.FunctionMetadata

@Experimental(eta="2022-10-31")
public class FunctionMetadata
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FunctionMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static FunctionMetadata.Builder	aggregateBuilder(String canonicalName)
static FunctionMetadata.Builder	builder(String canonicalName, FunctionKind functionKind)
static FunctionMetadata	fromJson(FunctionId functionId, Signature signature, String canonicalName, Set<String> names, FunctionNullability functionNullability, boolean hidden, boolean deterministic, String description, FunctionKind kind, boolean deprecated)
String	getCanonicalName()	The canonical name of the function.
String	getDescription()
FunctionId	getFunctionId()	Unique id of this function.
FunctionNullability	getFunctionNullability()
FunctionKind	getKind()
Set<String>	getNames()	Canonical name and any aliases.
Signature	getSignature()	Signature of a matching call site.
boolean	isDeprecated()
boolean	isDeterministic()
boolean	isHidden()
static FunctionMetadata.Builder	operatorBuilder(OperatorType operatorType)
static FunctionMetadata.Builder	scalarBuilder(String canonicalName)
String	toString()
static FunctionMetadata.Builder	windowBuilder(String canonicalName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getFunctionId

public FunctionId getFunctionId()

Unique id of this function.

getSignature

public Signature getSignature()

Signature of a matching call site.

getCanonicalName

public String getCanonicalName()

The canonical name of the function.

getNames

public Set<String> getNames()

Canonical name and any aliases.

getFunctionNullability

public FunctionNullability getFunctionNullability()

isHidden

public boolean isHidden()

isDeterministic

public boolean isDeterministic()

getDescription

public String getDescription()

getKind

public FunctionKind getKind()

isDeprecated

public boolean isDeprecated()

fromJson

public static FunctionMetadata fromJson(FunctionId functionId,
 Signature signature,
 String canonicalName,
 Set<String> names,
 FunctionNullability functionNullability,
 boolean hidden,
 boolean deterministic,
 String description,
 FunctionKind kind,
 boolean deprecated)

toString

public String toString()

Overrides:

toString in class Object

scalarBuilder

public static FunctionMetadata.Builder scalarBuilder(String canonicalName)

operatorBuilder

public static FunctionMetadata.Builder operatorBuilder(OperatorType operatorType)

aggregateBuilder

public static FunctionMetadata.Builder aggregateBuilder(String canonicalName)

windowBuilder

public static FunctionMetadata.Builder windowBuilder(String canonicalName)

builder

public static FunctionMetadata.Builder builder(String canonicalName,
 FunctionKind functionKind)