model_registry

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

Overview

Name	model_registry
Type	Resource
Id	databricks_workspace.ml.model_registry

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶registered_model_databricks	object

list

Name	Datatype	Description
name	string	Unique name for the model.
user_id	string	User that created this `registered_model`
creation_timestamp	integer
description	string	Description of this `registered_model`.
last_updated_timestamp	integer	Timestamp recorded when metadata for this `registered_model` was last updated.
▶latest_versions	array	Collection of latest model versions for each stage. Only contains models with current `READY` status.
▶tags	array	Tags: Additional metadata key-value pairs for this `registered_model`.

search

Name	Datatype	Description
name	string	Unique name for the model.
user_id	string	User that created this `registered_model`
creation_timestamp	integer
description	string	Description of this `registered_model`.
last_updated_timestamp	integer	Timestamp recorded when metadata for this `registered_model` was last updated.
▶latest_versions	array	Collection of latest model versions for each stage. Only contains models with current `READY` status.
▶tags	array	Tags: Additional metadata key-value pairs for this `registered_model`.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, deployment_name		Get the details of a model. This is a Databricks workspace version of the [MLflow endpoint] that also
list	select	deployment_name	max_results, page_token	Lists all available registered models, up to the limit specified in max_results.
search	select	filter, deployment_name	max_results, order_by, page_token	Search for registered models based on the specified filter.
create	insert	deployment_name, name		Creates a new registered model with the name specified in the request body. Throws
update	update	deployment_name, name		Updates a registered model.
delete	delete	name, deployment_name		Deletes a registered model.
delete_tag	exec	name, key, deployment_name		Deletes the tag for a registered model.
rename	exec	deployment_name, name		Renames a registered model.
set_tag	exec	deployment_name, name, key, value		Sets a tag on a registered model.

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)
filter	string	String filter condition, like "name LIKE 'my-model-name'". Interpreted in the backend automatically as "name LIKE '%my-model-name%'". Single boolean condition, with string values wrapped in single quotes.
key	string	Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.
name	string	Name of the registered model that the tag was logged under.
max_results	integer	Maximum number of models desired. Default is 100. Max threshold is 1000.
order_by	array	List of columns for ordering search results, which can include model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default. Tiebreaks are done by model name ASC.
page_token	string	Pagination token to go to the next page based on a previous search query.

SELECT examples

get

Get the details of a model. This is a Databricks workspace version of the [MLflow endpoint] that also

SELECT
registered_model_databricks
FROM databricks_workspace.ml.model_registry
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Lists all available registered models, up to the limit specified in max_results.

SELECT
name,
user_id,
creation_timestamp,
description,
last_updated_timestamp,
latest_versions,
tags
FROM databricks_workspace.ml.model_registry
WHERE deployment_name = '{{ deployment_name }}' -- required
AND max_results = '{{ max_results }}'
AND page_token = '{{ page_token }}'
;

search

Search for registered models based on the specified filter.

SELECT
name,
user_id,
creation_timestamp,
description,
last_updated_timestamp,
latest_versions,
tags
FROM databricks_workspace.ml.model_registry
WHERE filter = '{{ filter }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND max_results = '{{ max_results }}'
AND order_by = '{{ order_by }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a new registered model with the name specified in the request body. Throws

INSERT INTO databricks_workspace.ml.model_registry (
name,
description,
tags,
deployment_name
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ deployment_name }}'
RETURNING
registered_model
;

Manifest

# Description fields are for documentation purposes
- name: model_registry
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the model_registry resource.
  - name: name
    value: "{{ name }}"
    description: |
      Register models under this name
  - name: description
    value: "{{ description }}"
    description: |
      Optional description for registered model.
  - name: tags
    description: |
      Additional metadata for registered model.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update

Updates a registered model.

UPDATE databricks_workspace.ml.model_registry
SET 
name = '{{ name }}',
description = '{{ description }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
AND name = '{{ name }}' --required
RETURNING
registered_model;

DELETE examples

delete

Deletes a registered model.

DELETE FROM databricks_workspace.ml.model_registry
WHERE name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;

Lifecycle Methods

delete_tag

Deletes the tag for a registered model.

EXEC databricks_workspace.ml.model_registry.delete_tag 
@name='{{ name }}' --required, 
@key='{{ key }}' --required, 
@deployment_name='{{ deployment_name }}' --required
;

rename

Renames a registered model.

EXEC databricks_workspace.ml.model_registry.rename 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"name": "{{ name }}", 
"new_name": "{{ new_name }}"
}'
;

set_tag

Sets a tag on a registered model.

EXEC databricks_workspace.ml.model_registry.set_tag 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"name": "{{ name }}", 
"key": "{{ key }}", 
"value": "{{ value }}"
}'
;