model_transition_requests

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

Overview

Name	model_transition_requests
Type	Resource
Id	databricks_workspace.machinelearning.model_transition_requests

Fields

The following fields are returned by SELECT queries:

listtransitionrequests

Fetched all open requests successfully.

Name	Datatype	Description
id	string
user_id	string
activity_type	string
comment	string
creation_timestamp	integer
from_stage	string
last_updated_timestamp	integer
system_comment	string
to_stage	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
listtransitionrequests	select	deployment_name		Gets a list of all open stage transition requests for the model version.
createtransitionrequest	insert	deployment_name		Creates a model version stage transition request.
deletetransitionrequest	delete	deployment_name		Cancels a model version stage transition request.
approvetransitionrequest	exec	deployment_name		Approves a model version stage transition request.
rejecttransitionrequest	exec	deployment_name		Rejects a model version stage transition request.
transitionstage	exec	deployment_name		Transition a model version's stage. This is a Databricks workspace version of the

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

listtransitionrequests

Gets a list of all open stage transition requests for the model version.

SELECT
id,
user_id,
activity_type,
comment,
creation_timestamp,
from_stage,
last_updated_timestamp,
system_comment,
to_stage
FROM databricks_workspace.machinelearning.model_transition_requests
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

createtransitionrequest

Creates a model version stage transition request.

INSERT INTO databricks_workspace.machinelearning.model_transition_requests (
data__name,
data__version,
data__stage,
data__comment,
deployment_name
)
SELECT 
'{{ name }}',
'{{ version }}',
'{{ stage }}',
'{{ comment }}',
'{{ deployment_name }}'
RETURNING
request
;

Manifest

# Description fields are for documentation purposes
- name: model_transition_requests
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the model_transition_requests resource.
    - name: name
      value: required
    - name: version
      value: string
    - name: stage
      value: required
    - name: comment
      value: string

DELETE examples

deletetransitionrequest

Cancels a model version stage transition request.

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

Lifecycle Methods

approvetransitionrequest

Approves a model version stage transition request.

EXEC databricks_workspace.machinelearning.model_transition_requests.approvetransitionrequest 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"name": "{{ name }}", 
"version": "{{ version }}", 
"stage": "{{ stage }}", 
"archive_existing_versions": "{{ archive_existing_versions }}", 
"comment": "{{ comment }}"
}';

rejecttransitionrequest

Rejects a model version stage transition request.

EXEC databricks_workspace.machinelearning.model_transition_requests.rejecttransitionrequest 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"name": "{{ name }}", 
"version": "{{ version }}", 
"stage": "{{ stage }}", 
"comment": "{{ comment }}"
}';

transitionstage

Transition a model version's stage. This is a Databricks workspace version of the

EXEC databricks_workspace.machinelearning.model_transition_requests.transitionstage 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"name": "{{ name }}", 
"version": "{{ version }}", 
"stage": "{{ stage }}", 
"archive_existing_versions": "{{ archive_existing_versions }}", 
"comment": "{{ comment }}"
}';