external_metadata

Creates, updates, deletes, gets or lists an external_metadata resource.

Overview

Name	external_metadata
Type	Resource
Id	databricks_workspace.catalog.external_metadata

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Unique identifier of the external metadata object.
name	string
metastore_id	string	Unique identifier of parent metastore.
columns	array	List of columns associated with the external metadata object.
create_time	string	Time at which this external metadata object was created.
created_by	string	Username of external metadata object creator.
description	string	User-provided free-form text description.
entity_type	string	Type of entity within the external system.
owner	string	Owner of the external metadata object.
properties	object	A map of key-value properties attached to the external metadata object.
system_type	string	Type of external system. (AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, STREAM_NATIVE, TABLEAU, TERADATA, WORKDAY)
update_time	string	Time at which this external metadata object was last modified.
updated_by	string	Username of user who last modified external metadata object.
url	string	URL associated with the external metadata object.

list

Name	Datatype	Description
id	string	Unique identifier of the external metadata object.
name	string
metastore_id	string	Unique identifier of parent metastore.
columns	array	List of columns associated with the external metadata object.
create_time	string	Time at which this external metadata object was created.
created_by	string	Username of external metadata object creator.
description	string	User-provided free-form text description.
entity_type	string	Type of entity within the external system.
owner	string	Owner of the external metadata object.
properties	object	A map of key-value properties attached to the external metadata object.
system_type	string	Type of external system. (AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, STREAM_NATIVE, TABLEAU, TERADATA, WORKDAY)
update_time	string	Time at which this external metadata object was last modified.
updated_by	string	Username of user who last modified external metadata object.
url	string	URL associated with the external metadata object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, deployment_name		Gets the specified external metadata object in a metastore. The caller must be a metastore admin, the
list	select	deployment_name	page_size, page_token	Gets an array of external metadata objects in the metastore. If the caller is the metastore admin, all
create	insert	deployment_name, external_metadata		Creates a new external metadata object in the parent metastore if the caller is a metastore admin or
update	update	name, update_mask, deployment_name, external_metadata		Updates the external metadata object that matches the supplied name. The caller can only update either
delete	delete	name, deployment_name		Deletes the external metadata object that matches the supplied name. The caller must be a metastore

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)
name	string	str
update_mask	string
page_size	integer	Specifies the maximum number of external metadata objects to return in a single response. The value must be less than or equal to 1000.
page_token	string	Opaque pagination token to go to next page based on previous query.

SELECT examples

get

Gets the specified external metadata object in a metastore. The caller must be a metastore admin, the

SELECT
id,
name,
metastore_id,
columns,
create_time,
created_by,
description,
entity_type,
owner,
properties,
system_type,
update_time,
updated_by,
url
FROM databricks_workspace.catalog.external_metadata
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Gets an array of external metadata objects in the metastore. If the caller is the metastore admin, all

SELECT
id,
name,
metastore_id,
columns,
create_time,
created_by,
description,
entity_type,
owner,
properties,
system_type,
update_time,
updated_by,
url
FROM databricks_workspace.catalog.external_metadata
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a new external metadata object in the parent metastore if the caller is a metastore admin or

INSERT INTO databricks_workspace.catalog.external_metadata (
external_metadata,
deployment_name
)
SELECT 
'{{ external_metadata }}' /* required */,
'{{ deployment_name }}'
RETURNING
id,
name,
metastore_id,
columns,
create_time,
created_by,
description,
entity_type,
owner,
properties,
system_type,
update_time,
updated_by,
url
;

Manifest

# Description fields are for documentation purposes
- name: external_metadata
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the external_metadata resource.
  - name: external_metadata
    description: |
      :returns: :class:`ExternalMetadata`
    value:
      name: "{{ name }}"
      system_type: "{{ system_type }}"
      entity_type: "{{ entity_type }}"
      columns:
        - "{{ columns }}"
      create_time: "{{ create_time }}"
      created_by: "{{ created_by }}"
      description: "{{ description }}"
      id: "{{ id }}"
      metastore_id: "{{ metastore_id }}"
      owner: "{{ owner }}"
      properties: "{{ properties }}"
      update_time: "{{ update_time }}"
      updated_by: "{{ updated_by }}"
      url: "{{ url }}"

UPDATE examples

update

Updates the external metadata object that matches the supplied name. The caller can only update either

UPDATE databricks_workspace.catalog.external_metadata
SET 
external_metadata = '{{ external_metadata }}'
WHERE 
name = '{{ name }}' --required
AND update_mask = '{{ update_mask }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND external_metadata = '{{ external_metadata }}' --required
RETURNING
id,
name,
metastore_id,
columns,
create_time,
created_by,
description,
entity_type,
owner,
properties,
system_type,
update_time,
updated_by,
url;

DELETE examples

delete

Deletes the external metadata object that matches the supplied name. The caller must be a metastore

DELETE FROM databricks_workspace.catalog.external_metadata
WHERE name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;