acryl-datahub 1.0.0rc18__py3-none-any.whl → 1.3.0.1rc9__py3-none-any.whl

datahub/cli/specific/datacontract_cli.py

@@ -1,4 +1,5 @@
 import logging
+import warnings
 from typing import Optional
 
 import click
@@ -6,7 +7,7 @@ from click_default_group import DefaultGroup
 
 from datahub.api.entities.datacontract.datacontract import DataContract
 from datahub.ingestion.graph.client import get_default_graph
-from datahub.telemetry import telemetry
+from datahub.ingestion.graph.config import ClientMode
 from datahub.upgrade import upgrade
 
 logger = logging.getLogger(__name__)
@@ -14,21 +15,57 @@ logger = logging.getLogger(__name__)
 
 @click.group(cls=DefaultGroup, default="upsert")
 def datacontract() -> None:
-    """A group of commands to interact with the DataContract entity in DataHub."""
-    pass
+    """
+    A group of commands to interact with the DataContract entity in DataHub.
+
+    WARNING: This CLI is DEPRECATED and no longer supported.
+    Please migrate to alternative data contract solutions.
+    """
+    # Issue deprecation warning
+    warnings.warn(
+        "The datacontract CLI is deprecated and no longer supported. "
+        "Please migrate to alternative data contract solutions.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
+    # Log deprecation message for runtime visibility
+    logger.warning(
+        "DEPRECATED: The datacontract CLI is no longer supported and will be removed in a future version. "
+        "Please migrate to alternative data contract solutions."
+    )
+
+    # Display deprecation message to user
+    click.secho(
+        "⚠️  WARNING: This datacontract CLI is DEPRECATED and no longer supported.",
+        fg="yellow",
+        bold=True,
+    )
+    click.secho("Please migrate to alternative data contract solutions.", fg="yellow")
 
 
 @datacontract.command()
 @click.option("-f", "--file", required=True, type=click.Path(exists=True))
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def upsert(file: str) -> None:
-    """Upsert (create or update) a Data Contract in DataHub."""
+    """
+    Upsert (create or update) a Data Contract in DataHub.
+
+    WARNING: This command is DEPRECATED and no longer supported.
+    """
+
+    click.secho(
+        "⚠️  WARNING: The 'upsert' command is deprecated and no longer supported.",
+        fg="yellow",
+        bold=True,
+    )
+
+    logger.warning("DEPRECATED: datacontract upsert command is no longer supported")
 
     data_contract: DataContract = DataContract.from_yaml(file)
     urn = data_contract.urn
 
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         if not graph.exists(data_contract.entity):
             raise ValueError(
                 f"Cannot define a data contract for non-existent entity {data_contract.entity}"
@@ -59,9 +96,20 @@ def upsert(file: str) -> None:
 )
 @click.option("--hard/--soft", required=False, is_flag=True, default=False)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def delete(urn: Optional[str], file: Optional[str], hard: bool) -> None:
-    """Delete a Data Contract in DataHub. Defaults to a soft-delete. Use --hard to completely erase metadata."""
+    """
+    Delete a Data Contract in DataHub. Defaults to a soft-delete. Use --hard to completely erase metadata.
+
+    WARNING: This command is DEPRECATED and no longer supported.
+    """
+
+    click.secho(
+        "⚠️  WARNING: The 'delete' command is deprecated and no longer supported.",
+        fg="yellow",
+        bold=True,
+    )
+
+    logger.warning("DEPRECATED: datacontract delete command is no longer supported")
 
     if not urn:
         if not file:
@@ -72,7 +120,7 @@ def delete(urn: Optional[str], file: Optional[str], hard: bool) -> None:
         data_contract = DataContract.from_yaml(file)
         urn = data_contract.urn
 
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         if not graph.exists(urn):
             raise ValueError(f"Data Contract {urn} does not exist")
 

datahub/cli/specific/dataproduct_cli.py

@@ -1,7 +1,6 @@
 import difflib
 import json
 import logging
-import os
 import pathlib
 import sys
 from pathlib import Path
@@ -14,15 +13,16 @@ from click_default_group import DefaultGroup
 
 from datahub.api.entities.dataproduct.dataproduct import DataProduct
 from datahub.cli.specific.file_loader import load_file
+from datahub.configuration.env_vars import get_dataproduct_external_url
 from datahub.emitter.mce_builder import (
     make_group_urn,
     make_user_urn,
     validate_ownership_type,
 )
 from datahub.ingestion.graph.client import DataHubGraph, get_default_graph
+from datahub.ingestion.graph.config import ClientMode
 from datahub.metadata.schema_classes import OwnerClass, OwnershipTypeClass
 from datahub.specific.dataproduct import DataProductPatchBuilder
-from datahub.telemetry import telemetry
 from datahub.upgrade import upgrade
 from datahub.utilities.urns.urn import Urn
 
@@ -81,12 +81,10 @@ def mutate(file: Path, validate_assets: bool, external_url: str, upsert: bool) -
 
     config_dict = load_file(pathlib.Path(file))
     id = config_dict.get("id") if isinstance(config_dict, dict) else None
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         data_product: DataProduct = DataProduct.from_yaml(file, graph)
         external_url_override = (
-            external_url
-            or os.getenv("DATAHUB_DATAPRODUCT_EXTERNAL_URL")
-            or data_product.external_url
+            external_url or get_dataproduct_external_url() or data_product.external_url
         )
         data_product.external_url = external_url_override
         if upsert and not graph.exists(data_product.urn):
@@ -129,7 +127,6 @@ def mutate(file: Path, validate_assets: bool, external_url: str, upsert: bool) -
 )
 @click.option("--external-url", required=False, type=str)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def update(file: Path, validate_assets: bool, external_url: str) -> None:
     """Create or Update a Data Product in DataHub. Use upsert if you want to apply partial updates."""
 
