Skip to main content

listFunctions

Returns a list of functions registered in the specified database.

Syntax​

listFunctions(dbName: str = None, pattern: str = None)

Parameters​

Parameter

Type

Description

dbName

str, optional

Name of the database to list the functions. Can be qualified with catalog name.

pattern

str, optional

The pattern that the function name needs to match.

Parameter

Type

Description

dbName

str, optional

Name of the database to list the functions. Can be qualified with catalog name.

pattern

str, optional

The pattern that the function name needs to match.

Returns​

list of Function

Notes​

If no database is specified, the current database and catalog are used. This API includes all temporary functions.

Examples​

Python
spark.catalog.listFunctions()
# [Function(name=...

spark.catalog.listFunctions(pattern="to_*")
# [Function(name=...

spark.catalog.listFunctions(pattern="*not_existing_func*")
# []