Skip to content

ExternalMetadata

laktory.models.resources.databricks.ExternalMetadata ¤

Bases: ExternalMetadataBase

Databricks External Metadata

Object representing an asset of an external system (e.g. a Salesforce object upstream or a Power BI report downstream) used to extend Unity Catalog lineage beyond Databricks.

Set owner explicitly: when it is left empty, the Databricks provider (1.137.0) reports the owner assigned by Databricks as an inconsistent result and fails the apply.

Examples:

import io

from laktory import models

metadata_yaml = '''
name: stock_prices_report
system_type: POWER_BI
entity_type: Report
description: Daily stock prices report
url: https://app.powerbi.com/groups/finance/reports/stock-prices
owner: role-data-engineers
'''
metadata = models.resources.databricks.ExternalMetadata.model_validate_yaml(
    io.StringIO(metadata_yaml)
)
References
BASE DESCRIPTION
columns

List of columns associated with the external metadata object

TYPE: list[str] | None | VariableType DEFAULT: None

description

User-provided free-form text description

TYPE: str | None | VariableType DEFAULT: None

entity_type

Type of entity within the external system

TYPE: str | VariableType

name

Name of the external metadata object

TYPE: str | VariableType

owner

Owner of the external metadata object

TYPE: str | None | VariableType DEFAULT: None

properties

A map of key-value properties attached to the external metadata object

TYPE: dict[str, str] | None | VariableType DEFAULT: None

provider_config

Configure the provider for management through account provider

TYPE: ExternalMetadataProviderConfig | None | VariableType DEFAULT: None

system_type

Type of external system. Possible values are: 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

TYPE: str | VariableType

url

URL associated with the external metadata object

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externalmetadata.ExternalMetadataProviderConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
workspace_id

Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with

TYPE: str | None | VariableType DEFAULT: None