Source code for airflow.providers.microsoft.mssql.assets.mssql

# 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 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 mssql:// must contain a host")
    if uri.port is None:
        host = uri.netloc.rstrip(":")
        uri = uri._replace(netloc=f"{host}:1433")
    if len(uri.path.split("/")) not in {4, 5}:
        raise ValueError(
            "URI format mssql:// must contain database, schema, and table/view names with optional instance name"
        )
    return uri




[docs]
def create_asset(
    *, host: str, database: str, schema: str, table: str, port: int = 1433, extra: dict | None = None
) -> Asset:
    return Asset(uri=f"mssql://{host}:{port}/{database}/{schema}/{table}", extra=extra)




[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 = sanitize_uri(urlsplit(asset.uri))
    path_parts = parsed.path.split("/")
    if len(path_parts) == 4:
        _, database, schema, table = path_parts  # Leading slash, database, schema, and table names.
    else:
        _, _instance, database, schema, table = path_parts
    return OpenLineageDataset(namespace=f"mssql://{parsed.netloc}", name=f"{database}.{schema}.{table}")