@@ -145,7 +142,6 @@ def update(file: Path, validate_assets: bool, external_url: str) -> None:
 )
 @click.option("--external-url", required=False, type=str)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def upsert(file: Path, validate_assets: bool, external_url: str) -> None:
     """Upsert attributes to a Data Product in DataHub."""
 
@@ -158,11 +154,10 @@ def upsert(file: Path, validate_assets: bool, external_url: str) -> None:
 @click.option("-f", "--file", required=True, type=click.Path(exists=True))
 @click.option("--update", required=False, is_flag=True, default=False)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def diff(file: Path, update: bool) -> None:
     """Diff a Data Product file with its twin in DataHub"""
 
-    with get_default_graph() as emitter:
+    with get_default_graph(ClientMode.CLI) as emitter:
         id: Optional[str] = None
         try:
             data_product_local: DataProduct = DataProduct.from_yaml(file, emitter)
@@ -205,7 +200,6 @@ def diff(file: Path, update: bool) -> None:
 )
 @click.option("--hard/--soft", required=False, is_flag=True, default=False)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def delete(urn: str, file: Path, hard: bool) -> None:
     """Delete a Data Product in DataHub. Defaults to a soft-delete. Use --hard to completely erase metadata."""
 
@@ -216,7 +210,7 @@ def delete(urn: str, file: Path, hard: bool) -> None:
         raise click.Abort()
 
     graph: DataHubGraph
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         data_product_urn = (
             urn if urn.startswith("urn:li:dataProduct") else f"urn:li:dataProduct:{urn}"
         )
@@ -241,14 +235,13 @@ def delete(urn: str, file: Path, hard: bool) -> None:
 @click.option("--urn", required=True, type=str)
 @click.option("--to-file", required=False, type=str)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def get(urn: str, to_file: str) -> None:
     """Get a Data Product from DataHub"""
 
     if not urn.startswith("urn:li:dataProduct:"):
         urn = f"urn:li:dataProduct:{urn}"
 
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         if graph.exists(urn):
             dataproduct: DataProduct = DataProduct.from_datahub(graph=graph, id=urn)
             click.secho(
@@ -278,7 +271,6 @@ def get(urn: str, to_file: str) -> None:
     help="A markdown file that contains documentation for this data product",
 )
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def set_description(urn: str, description: str, md_file: Path) -> None:
     """Set description for a Data Product in DataHub"""
 
@@ -306,7 +298,7 @@ def set_description(urn: str, description: str, md_file: Path) -> None:
 
     dataproduct_patcher: DataProductPatchBuilder = DataProduct.get_patch_builder(urn)
     dataproduct_patcher.set_description(description)
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         _abort_if_non_existent_urn(graph, urn, "set description")
         for mcp in dataproduct_patcher.build():
             graph.emit(mcp)
