Package com.databricks.sdk.service.catalog

Class FunctionsAPI

java.lang.Object

com.databricks.sdk.service.catalog.FunctionsAPI

@Generated
public class FunctionsAPI
extends Object

Functions implement User-Defined Functions (UDFs) in Unity Catalog.

The function implementation can be any SQL expression or Query, and it can be invoked wherever a table reference is allowed in a query. In Unity Catalog, a function resides at the same level as a table, so it can be referenced with the form __catalog_name__.__schema_name__.__function_name__.

Constructor Summary

Constructors

Constructor	Description
FunctionsAPI(ApiClient apiClient)	Regular-use constructor
FunctionsAPI(FunctionsService mock)	Constructor for mocks

Method Summary

Modifier and Type	Method	Description
FunctionInfo	create(CreateFunction request)	Create a function.
FunctionInfo	create(String name, String catalogName, String schemaName, Collection<FunctionParameterInfo> inputParams, ColumnTypeName dataType, String fullDataType, Collection<FunctionParameterInfo> returnParams, CreateFunctionRoutineBody routineBody, String routineDefinition, Collection<Dependency> routineDependencies, CreateFunctionParameterStyle parameterStyle, boolean isDeterministic, CreateFunctionSqlDataAccess sqlDataAccess, boolean isNullCall, CreateFunctionSecurityType securityType, String specificName)
void	delete(DeleteFunctionRequest request)	Delete a function.
void	delete(String name)
FunctionInfo	get(GetFunctionRequest request)	Get a function.
FunctionInfo	get(String name)
FunctionsService	impl()
Iterable<FunctionInfo>	list(ListFunctionsRequest request)	List functions.
Iterable<FunctionInfo>	list(String catalogName, String schemaName)
FunctionInfo	update(UpdateFunction request)	Update a function.
FunctionInfo	update(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionsAPI

public FunctionsAPI(ApiClient apiClient)

Regular-use constructor

FunctionsAPI

public FunctionsAPI(FunctionsService mock)

Constructor for mocks

Method Detail

create

public FunctionInfo create(String name,
                           String catalogName,
                           String schemaName,
                           Collection<FunctionParameterInfo> inputParams,
                           ColumnTypeName dataType,
                           String fullDataType,
                           Collection<FunctionParameterInfo> returnParams,
                           CreateFunctionRoutineBody routineBody,
                           String routineDefinition,
                           Collection<Dependency> routineDependencies,
                           CreateFunctionParameterStyle parameterStyle,
                           boolean isDeterministic,
                           CreateFunctionSqlDataAccess sqlDataAccess,
                           boolean isNullCall,
                           CreateFunctionSecurityType securityType,
                           String specificName)

create

public FunctionInfo create(CreateFunction request)

Create a function.

Creates a new function

The user must have the following permissions in order for the function to be created: - **USE_CATALOG** on the function's parent catalog - **USE_SCHEMA** and **CREATE_FUNCTION** on the function's parent schema

delete

public void delete(String name)

delete

public void delete(DeleteFunctionRequest request)

Delete a function.

Deletes the function that matches the supplied name. For the deletion to succeed, the user must satisfy one of the following conditions: - Is the owner of the function's parent catalog - Is the owner of the function's parent schema and have the **USE_CATALOG** privilege on its parent catalog - Is the owner of the function itself and have both the **USE_CATALOG** privilege on its parent catalog and the **USE_SCHEMA** privilege on its parent schema

get

public FunctionInfo get(String name)

get

public FunctionInfo get(GetFunctionRequest request)

Get a function.

Gets a function from within a parent catalog and schema. For the fetch to succeed, the user must satisfy one of the following requirements: - Is a metastore admin - Is an owner of the function's parent catalog - Have the **USE_CATALOG** privilege on the function's parent catalog and be the owner of the function - Have the **USE_CATALOG** privilege on the function's parent catalog, the **USE_SCHEMA** privilege on the function's parent schema, and the **EXECUTE** privilege on the function itself

list

public Iterable<FunctionInfo> list(String catalogName,
                                   String schemaName)

list

public Iterable<FunctionInfo> list(ListFunctionsRequest request)

List functions.

List functions within the specified parent catalog and schema. If the user is a metastore admin, all functions are returned in the output list. Otherwise, the user must have the **USE_CATALOG** privilege on the catalog and the **USE_SCHEMA** privilege on the schema, and the output list contains only functions for which either the user has the **EXECUTE** privilege or the user is the owner. There is no guarantee of a specific ordering of the elements in the array.

update

public FunctionInfo update(String name)

update

public FunctionInfo update(UpdateFunction request)

Update a function.

Updates the function that matches the supplied name. Only the owner of the function can be updated. If the user is not a metastore admin, the user must be a member of the group that is the new function owner. - Is a metastore admin - Is the owner of the function's parent catalog - Is the owner of the function's parent schema and has the **USE_CATALOG** privilege on its parent catalog - Is the owner of the function itself and has the **USE_CATALOG** privilege on its parent catalog as well as the **USE_SCHEMA** privilege on the function's parent schema.

impl

public FunctionsService impl()