Skip to content

Manage functions

The methods below retrieve, import, update, or delete functions. They can be called directly from the SDK or through a Project object. When using a Project object, omit the project parameter and pass the other parameters as keyword arguments.

Read

Use the read methods to retrieve functions from the backend or import them from a YAML descriptor.

get_function

Get a function entity from the backend.

Parameters:

Name Type Description Default
identifier str

Entity name or entity key (store://<project>/<entity_type>/<kind>/<(name>:)<uuid>).

required
project str

Project name. Required when identifier is an entity name.

None
entity_id str

Entity identifier. If omitted, the latest version is returned.

None

Returns:

Type Description
Function

Retrieved function entity.

Examples:

Get the latest function by name and project:

import digitalhub as dh

function = dh.get_function("my-function", project="my-project")

Get a specific function version by key:

function = dh.get_function(
    "store://my-project/function/python/my-function:123e4567-e89b-42d3-a456-426614174000",
)
get_function_versions

Get all versions of a function entity from the backend.

Parameters:

Name Type Description Default
identifier str

Entity name or entity key (store://<project>/<entity_type>/<kind>/<(name>:)<uuid>).

required
project str

Project name. Required when identifier is an entity name.

None

Returns:

Type Description
list[Function]

All versions of the function entity.

Examples:

Get all function versions by name and project:

import digitalhub as dh

functions = dh.get_function_versions("my-function", project="my-project")

Get all function versions by key:

functions = dh.get_function_versions(
    "store://my-project/function/python/my-function:123e4567-e89b-42d3-a456-426614174000",
)
list_functions

List function entities in a project.

Parameters:

Name Type Description Default
project str

Project name.

required
q str

Query string used to filter entities.

None
name str

Entity name used to filter results.

None
kind str

Entity kind used to filter results.

None
labels list[str]

Labels used to filter results.

None
user str

User who created the entity.

None
state str

Entity state used to filter results.

None
created str

Creation date filter.

None
updated str

Update date filter.

None
versions str

Version filter. Defaults to the latest version.

None

Returns:

Type Description
list[Function]

Function entities matching the filters.

Examples:

List functions in a project:

import digitalhub as dh

functions = dh.list_functions(project="my-project")
import_function

Import a function entity from a YAML file or entity key.

Parameters:

Name Type Description Default
file str

Path to a YAML file containing the entity descriptor. Provide either file or key.

None
key str

Entity key (store://<project>/<entity_type>/<kind>/<(name>:)<uuid>). Provide either file or key.

None
reset_id bool

Whether to generate a new entity identifier instead of preserving the identifier from the imported entity.

False
context str

Project name used for context resolution. If omitted, the project from the entity descriptor is used.

None

Returns:

Type Description
Function

Imported function entity.

Examples:

Import a function from a YAML file:

import digitalhub as dh

function = dh.import_function("my-function.yaml")

Update

Update a function after changing its mutable metadata.

update_function

Update a function entity in the backend.

Parameters:

Name Type Description Default
entity Function

Entity to update. The entity specification is immutable.

required

Returns:

Type Description
Function

Updated function entity.

Examples:

Update a function description:

import digitalhub as dh

function = dh.get_function("my-function", project="my-project")
function.set_description("Updated function")
function = dh.update_function(function)

Delete

Delete one function version or all versions of a function.

delete_function

Delete one or more versions of a function entity from the backend.

Parameters:

Name Type Description Default
identifier str

Entity name or entity key (store://<project>/<entity_type>/<kind>/<(name>:)<uuid>). Use an entity name when delete_all_versions is True.

required
project str

Project name. Required when identifier is an entity name.

None
entity_id str

Identifier of the version to delete. Required when delete_all_versions is False and identifier does not contain the version identifier.

None
delete_all_versions bool

Whether to delete all versions of the named entity. When False, only one version is deleted.

False
cascade bool

Whether to request cascade deletion from the backend.

True

Returns:

Type Description
dict

Response data from the backend.

Examples:

Delete one function version by key:

import digitalhub as dh

dh.delete_function(
    "store://my-project/function/python/my-function:123e4567-e89b-42d3-a456-426614174000",
)

Delete one function version by name and project:

dh.delete_function(
    "my-function",
    project="my-project",
    entity_id="123e4567-e89b-42d3-a456-426614174000",
)

Delete all function versions by name and project:

dh.delete_function(
    "my-function",
    project="my-project",
    delete_all_versions=True,
)