@@ -329,7 +321,6 @@ def set_description(urn: str, description: str, md_file: Path) -> None:
     default=OwnershipTypeClass.TECHNICAL_OWNER,
 )
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def add_owner(urn: str, owner: str, owner_type: str) -> None:
     """Add owner for a Data Product in DataHub"""
 
@@ -342,7 +333,7 @@ def add_owner(urn: str, owner: str, owner_type: str) -> None:
             owner=_get_owner_urn(owner), type=owner_type, typeUrn=owner_type_urn
         )
     )
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         _abort_if_non_existent_urn(graph, urn, "add owners")
         for mcp in dataproduct_patcher.build():
             graph.emit(mcp)
@@ -352,7 +343,6 @@ def add_owner(urn: str, owner: str, owner_type: str) -> None:
 @click.option("--urn", required=True, type=str)
 @click.argument("owner_urn", required=True, type=str)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def remove_owner(urn: str, owner_urn: str) -> None:
     """Remove owner for a Data Product in DataHub"""
 
@@ -360,7 +350,7 @@ def remove_owner(urn: str, owner_urn: str) -> None:
         urn = f"urn:li:dataProduct:{urn}"
     dataproduct_patcher: DataProductPatchBuilder = DataProduct.get_patch_builder(urn)
     dataproduct_patcher.remove_owner(owner=_get_owner_urn(owner_urn))
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         _abort_if_non_existent_urn(graph, urn, "remove owners")
         for mcp in dataproduct_patcher.build():
             click.echo(json.dumps(mcp.to_obj()))
@@ -374,7 +364,6 @@ def remove_owner(urn: str, owner_urn: str) -> None:
     "--validate-assets/--no-validate-assets", required=False, is_flag=True, default=True
 )
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def add_asset(urn: str, asset: str, validate_assets: bool) -> None:
     """Add asset for a Data Product in DataHub"""
 
@@ -382,7 +371,7 @@ def add_asset(urn: str, asset: str, validate_assets: bool) -> None:
         urn = f"urn:li:dataProduct:{urn}"
     dataproduct_patcher: DataProductPatchBuilder = DataProduct.get_patch_builder(urn)
     dataproduct_patcher.add_asset(asset)
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         _abort_if_non_existent_urn(graph, urn, "add assets")
         if validate_assets:
             _abort_if_non_existent_urn(
@@ -401,7 +390,6 @@ def add_asset(urn: str, asset: str, validate_assets: bool) -> None:
     "--validate-assets/--no-validate-assets", required=False, is_flag=True, default=True
 )
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def remove_asset(urn: str, asset: str, validate_assets: bool) -> None:
     """Remove asset for a Data Product in DataHub"""
 
@@ -409,7 +397,7 @@ def remove_asset(urn: str, asset: str, validate_assets: bool) -> None:
         urn = f"urn:li:dataProduct:{urn}"
     dataproduct_patcher: DataProductPatchBuilder = DataProduct.get_patch_builder(urn)
     dataproduct_patcher.remove_asset(asset)
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         _abort_if_non_existent_urn(graph, urn, "remove assets")
         if validate_assets:
             _abort_if_non_existent_urn(

datahub/cli/specific/dataset_cli.py

@@ -12,8 +12,8 @@ from click_default_group import DefaultGroup
 from datahub.api.entities.dataset.dataset import Dataset, DatasetRetrievalConfig
 from datahub.emitter.mcp import MetadataChangeProposalWrapper
 from datahub.ingestion.graph.client import DataHubGraph, get_default_graph
+from datahub.ingestion.graph.config import ClientMode
 from datahub.metadata.com.linkedin.pegasus2avro.common import Siblings
-from datahub.telemetry import telemetry
 from datahub.upgrade import upgrade
 
 logger = logging.getLogger(__name__)
@@ -29,13 +29,14 @@ def dataset() -> None:
     name="upsert",
 )
 @click.option("-f", "--file", required=True, type=click.Path(exists=True))
-@upgrade.check_upgrade
-@telemetry.with_telemetry()
-def upsert(file: Path) -> None:
+@click.option(
+    "-n", "--dry-run", type=bool, is_flag=True, default=False, help="Perform a dry run"
+)
+def upsert(file: Path, dry_run: bool) -> None:
     """Upsert attributes to a Dataset in DataHub."""
     # Call the sync command with to_datahub=True to perform the upsert operation
     ctx = click.get_current_context()
