bigeye-cli 0.8.4__tar.gz → 0.8.5__tar.gz

{bigeye_cli-0.8.4 → bigeye_cli-0.8.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bigeye-cli
-Version: 0.8.4
+Version: 0.8.5
 Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
 Home-page: https://docs.bigeye.com/docs
 License: Proprietary
@@ -18,7 +18,7 @@ Requires-Dist: rich (>=14.1.0,<15.0.0)
 Description-Content-Type: text/markdown
 
 # **Bigeye CLI**
-Version: 0.8.4
+Version: 0.8.5
 ## Installation
 
 **Setting up your local/build environment**  
@@ -2046,6 +2046,7 @@ $ bigeye lineage export-end-to-end [OPTIONS]
 * `--direction [upstream|downstream|both]`: Direction to trace: upstream, downstream, or both.  [default: both]
 * `--granularity [schema|table|column]`: Hop level: schema, table, or column. Defaults to each root&#x27;s own level.
 * `--max-paths INTEGER`: Per-root cap on enumerated paths. Truncation is logged, never silent.  [default: 10000]
+* `--include-etl / --no-include-etl`: Include or exclude ETL operator nodes as hops. When excluded, paths are stitched across removed ETL nodes (A -&gt; ETL -&gt; C becomes A -&gt; C). Defaults to including them.  [default: include-etl]
 * `--depth INTEGER`: Per-window traversal depth. When set, each root&#x27;s graph is fetched in bounded depth-hop windows, re-rooting at the lineage frontier until the lineage is exhausted end-to-end. This escapes the backend&#x27;s per-request depth ceiling (lineage.max_depth) that truncates a single full fetch, and keeps each request small so very large graphs don&#x27;t fail. Omit to request the graph in one call (the previous behavior, capped at the backend depth limit).
 * `--concurrency INTEGER`: Max concurrent window requests when --depth is used. Lower it to reduce client memory and server load on wide graphs. Ignored without --depth.  [default: 8]
 * `-o, --output TEXT`: Output .csv path. Defaults to end_to_end_&lt;root&gt;.csv in the current directory.

{bigeye_cli-0.8.4 → bigeye_cli-0.8.5}/bigeye_cli/CLI_DOCS.md

@@ -1,5 +1,5 @@
 # **Bigeye CLI**
-Version: 0.8.4
+Version: 0.8.5
 ## Installation
 
 **Setting up your local/build environment**  
@@ -2027,6 +2027,7 @@ $ bigeye lineage export-end-to-end [OPTIONS]
 * `--direction [upstream|downstream|both]`: Direction to trace: upstream, downstream, or both.  [default: both]
 * `--granularity [schema|table|column]`: Hop level: schema, table, or column. Defaults to each root's own level.
 * `--max-paths INTEGER`: Per-root cap on enumerated paths. Truncation is logged, never silent.  [default: 10000]
+* `--include-etl / --no-include-etl`: Include or exclude ETL operator nodes as hops. When excluded, paths are stitched across removed ETL nodes (A -> ETL -> C becomes A -> C). Defaults to including them.  [default: include-etl]
 * `--depth INTEGER`: Per-window traversal depth. When set, each root's graph is fetched in bounded depth-hop windows, re-rooting at the lineage frontier until the lineage is exhausted end-to-end. This escapes the backend's per-request depth ceiling (lineage.max_depth) that truncates a single full fetch, and keeps each request small so very large graphs don't fail. Omit to request the graph in one call (the previous behavior, capped at the backend depth limit).
 * `--concurrency INTEGER`: Max concurrent window requests when --depth is used. Lower it to reduce client memory and server load on wide graphs. Ignored without --depth.  [default: 8]
 * `-o, --output TEXT`: Output .csv path. Defaults to end_to_end_<root>.csv in the current directory.

{bigeye_cli-0.8.4 → bigeye_cli-0.8.5}/bigeye_cli/bigconfig/bigconfig_commands.py

@@ -2,7 +2,7 @@ import os
 import warnings
 from datetime import datetime
 from pathlib import Path
-from typing import Optional, List
+from typing import Optional, List, Dict
 
 import typer
 
@@ -14,7 +14,9 @@ from bigeye_sdk.bigconfig_validation.big_config_reports import all_reports
 from bigeye_sdk.controller.metric_controller import MetricController, filter_metrics_by_namespace
 from bigeye_sdk.functions.file_functs import sanitize_filename
 from bigeye_sdk.controller.metric_suite_controller import MetricSuiteController
-from bigeye_sdk.generated.com.bigeye.models.generated import MetricInfoList, MetricInfo
+from bigeye_sdk.generated.com.bigeye.models.generated import (
+    MetricInfoList, MetricInfo
+)
 from bigeye_sdk.model.big_config import BigConfig
 from bigeye_sdk.model.protobuf_message_facade import SimpleCollection
 from bigeye_sdk.log import get_logger
@@ -192,6 +194,14 @@ def export(
             "collection id (-cid), table id (-tid), or list of metric ids (-mid). "
         )
 
+    # Collect the SQL (custom) rules in scope up front. A scope can contain only SQL
+    # rules and no metrics, so both the table guard below and the main "nothing to
+    # export" guard consult this to avoid bailing out before the rules are exported.
+    # `namespace` scopes the rules the same way it scopes metrics below.
+    sql_rule_deployments = mc.collect_sql_rule_deployments(
+        collection_id=collection_id, table_id=table_id, namespace=namespace
+    )
+
     # Add metric ids if passed
     if metric_ids:
         final_metric_ids.extend(metric_ids)
@@ -209,16 +219,22 @@ def export(
             table_ids=[table_id]
         ).metrics
         final_metric_ids.extend([m.metric_configuration.id for m in metrics_from_table])
-        if not metrics_from_table:
+        if not metrics_from_table and not sql_rule_deployments:
             raise typer.BadParameter(
-                f"No metrics found for given table id. Please check arguments and try again."
+                f"No metrics or SQL rules found for given table id. Please check arguments and try again."
             )
-        if not collection_id:
+        if metrics_from_table and not collection_id:
             collection.name = metrics_from_table[0].metric_metadata.dataset_name
 
-    # Pull raw metric info. Converting to protobuf objects complicates default and zero values unnecessarily
-    raw_metrics: List[dict] = client.get_metric_info_batch_post(metric_ids=final_metric_ids,
-                                                                    return_raw_response=True)
+    # Pull raw metric info. Converting to protobuf objects complicates default and zero values
+    # unnecessarily. NOTE: the API treats an empty metric_ids list as "no filter" and returns
+    # every metric in the workspace, so only fetch when at least one metric is in scope --
+    # otherwise a metrics-less scope (e.g. a collection of only SQL rules) would export everything.
+    raw_metrics: List[dict] = (
+        client.get_metric_info_batch_post(metric_ids=final_metric_ids, return_raw_response=True)
+        if final_metric_ids
+        else []
+    )
 
     # `namespace` is used ONLY to filter which metrics get exported. It is
     # intentionally NOT written into the generated bigconfig file (nor the shared
@@ -234,40 +250,47 @@ def export(
     if not output_path:
         output_path = client.config.bigconfig_output_path or Path.cwd()
 
-    if not raw_metrics:
+    if not raw_metrics and not sql_rule_deployments:
         raise typer.BadParameter(
-            "No metrics found for given arguments. Please check again."
+            "No metrics or SQL rules found for given arguments. Please check again."
         )
 
+    if raw_metrics:
+        if not use_v1:
+            mc.infos_to_convert = raw_metrics
+            template_smds = mc.collect_template_smds_from_inputs()
+            mc.write_or_update_smd_library(
+                template_smds_from_inputs=template_smds, auto_apply=auto_apply_on_indexing
+            )
+            typer.secho(
+                f"\nUpdated SMD library at: {mc.saved_metric_def_path}\n", fg="green", bold=True
+            )
 
-    if not use_v1:
-        mc.infos_to_convert = raw_metrics
-        template_smds = mc.collect_template_smds_from_inputs()
-        mc.write_or_update_smd_library(
-            template_smds_from_inputs=template_smds, auto_apply=auto_apply_on_indexing
-        )
-        typer.secho(
-            f"\nUpdated SMD library at: {mc.saved_metric_def_path}\n", fg="green", bold=True
-        )
-
-        if smd_only:
-            raise typer.Exit(0)
+            if smd_only:
+                raise typer.Exit(0)
 
-        bc = mc.to_bigconfig_yaml(collection=collection, auto_apply_on_indexing=auto_apply_on_indexing)
+            bc = mc.to_bigconfig_yaml(collection=collection, auto_apply_on_indexing=auto_apply_on_indexing)
 
-        # Dumping **kwargs messes up the formatting
-        bigconfig = BigConfig(type=bc["type"])
+            # Dumping **kwargs messes up the formatting
+            bigconfig = BigConfig(type=bc["type"])
 
-        if bc.get("auto_apply_on_indexing", None):
-            bigconfig.auto_apply_on_indexing = True
-        if bc.get("tag_definitions", None):
-            bigconfig.tag_definitions = bc.get("tag_definitions")
+            if bc.get("auto_apply_on_indexing", None):
+                bigconfig.auto_apply_on_indexing = True
+            if bc.get("tag_definitions", None):
+                bigconfig.tag_definitions = bc.get("tag_definitions")
 
-        bigconfig.tag_deployments = bc.get("tag_deployments")
+            bigconfig.tag_deployments = bc.get("tag_deployments")
+        else:
+            bigconfig = mc.metric_info_to_bigconfig(
+                metric_info=MetricInfoList(metrics=[MetricInfo().from_dict(m) for m in raw_metrics]), collection=collection
+            )
     else:
-        bigconfig = mc.metric_info_to_bigconfig(
-            metric_info=MetricInfoList(metrics=[MetricInfo().from_dict(m) for m in raw_metrics]), collection=collection
-        )
+        # Only SQL rules are in scope: emit a minimal bigconfig carrying just the rules.
+        bigconfig = BigConfig(type='BIGCONFIG_FILE')
+
+    # Export custom (SQL) rules in scope alongside the metrics, in the same format apply reads.
+    if sql_rule_deployments:
+        bigconfig.sql_rules = sql_rule_deployments
 
     file_name = sanitize_filename(collection.name)
     output = bigconfig.save(

{bigeye_cli-0.8.4 → bigeye_cli-0.8.5}/bigeye_cli/lineage/lineage_commands.py

@@ -366,6 +366,12 @@ def export_end_to_end(
             "--max-paths",
             help="Per-root cap on enumerated paths. Truncation is logged, never silent.",
         ),
+        include_etl: bool = typer.Option(
+            True,
+            "--include-etl/--no-include-etl",
+            help="Include or exclude ETL operator nodes as hops. When excluded, paths are stitched "
+                 "across removed ETL nodes (A -> ETL -> C becomes A -> C). Defaults to including them.",
+        ),
         depth: Optional[int] = typer.Option(
             None,
             "--depth",
@@ -411,6 +417,7 @@ def export_end_to_end(
         max_paths=max_paths,
         depth=depth,
         concurrency=concurrency,
+        include_etl=include_etl,
     )
 
     log.info(

{bigeye_cli-0.8.4 → bigeye_cli-0.8.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bigeye-cli"
-version = "0.8.4"
+version = "0.8.5"
 description = "Bigeye CLI offers developer tools for maintaining your developer workspace."
 license = "Proprietary"
 authors = ["Bigeye <support@bigeye.com>"]