registered_models

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

Overview

Name	registered_models
Type	Resource
Id	databricks_workspace.unitycatalog.registered_models

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the properties of the registered model

Name	Datatype	Description
id	string
name	string
metastore_id	string
catalog_name	string
full_name	string
schema_name	string
comment	string
created_at	integer
created_by	string
owner	string
securable_kind	string
securable_type	string
storage_location	string
updated_at	integer
updated_by	string

list

The registered model list was successfully retrieved

Name	Datatype	Description
id	string
name	string
metastore_id	string
catalog_name	string
full_name	string
schema_name	string
comment	string
created_at	integer
created_by	string
owner	string
securable_kind	string
securable_type	string
storage_location	string
updated_at	integer
updated_by	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Get a registered model.
list	select	deployment_name		List registered models. You can list registered models under a particular schema, or list all registered models in the current metastore.
create	insert	deployment_name		Creates a new registered model in Unity Catalog.
update	update	deployment_name		Updates the specified registered model.
delete	delete	deployment_name		Deletes a registered model and all its model versions from the specified parent catalog and schema.

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

get

Get a registered model.

SELECT
id,
name,
metastore_id,
catalog_name,
full_name,
schema_name,
comment,
created_at,
created_by,
owner,
securable_kind,
securable_type,
storage_location,
updated_at,
updated_by
FROM databricks_workspace.unitycatalog.registered_models
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

List registered models. You can list registered models under a particular schema, or list all registered models in the current metastore.

SELECT
id,
name,
metastore_id,
catalog_name,
full_name,
schema_name,
comment,
created_at,
created_by,
owner,
securable_kind,
securable_type,
storage_location,
updated_at,
updated_by
FROM databricks_workspace.unitycatalog.registered_models
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a new registered model in Unity Catalog.

INSERT INTO databricks_workspace.unitycatalog.registered_models (
data__catalog_name,
data__schema_name,
data__name,
data__storage_location,
data__comment,
deployment_name
)
SELECT 
'{{ catalog_name }}',
'{{ schema_name }}',
'{{ name }}',
'{{ storage_location }}',
'{{ comment }}',
'{{ deployment_name }}'
RETURNING
id,
name,
metastore_id,
catalog_name,
full_name,
schema_name,
comment,
created_at,
created_by,
owner,
securable_kind,
securable_type,
storage_location,
updated_at,
updated_by
;

Manifest

# Description fields are for documentation purposes
- name: registered_models
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the registered_models resource.
    - name: catalog_name
      value: required
    - name: schema_name
      value: string
    - name: name
      value: required
    - name: storage_location
      value: string
    - name: comment
      value: required

UPDATE examples

update

Updates the specified registered model.

UPDATE databricks_workspace.unitycatalog.registered_models
SET 
data__owner = '{{ owner }}',
data__comment = '{{ comment }}',
data__new_name = '{{ new_name }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
id,
name,
metastore_id,
catalog_name,
full_name,
schema_name,
comment,
created_at,
created_by,
owner,
securable_kind,
securable_type,
storage_location,
updated_at,
updated_by;

DELETE examples

delete

Deletes a registered model and all its model versions from the specified parent catalog and schema.

DELETE FROM databricks_workspace.unitycatalog.registered_models
WHERE deployment_name = '{{ deployment_name }}' --required;