-    ctx.invoke(sync, file=str(file), to_datahub=True)
+    ctx.invoke(sync, file=str(file), dry_run=dry_run, to_datahub=True)
 
 
 @dataset.command(
@@ -44,14 +45,13 @@ def upsert(file: Path) -> None:
 @click.option("--urn", required=True, type=str)
 @click.option("--to-file", required=False, type=str)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def get(urn: str, to_file: str) -> None:
     """Get a Dataset from DataHub"""
 
     if not urn.startswith("urn:li:dataset:"):
         urn = f"urn:li:dataset:{urn}"
 
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         if graph.exists(urn):
             dataset: Dataset = Dataset.from_datahub(graph=graph, urn=urn)
             click.secho(
@@ -73,13 +73,13 @@ def get(urn: str, to_file: str) -> None:
     help="URN of secondary sibling(s)",
     multiple=True,
 )
-@telemetry.with_telemetry()
+@upgrade.check_upgrade
 def add_sibling(urn: str, sibling_urns: Tuple[str]) -> None:
     all_urns = set()
     all_urns.add(urn)
     for sibling_urn in sibling_urns:
         all_urns.add(sibling_urn)
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         for _urn in all_urns:
             _emit_sibling(graph, urn, _urn, all_urns)
 
@@ -113,8 +113,6 @@ def _get_existing_siblings(graph: DataHubGraph, urn: str) -> Set[str]:
 @click.option("--lintCheck", required=False, is_flag=True)
 @click.option("--lintFix", required=False, is_flag=True)
 @click.argument("file", type=click.Path(exists=True))
-@upgrade.check_upgrade
-@telemetry.with_telemetry()
 def file(lintcheck: bool, lintfix: bool, file: str) -> None:
     """Operate on a Dataset file"""
 
@@ -167,13 +165,17 @@ def file(lintcheck: bool, lintfix: bool, file: str) -> None:
 )
 @click.option("-f", "--file", required=True, type=click.Path(exists=True))
 @click.option("--to-datahub/--from-datahub", required=True, is_flag=True)
+@click.option(
+    "-n", "--dry-run", type=bool, is_flag=True, default=False, help="Perform a dry run"
+)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
-def sync(file: str, to_datahub: bool) -> None:
+def sync(file: str, to_datahub: bool, dry_run: bool) -> None:
     """Sync a Dataset file to/from DataHub"""
 
