model_registry_comments

Creates, updates, deletes, gets or lists a model_registry_comments resource.

Overview

Name	model_registry_comments
Type	Resource
Id	databricks_workspace.ml.model_registry_comments

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	deployment_name, name, version, comment		Posts a comment on a model version. A comment can be submitted either by a user or programmatically to
update	update	deployment_name, id, comment		Post an edit to a comment on a model version.
delete	exec	id, deployment_name		Deletes a comment on a model version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
id	string	Unique identifier of an activity

INSERT examples

create

Posts a comment on a model version. A comment can be submitted either by a user or programmatically to

INSERT INTO databricks_workspace.ml.model_registry_comments (
name,
version,
comment,
deployment_name
)
SELECT 
'{{ name }}' /* required */,
'{{ version }}' /* required */,
'{{ comment }}' /* required */,
'{{ deployment_name }}'
RETURNING
comment
;

Manifest

# Description fields are for documentation purposes
- name: model_registry_comments
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the model_registry_comments resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the model.
  - name: version
    value: "{{ version }}"
    description: |
      Version of the model.
  - name: comment
    value: "{{ comment }}"
    description: |
      User-provided comment on the action.

UPDATE examples

update

Post an edit to a comment on a model version.

UPDATE databricks_workspace.ml.model_registry_comments
SET 
id = '{{ id }}',
comment = '{{ comment }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
AND id = '{{ id }}' --required
AND comment = '{{ comment }}' --required
RETURNING
comment;

Lifecycle Methods

delete

Deletes a comment on a model version.

EXEC databricks_workspace.ml.model_registry_comments.delete 
@id='{{ id }}' --required, 
@deployment_name='{{ deployment_name }}' --required
;