Source code for airflow.providers.databricks.assets.databricks

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

from __future__ import annotations

from dataclasses import dataclass, fields
from typing import TYPE_CHECKING

from airflow.providers.common.compat.assets import Asset

if TYPE_CHECKING:
    from urllib.parse import SplitResult

    from airflow.providers.common.compat.openlineage.facet import Dataset as OpenLineageDataset



[docs]
def sanitize_uri(uri: SplitResult) -> SplitResult:
    if not uri.netloc:
        raise ValueError("URI format databricks:// must contain a host")
    if len(uri.path.split("/")) != 4:  # Leading slash, catalog, schema, and table names.
        raise ValueError("URI format databricks:// must contain catalog, schema, and table names")
    return uri




[docs]
def create_asset(
    *, host: str, catalog: str, schema: str, table: str, port: str | None = None, extra: dict | None = None
) -> Asset:
    port = f":{port}" if port else ""
    return Asset(uri=f"databricks://{host}{port}/{catalog}/{schema}/{table}", extra=extra)



@dataclass(frozen=True, slots=True)

[docs]
class UnityTableIdentity:
    """
    Static identity of a Unity Catalog table in one Databricks workspace.

    :param host: Workspace hostname. A URL such as ``https://xx.cloud.databricks.com`` is
        reduced to its hostname, as the Databricks connection does.
    :param catalog: Unity Catalog catalog name.
    :param schema: Schema name inside ``catalog``.
    :param table: Table name inside ``schema``.
    """


[docs]
    host: str


[docs]
    catalog: str


[docs]
    schema: str


[docs]
    table: str



[docs]
    def __post_init__(self) -> None:
        from airflow.providers.databricks.hooks.databricks_base import BaseDatabricksHook

        object.__setattr__(self, "host", BaseDatabricksHook._parse_host(self.host))
        for field in fields(self):
            value = getattr(self, field.name)
            if not value:
                raise ValueError(f"UnityTableIdentity.{field.name} must not be empty.")
            if "{{" in value or "{%" in value:
                raise ValueError(
                    f"UnityTableIdentity.{field.name} must be static, got Jinja {value!r}. "
                    "It is not a template field and is never rendered."
                )
            object.__setattr__(self, field.name, value.lower())



[docs]
    def to_asset(self) -> Asset:
        return create_asset(host=self.host, catalog=self.catalog, schema=self.schema, table=self.table)





[docs]
def convert_asset_to_openlineage(asset: Asset, lineage_context) -> OpenLineageDataset:
    """Translate Asset with valid AIP-60 uri to OpenLineage with assistance from the hook."""
    from urllib.parse import urlsplit

    from airflow.providers.common.compat.openlineage.facet import Dataset as OpenLineageDataset

    parsed = urlsplit(asset.uri)
    _, catalog, schema, table = parsed.path.split("/")
    return OpenLineageDataset(namespace=f"databricks://{parsed.netloc}", name=f"{catalog}.{schema}.{table}")