+    dry_run_prefix = "[dry-run]: " if dry_run else ""  # prefix to use in messages
+
     failures: List[str] = []
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         datasets = Dataset.from_yaml(file)
         for dataset in datasets:
             assert (
@@ -189,7 +191,7 @@ def sync(file: str, to_datahub: bool) -> None:
                     click.secho(
                         "\n\t- ".join(
                             [
-                                f"Skipping Dataset {dataset.urn} due to missing entity references: "
+                                f"{dry_run_prefix}Skipping Dataset {dataset.urn} due to missing entity references: "
                             ]
                             + missing_entity_references
                         ),
@@ -199,13 +201,18 @@ def sync(file: str, to_datahub: bool) -> None:
                     continue
                 try:
                     for mcp in dataset.generate_mcp():
-                        graph.emit(mcp)
-                    click.secho(f"Update succeeded for urn {dataset.urn}.", fg="green")
+                        if not dry_run:
+                            graph.emit(mcp)
+                    click.secho(
+                        f"{dry_run_prefix}Update succeeded for urn {dataset.urn}.",
+                        fg="green",
+                    )
                 except Exception as e:
                     click.secho(
-                        f"Update failed for id {id}. due to {e}",
+                        f"{dry_run_prefix}Update failed for id {id}. due to {e}",
                         fg="red",
                     )
+                    failures.append(dataset.urn)
             else:
                 # Sync from DataHub
                 if graph.exists(dataset.urn):
@@ -215,13 +222,16 @@ def sync(file: str, to_datahub: bool) -> None:
                     existing_dataset: Dataset = Dataset.from_datahub(
                         graph=graph, urn=dataset.urn, config=dataset_get_config
                     )
-                    existing_dataset.to_yaml(Path(file))
+                    if not dry_run:
+                        existing_dataset.to_yaml(Path(file))
+                    else:
+                        click.secho(f"{dry_run_prefix}Will update file {file}")
                 else:
-                    click.secho(f"Dataset {dataset.urn} does not exist")
+                    click.secho(f"{dry_run_prefix}Dataset {dataset.urn} does not exist")
                     failures.append(dataset.urn)
     if failures:
         click.secho(
-            f"\nFailed to sync the following Datasets: {', '.join(failures)}",
+            f"\n{dry_run_prefix}Failed to sync the following Datasets: {', '.join(failures)}",
             fg="red",
         )
         raise click.Abort()

datahub/cli/specific/forms_cli.py

@@ -7,7 +7,7 @@ from click_default_group import DefaultGroup
 
 from datahub.api.entities.forms.forms import Forms
 from datahub.ingestion.graph.client import get_default_graph
-from datahub.telemetry import telemetry
+from datahub.ingestion.graph.config import ClientMode
 from datahub.upgrade import upgrade
 
 logger = logging.getLogger(__name__)
@@ -23,8 +23,6 @@ def forms() -> None:
     name="upsert",
 )
 @click.option("-f", "--file", required=True, type=click.Path(exists=True))
-@upgrade.check_upgrade
-@telemetry.with_telemetry()
 def upsert(file: Path) -> None:
     """Upsert forms in DataHub."""
 
@@ -37,10 +35,9 @@ def upsert(file: Path) -> None:
 @click.option("--urn", required=True, type=str)
 @click.option("--to-file", required=False, type=str)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def get(urn: str, to_file: str) -> None:
     """Get form from DataHub"""
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         if graph.exists(urn):
             form: Forms = Forms.from_datahub(graph=graph, urn=urn)
             click.secho(

datahub/cli/specific/group_cli.py

@@ -10,7 +10,7 @@ from datahub.api.entities.corpgroup.corpgroup import (
 )
 from datahub.cli.specific.file_loader import load_file
 from datahub.ingestion.graph.client import get_default_graph
-from datahub.telemetry import telemetry
+from datahub.ingestion.graph.config import ClientMode
 from datahub.upgrade import upgrade
 
 logger = logging.getLogger(__name__)
@@ -34,13 +34,12 @@ def group() -> None:
     help="When set, writes to the editable section of the metadata graph, overwriting writes from the UI",
 )
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def upsert(file: Path, override_editable: bool) -> None:
     """Create or Update a Group with embedded Users"""
 
     config_dict = load_file(file)
     group_configs = config_dict if isinstance(config_dict, list) else [config_dict]
-    with get_default_graph() as emitter:
+    with get_default_graph(ClientMode.CLI) as emitter:
         for group_config in group_configs:
             try:
                 datahub_group = CorpGroup.parse_obj(group_config)

datahub/cli/specific/structuredproperties_cli.py

@@ -11,7 +11,7 @@ from datahub.api.entities.structuredproperties.structuredproperties import (
     StructuredProperties,
 )
 from datahub.ingestion.graph.client import get_default_graph
-from datahub.telemetry import telemetry
+from datahub.ingestion.graph.config import ClientMode
 from datahub.upgrade import upgrade
 from datahub.utilities.urns.urn import Urn
 
@@ -29,11 +29,10 @@ def properties() -> None:
 )
 @click.option("-f", "--file", required=True, type=click.Path(exists=True))
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def upsert(file: Path) -> None:
     """Upsert structured properties in DataHub."""
 
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         StructuredProperties.create(str(file), graph)
 
 
@@ -43,12 +42,11 @@ def upsert(file: Path) -> None:
 @click.option("--urn", required=True, type=str)
 @click.option("--to-file", required=False, type=str)
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def get(urn: str, to_file: str) -> None:
     """Get structured properties from DataHub"""
     urn = Urn.make_structured_property_urn(urn)
 
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         if graph.exists(urn):
             structuredproperties: StructuredProperties = (
                 StructuredProperties.from_datahub(graph=graph, urn=urn)
@@ -70,7 +68,7 @@ def get(urn: str, to_file: str) -> None:
 )
 @click.option("--details/--no-details", is_flag=True, default=True)
 @click.option("--to-file", required=False, type=str)
-@telemetry.with_telemetry()
+@upgrade.check_upgrade
 def list(details: bool, to_file: str) -> None:
     """List structured properties in DataHub"""
 
@@ -117,7 +115,7 @@ def list(details: bool, to_file: str) -> None:
         with open(file, "w") as fp:
             yaml.dump(serialized_objects, fp)
 
-    with get_default_graph() as graph:
+    with get_default_graph(ClientMode.CLI) as graph:
         if details:
             logger.info(
                 "Listing structured properties with details. Use --no-details for urns only"