CRUD

The CRUD methods are used to create, read, update and delete workflows. There are two ways to use them. The first is through the SDK and the second is through the Project object. The syntax is the same for all CRUD methods. If you want to manage workflows from the project, you can use the Project object and avoid to specify the project parameter. In this last case, you need to specify every parameter as keyword argument.

Example:

import digitalhub as dh

project = dh.get_or_create_project("my-project")

# Use CRUD method on project

workflow = project.new_workflow(name="my-workflow",
                                kind="kfp",
                                code_src="pipeline.py",
                                handler="pipeline-handler")

# Use CRUD method from SDK

workflow = dh.new_workflow(project="my-project",
                           name="my-function",
                           kind="kfp",
                           code_src="pipeline.py",
                           handler="pipeline-handler")

A workflow entity can be managed with the following methods.

Create:

new_workflow

Read:

get_workflow
get_workflow_versions
import_workflow
list_workflows

Update:

update_workflow

Delete:

delete_workflow

Create

You can create a workflow with the new_workflow(). The kwargs parameters are determined by the kind of the object, and are described in the kinds section.

New

This function create a new entity and saves it into the backend.

`new_workflow`

Parameters:

Name	Type	Description	Default
`project`	`str`	Project name.	required
`name`	`str`	Object name.	required
`uuid`	`str`	ID of the object.	`None`
`description`	`str`	Description of the object (human readable).	`None`
`labels`	`list[str]`	List of labels.	`None`
`embedded`	`bool`	Flag to determine if object spec must be embedded in project spec.	`False`
`**kwargs`	`dict`	Spec keyword arguments.	`{}`

Returns:

Type	Description
`Workflow`	Object instance.

Examples:

>>> obj = new_function(project="my-project",
>>>                    name="my-workflow",
>>>                    kind="kfp",
>>>                    code_src="pipeline.py",
>>>                    handler="pipeline-handler")

Read

To read workflows you can use the get_workflow(), get_workflow_versions(), list_workflows() or import_workflow() workflows.

Get

This function searches for a single workflow into the backend. If you want to collect a workflow from the backend using get_workflow(), you have two options:

The first one is to use the key parameter which has the pattern store://<project-name>/<entity-type>/<entity-kind>/<entity-name>:<entity-id>.
The second one is to use the entity name as identifier, the project name as project and the entity id as entity_id parameters. If you do not specify the entity id, you will get the latest version.

`get_workflow`

Parameters:

Name	Type	Description	Default
`identifier`	`str`	Entity key (store://...) or entity name.	required
`project`	`str`	Project name.	`None`
`entity_id`	`str`	Entity ID.	`None`

Returns:

Type	Description
`Workflow`	Object instance.

Examples:

Using entity key:

>>> obj = get_workflow("store://my-workflow-key")

Using entity name:

>>> obj = get_workflow("my-workflow-name"
>>>                    project="my-project",
>>>                    entity_id="my-workflow-id")

Get versions

This function returns all the versions of a workflow from the backend.

`get_workflow_versions`

Parameters:

Name	Type	Description	Default
`identifier`	`str`	Entity key (store://...) or entity name.	required
`project`	`str`	Project name.	`None`

Returns:

Type	Description
`list[Workflow]`	List of object instances.

Examples:

Using entity key:

>>> obj = get_workflow_versions("store://my-workflow-key")

Using entity name:

>>> obj = get_workflow_versions("my-workflow-name"
>>>                             project="my-project")

List

This function returns all the latest workflows from the backend related to a project.

`list_workflows`

Parameters:

Name	Type	Description	Default
`project`	`str`	Project name.	required
`q`	`str`	Query string to filter objects.	`None`
`name`	`str`	Object name.	`None`
`kind`	`str`	Kind of the object.	`None`
`user`	`str`	User that created the object.	`None`
`state`	`str`	Object state.	`None`
`created`	`str`	Creation date filter.	`None`
`updated`	`str`	Update date filter.	`None`
`versions`	`str`	Object version, default is latest.	`None`

Returns:

Type	Description
`list[Workflow]`	List of object instances.

Examples:

>>> objs = list_workflows(project="my-project")

Import

This function load the workflow from a local yaml file descriptor.

`import_workflow`

Parameters:

Name	Type	Description	Default
`file`	`str`	Path to the YAML file.	`None`
`key`	`str`	Entity key (store://...).	`None`
`reset_id`	`bool`	Flag to determine if the ID of executable entities should be reset.	`False`
`context`	`str`	Project name to use for context resolution.	`None`

Returns:

Type	Description
`Workflow`	Object instance.

Examples:

>>> obj = import_workflow("my-workflow.yaml")

Update

To update a workflow you can use the update_workflow() method.

`update_workflow`

Parameters:

Name	Type	Description	Default
`entity`	`Workflow`	Object to update.	required

Returns:

Type	Description
`Workflow`	Entity updated.

Examples:

>>> obj = update_workflow(obj)

Delete

To delete a workflow you can use the delete_workflow() method.

`delete_workflow`

Parameters:

Name	Type	Description	Default
`identifier`	`str`	Entity key (store://...) or entity name.	required
`project`	`str`	Project name.	`None`
`entity_id`	`str`	Entity ID.	`None`
`delete_all_versions`	`bool`	Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.	`False`
`cascade`	`bool`	Cascade delete.	`True`

Returns:

Type	Description
`dict`	Response from backend.

Examples:

If delete_all_versions is False:

>>> obj = delete_workflow("store://my-workflow-key")

Otherwise:

>>> obj = delete_workflow("workflow-name",
>>>                       project="my-project",
>>>                       delete_all_versions=True)