Interface FunctionsService
-
@Generated public interface FunctionsService
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__.
This is the high-level interface, that contains generated methods.
Evolving: this interface is under development. Method signatures may change.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FunctionInfo
create(CreateFunction createFunction)
Create a function.void
delete(DeleteFunctionRequest deleteFunctionRequest)
Delete a function.FunctionInfo
get(GetFunctionRequest getFunctionRequest)
Get a function.ListFunctionsResponse
list(ListFunctionsRequest listFunctionsRequest)
List functions.FunctionInfo
update(UpdateFunction updateFunction)
Update a function.
-
-
-
Method Detail
-
create
FunctionInfo create(CreateFunction createFunction)
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
void delete(DeleteFunctionRequest deleteFunctionRequest)
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
FunctionInfo get(GetFunctionRequest getFunctionRequest)
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
ListFunctionsResponse list(ListFunctionsRequest listFunctionsRequest)
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
FunctionInfo update(UpdateFunction updateFunction)
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.
-
-