model_versions

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

Overview

Name	model_versions
Type	Resource
Id	databricks_workspace.machinelearning.model_versions

Fields

The following fields are returned by SELECT queries:

searchmodelversions

Name	Datatype	Description
name	string
run_id	string
user_id	string
creation_timestamp	integer
current_stage	string
description	string
last_updated_timestamp	integer
run_link	string
source	string
status	string
status_message	string
tags	array
version	string

getmodelversion

Name	Datatype	Description
name	string
run_id	string
user_id	string
creation_timestamp	integer
current_stage	string
description	string
last_updated_timestamp	integer
run_link	string
source	string
status	string
status_message	string
tags	array
version	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
searchmodelversions	select	deployment_name		Searches for specific model versions based on the supplied
getmodelversion	select	deployment_name		Get a model version.
createmodelversion	insert	deployment_name		Creates a model version.
updatemodelversion	update	deployment_name		Updates the model version.
deletemodelversion	delete	deployment_name		Deletes 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)

SELECT examples

searchmodelversions

Searches for specific model versions based on the supplied

SELECT
name,
run_id,
user_id,
creation_timestamp,
current_stage,
description,
last_updated_timestamp,
run_link,
source,
status,
status_message,
tags,
version
FROM databricks_workspace.machinelearning.model_versions
WHERE deployment_name = '{{ deployment_name }}' -- required;

getmodelversion

Get a model version.

SELECT
name,
run_id,
user_id,
creation_timestamp,
current_stage,
description,
last_updated_timestamp,
run_link,
source,
status,
status_message,
tags,
version
FROM databricks_workspace.machinelearning.model_versions
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

createmodelversion

Creates a model version.

INSERT INTO databricks_workspace.machinelearning.model_versions (
data__name,
data__source,
data__run_id,
data__run_link,
data__description,
data__tags,
deployment_name
)
SELECT 
'{{ name }}',
'{{ source }}',
'{{ run_id }}',
'{{ run_link }}',
'{{ description }}',
'{{ tags }}',
'{{ deployment_name }}'
RETURNING
model_version
;

Manifest

# Description fields are for documentation purposes
- name: model_versions
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the model_versions resource.
    - name: name
      value: required
    - name: source
      value: string
    - name: run_id
      value: required
    - name: run_link
      value: string
    - name: description
      value: string
    - name: tags
      value: Array of object

UPDATE examples

updatemodelversion

Updates the model version.

UPDATE databricks_workspace.machinelearning.model_versions
SET 
data__name = '{{ name }}',
data__version = '{{ version }}',
data__description = '{{ description }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

deletemodelversion

Deletes a model version.

DELETE FROM databricks_workspace.machinelearning.model_versions
WHERE deployment_name = '{{ deployment_name }}' --required;