Skip to content

Latest commit

 

History

History
123 lines (75 loc) · 3.91 KB

FunctionsApi.md

File metadata and controls

123 lines (75 loc) · 3.91 KB
Raw

FunctionsApi

All URIs are relative to http://localhost:8080/api/2.1/unity-catalog

Method HTTP request Description
createFunction POST /functions Create a function. WARNING: This API is experimental and will change in future versions.
deleteFunction DELETE /functions/{name} Delete a function
getFunction GET /functions/{name} Get a function
listFunctions GET /functions List functions

createFunction

FunctionInfo createFunction(CreateFunctionRequest)

Create a function. WARNING: This API is experimental and will change in future versions.

Creates a new function instance. WARNING: This API is experimental and will change in future versions.

Parameters

Name Type Description Notes
CreateFunctionRequest CreateFunctionRequest [optional]

Return type

FunctionInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteFunction

oas_any_type_not_mapped deleteFunction(name)

Delete a function

Deletes the function that matches the supplied name.

Parameters

Name Type Description Notes
name String The fully-qualified name of the function (of the form catalog_name.schema_name.function__name). [default to null]

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getFunction

FunctionInfo getFunction(name)

Get a function

Gets a function from within a parent catalog and schema.

Parameters

Name Type Description Notes
name String The fully-qualified name of the function (of the form catalog_name.schema_name.function__name). [default to null]

Return type

FunctionInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listFunctions

ListFunctionsResponse listFunctions(catalog_name, schema_name, max_results, page_token)

List functions

List functions within the specified parent catalog and schema. There is no guarantee of a specific ordering of the elements in the array.

Parameters

Name Type Description Notes
catalog_name String Name of parent catalog for functions of interest. [default to null]
schema_name String Parent schema of functions. [default to null]
max_results Integer Maximum number of functions to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; [optional] [default to null]
page_token String Opaque pagination token to go to next page based on previous query. [optional] [default to null]

Return type

ListFunctionsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json