bigeye-cli 0.8.7__tar.gz → 0.9.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- bigeye_cli-0.8.7/bigeye_cli/CLI_DOCS.md → bigeye_cli-0.9.2/PKG-INFO +96 -47
- bigeye_cli-0.8.7/PKG-INFO → bigeye_cli-0.9.2/bigeye_cli/CLI_DOCS.md +76 -67
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/catalog/catalog_commands.py +0 -82
- bigeye_cli-0.9.2/bigeye_cli/catalog/custom_repo_commands.py +342 -0
- bigeye_cli-0.9.2/bigeye_cli/catalog/custom_repo_options.py +35 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/functions.py +100 -1
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/lineage/lineage_commands.py +34 -3
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/pyproject.toml +2 -2
- bigeye_cli-0.8.7/bigeye_cli/catalog/custom_repo_commands.py +0 -275
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/LICENSE +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/__main__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/__version__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/bigconfig/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/bigconfig/bigconfig_commands.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/bigconfig/bigconfig_options.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/catalog/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/collections/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/collections/collection_commands.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/configure/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/configure/configure_commands.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/deltas/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/deltas/deltas_commands.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/enums.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/exceptions/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/exceptions/exceptions.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/global_options.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/issues/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/issues/issue_commands.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/lineage/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/metric/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/metric/metric_commands.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/model/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/model/cicd_conf.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/model/github_report.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/model/vendor_report.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/workspace/__init__.py +0 -0
- {bigeye_cli-0.8.7 → bigeye_cli-0.9.2}/bigeye_cli/workspace/workspace_commands.py +0 -0
|
@@ -1,5 +1,24 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: bigeye-cli
|
|
3
|
+
Version: 0.9.2
|
|
4
|
+
Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
|
|
5
|
+
Home-page: https://docs.bigeye.com/docs
|
|
6
|
+
License: Proprietary
|
|
7
|
+
Author: Bigeye
|
|
8
|
+
Author-email: support@bigeye.com
|
|
9
|
+
Requires-Python: >=3.11.0,<4.0.0
|
|
10
|
+
Classifier: License :: Other/Proprietary License
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
14
|
+
Requires-Dist: PyGithub (>=1.59.1,<2.0.0)
|
|
15
|
+
Requires-Dist: bigeye-sdk (>=0.11.17,<0.12.0)
|
|
16
|
+
Requires-Dist: click (>=8.1.8,<9.0.0)
|
|
17
|
+
Requires-Dist: rich (>=14.1.0,<15.0.0)
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
|
|
1
20
|
# **Bigeye CLI**
|
|
2
|
-
Version: 0.
|
|
21
|
+
Version: 0.9.2
|
|
3
22
|
## Installation
|
|
4
23
|
|
|
5
24
|
**Setting up your local/build environment**
|
|
@@ -690,7 +709,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
690
709
|
|
|
691
710
|
**Commands**:
|
|
692
711
|
|
|
693
|
-
* `regen-autometrics`: Regenerates Autometrics by warehouse id OR... (DEPRECATED)
|
|
694
712
|
* `delete-metrics`: Delete metrics in a warehouse id, by...
|
|
695
713
|
* `rebuild`: Rebuilds/Reprofiles a source by warehouse...
|
|
696
714
|
* `get-table-info`: Outputs table info to a file for an entire...
|
|
@@ -698,7 +716,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
698
716
|
* `run-metrics`: Runs metrics by warehouse id, schema...
|
|
699
717
|
* `add-source`: Adds a source to specified Bigeye workspace.
|
|
700
718
|
* `delete-source`: Delete a source from specified Bigeye...
|
|
701
|
-
* `backfill-autothresholds`: Backfills autothresholds by warehouse id,...
|
|
702
719
|
* `backfill-metrics`: Backfills metrics by warehouse id, schema...
|
|
703
720
|
* `schedule-all-metrics`: Updates schedule for all metrics in a...
|
|
704
721
|
* `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
|
|
@@ -718,26 +735,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
718
735
|
* `sync-custom-repository`: Sync a custom repository from a YAML file.
|
|
719
736
|
* `custom-repo`: Import and export custom repositories as...
|
|
720
737
|
|
|
721
|
-
## `bigeye catalog regen-autometrics`
|
|
722
|
-
|
|
723
|
-
Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids.
|
|
724
|
-
|
|
725
|
-
**Usage**:
|
|
726
|
-
|
|
727
|
-
```console
|
|
728
|
-
$ bigeye catalog regen-autometrics [OPTIONS]
|
|
729
|
-
```
|
|
730
|
-
|
|
731
|
-
**Options**:
|
|
732
|
-
|
|
733
|
-
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
734
|
-
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
735
|
-
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
736
|
-
* `-wid, --warehouse_id INTEGER`: Warehouse ID. If none will look for Table IDs. If value then will pull all table ids for warehouse
|
|
737
|
-
* `-sn, --schema_name TEXT`: List of Schema Names E.g. -sn schema_1 -sn schema_2. Do not include warehouse name -- GREENE_HOMES_DEMO_STANDARD.CONFORMED is fully qualified and CONFORMED is the schema name.
|
|
738
|
-
* `-tid, --table_id INTEGER`: List of Table IDs. E.g. -tid 123 -tid 124
|
|
739
|
-
* `--help`: Show this message and exit.
|
|
740
|
-
|
|
741
738
|
## `bigeye catalog delete-metrics`
|
|
742
739
|
|
|
743
740
|
Delete metrics in a warehouse id, by schema names, or by table_ids. Also, can filter by multipe
|
|
@@ -884,26 +881,6 @@ $ bigeye catalog delete-source [OPTIONS]
|
|
|
884
881
|
* `-wid, --warehouse_id INTEGER`: The ID of the warehouse to delete.
|
|
885
882
|
* `--help`: Show this message and exit.
|
|
886
883
|
|
|
887
|
-
## `bigeye catalog backfill-autothresholds`
|
|
888
|
-
|
|
889
|
-
Backfills autothresholds by warehouse id, schema names, and/or table ids.
|
|
890
|
-
|
|
891
|
-
**Usage**:
|
|
892
|
-
|
|
893
|
-
```console
|
|
894
|
-
$ bigeye catalog backfill-autothresholds [OPTIONS]
|
|
895
|
-
```
|
|
896
|
-
|
|
897
|
-
**Options**:
|
|
898
|
-
|
|
899
|
-
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
900
|
-
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
901
|
-
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
902
|
-
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
903
|
-
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
904
|
-
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
905
|
-
* `--help`: Show this message and exit.
|
|
906
|
-
|
|
907
884
|
## `bigeye catalog backfill-metrics`
|
|
908
885
|
|
|
909
886
|
Backfills metrics by warehouse id, schema names, and/or table ids.
|
|
@@ -1289,6 +1266,9 @@ $ bigeye catalog custom-repo [OPTIONS] COMMAND [ARGS]...
|
|
|
1289
1266
|
* `import`: Import a custom repository from an Excel...
|
|
1290
1267
|
* `export`: Export a custom repository to an Excel...
|
|
1291
1268
|
* `delete`: Entirely delete a custom repository,...
|
|
1269
|
+
* `contents`: List the Bigeye assets (schemas, tables,...
|
|
1270
|
+
* `add-contents`: Add existing Bigeye assets to a custom...
|
|
1271
|
+
* `remove-contents`: Remove assets from a custom node (e.g.
|
|
1292
1272
|
|
|
1293
1273
|
### `bigeye catalog custom-repo init`
|
|
1294
1274
|
|
|
@@ -1309,7 +1289,8 @@ $ bigeye catalog custom-repo init [OPTIONS]
|
|
|
1309
1289
|
|
|
1310
1290
|
### `bigeye catalog custom-repo import`
|
|
1311
1291
|
|
|
1312
|
-
Import a custom repository from an Excel workbook
|
|
1292
|
+
Import a custom repository from an Excel workbook, and/or add or update
|
|
1293
|
+
attributes on nodes already in Bigeye (by node id, catalog path, or FQN).
|
|
1313
1294
|
|
|
1314
1295
|
**Usage**:
|
|
1315
1296
|
|
|
@@ -1324,8 +1305,8 @@ $ bigeye catalog custom-repo import [OPTIONS]
|
|
|
1324
1305
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1325
1306
|
* `-f, --file TEXT`: Path to the custom repository .xlsx workbook. [required]
|
|
1326
1307
|
* `--cleanup-stale`: Delete nodes/edges present in Bigeye but missing from the sheet. Off by default.
|
|
1327
|
-
* `--skip-unresolved-edges / --no-skip-unresolved-edges`: Import the rest instead of aborting when some edge endpoints don't resolve to a Bigeye node (default: on). Skipped
|
|
1328
|
-
* `--unresolved-log TEXT`: Path for the unresolved-
|
|
1308
|
+
* `--skip-unresolved-edges / --no-skip-unresolved-edges`: Import the rest instead of aborting when some edge endpoints or attribute IDs don't resolve to a Bigeye node (default: on). Skipped references are written to the unresolved log. Pass --no-skip-unresolved-edges to abort on any unresolved reference. [default: skip-unresolved-edges]
|
|
1309
|
+
* `--unresolved-log TEXT`: Path for the unresolved-references log. Defaults to custom_repo_unresolved.log in the current working directory. [default: custom_repo_unresolved.log]
|
|
1329
1310
|
* `--help`: Show this message and exit.
|
|
1330
1311
|
|
|
1331
1312
|
### `bigeye catalog custom-repo export`
|
|
@@ -1367,6 +1348,72 @@ $ bigeye catalog custom-repo delete [OPTIONS]
|
|
|
1367
1348
|
* `-y, --yes`: Skip the confirmation prompt.
|
|
1368
1349
|
* `--help`: Show this message and exit.
|
|
1369
1350
|
|
|
1351
|
+
### `bigeye catalog custom-repo contents`
|
|
1352
|
+
|
|
1353
|
+
List the Bigeye assets (schemas, tables, files, ...) a custom node contains, such as the
|
|
1354
|
+
assets assigned to a CI code. Children in the repository's own hierarchy are not listed.
|
|
1355
|
+
|
|
1356
|
+
**Usage**:
|
|
1357
|
+
|
|
1358
|
+
```console
|
|
1359
|
+
$ bigeye catalog custom-repo contents [OPTIONS]
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
**Options**:
|
|
1363
|
+
|
|
1364
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1365
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1366
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1367
|
+
* `--repo-name TEXT`: Display name of the custom repository. [required]
|
|
1368
|
+
* `--node TEXT`: The repository node to work on (e.g. a CI code): its ID from the workbook's Nodes sheet, or its display name if that is unique. [required]
|
|
1369
|
+
* `--help`: Show this message and exit.
|
|
1370
|
+
|
|
1371
|
+
### `bigeye catalog custom-repo add-contents`
|
|
1372
|
+
|
|
1373
|
+
Add existing Bigeye assets to a custom node (e.g. assign schemas or files to a CI code) by
|
|
1374
|
+
creating a containment edge to each. Assets keep their catalog location and lineage.
|
|
1375
|
+
|
|
1376
|
+
**Usage**:
|
|
1377
|
+
|
|
1378
|
+
```console
|
|
1379
|
+
$ bigeye catalog custom-repo add-contents [OPTIONS]
|
|
1380
|
+
```
|
|
1381
|
+
|
|
1382
|
+
**Options**:
|
|
1383
|
+
|
|
1384
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1385
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1386
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1387
|
+
* `--repo-name TEXT`: Display name of the custom repository. [required]
|
|
1388
|
+
* `--node TEXT`: The repository node to work on (e.g. a CI code): its ID from the workbook's Nodes sheet, or its display name if that is unique. [required]
|
|
1389
|
+
* `-a, --asset TEXT`: An asset to add or remove: a warehouse FQN (source.schema[.table[.column]]), a catalog path (dotted, or ' / '-separated as the catalog shows it), or id:<lineage node id>. Repeatable.
|
|
1390
|
+
* `--assets-file TEXT`: CSV or Excel file with one asset per row in the first column. A first row is skipped as a header only if it is one of (in any case): asset, assets, catalog path, exclude, exclude asset, exclude assets, excluded asset, excluded assets, fqn, fqns, node, node id, path. Any other first row is read as an asset.
|
|
1391
|
+
* `--dry-run`: Show what would change without writing.
|
|
1392
|
+
* `--help`: Show this message and exit.
|
|
1393
|
+
|
|
1394
|
+
### `bigeye catalog custom-repo remove-contents`
|
|
1395
|
+
|
|
1396
|
+
Remove assets from a custom node (e.g. unassign them from a CI code). Deletes only the
|
|
1397
|
+
containment edge between the node and each asset; the asset and its lineage are untouched.
|
|
1398
|
+
|
|
1399
|
+
**Usage**:
|
|
1400
|
+
|
|
1401
|
+
```console
|
|
1402
|
+
$ bigeye catalog custom-repo remove-contents [OPTIONS]
|
|
1403
|
+
```
|
|
1404
|
+
|
|
1405
|
+
**Options**:
|
|
1406
|
+
|
|
1407
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1408
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1409
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1410
|
+
* `--repo-name TEXT`: Display name of the custom repository. [required]
|
|
1411
|
+
* `--node TEXT`: The repository node to work on (e.g. a CI code): its ID from the workbook's Nodes sheet, or its display name if that is unique. [required]
|
|
1412
|
+
* `-a, --asset TEXT`: An asset to add or remove: a warehouse FQN (source.schema[.table[.column]]), a catalog path (dotted, or ' / '-separated as the catalog shows it), or id:<lineage node id>. Repeatable.
|
|
1413
|
+
* `--assets-file TEXT`: CSV or Excel file with one asset per row in the first column. A first row is skipped as a header only if it is one of (in any case): asset, assets, catalog path, exclude, exclude asset, exclude assets, excluded asset, excluded assets, fqn, fqns, node, node id, path. Any other first row is read as an asset.
|
|
1414
|
+
* `--dry-run`: Show what would change without writing.
|
|
1415
|
+
* `--help`: Show this message and exit.
|
|
1416
|
+
|
|
1370
1417
|
# `bigeye metric`
|
|
1371
1418
|
|
|
1372
1419
|
Metric Commands for Bigeye CLI
|
|
@@ -1991,7 +2038,7 @@ $ bigeye lineage export-graphs [OPTIONS]
|
|
|
1991
2038
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1992
2039
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1993
2040
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1994
|
-
* `--fqns-file TEXT`: Path to a CSV with a single column of fully-qualified catalog names. [required]
|
|
2041
|
+
* `--fqns-file TEXT`: Path to a CSV or Excel file with a single column of fully-qualified catalog names. [required]
|
|
1995
2042
|
* `--direction [upstream|downstream|both]`: Direction to traverse: upstream, downstream, or both. [default: both]
|
|
1996
2043
|
* `--content [all|nodes|edges|attributes]`: What each per-graph report contains: all, nodes, edges, or attributes. [default: all]
|
|
1997
2044
|
* `--include-etl / --no-include-etl`: Include or exclude ETL operator nodes. Defaults to including them. [default: include-etl]
|
|
@@ -2028,5 +2075,7 @@ $ bigeye lineage export-end-to-end [OPTIONS]
|
|
|
2028
2075
|
* `--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).
|
|
2029
2076
|
* `--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]
|
|
2030
2077
|
* `-o, --output TEXT`: Output .csv path. Defaults to end_to_end_<root>.csv in the current directory.
|
|
2078
|
+
* `--exclude-file TEXT`: CSV or Excel file listing assets to leave out of the paths, one per row in the first column. Each is a catalog path or warehouse FQN, as written in the Hop_* columns, or id:<lineage node id>, and also excludes everything inside it. Paths are joined across excluded assets, so A <- X <- B with X excluded becomes A <- B. A first row is skipped as a header only if it is one of (in any case): asset, assets, catalog path, exclude, exclude asset, exclude assets, excluded asset, excluded assets, fqn, fqns, node, node id, path. Any other first row is read as an asset.
|
|
2031
2079
|
* `--help`: Show this message and exit.
|
|
2032
2080
|
|
|
2081
|
+
|
|
@@ -1,24 +1,5 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: bigeye-cli
|
|
3
|
-
Version: 0.8.7
|
|
4
|
-
Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
|
|
5
|
-
Home-page: https://docs.bigeye.com/docs
|
|
6
|
-
License: Proprietary
|
|
7
|
-
Author: Bigeye
|
|
8
|
-
Author-email: support@bigeye.com
|
|
9
|
-
Requires-Python: >=3.11.0,<4.0.0
|
|
10
|
-
Classifier: License :: Other/Proprietary License
|
|
11
|
-
Classifier: Programming Language :: Python :: 3
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
14
|
-
Requires-Dist: PyGithub (>=1.59.1,<2.0.0)
|
|
15
|
-
Requires-Dist: bigeye-sdk (>=0.11.3,<0.12.0)
|
|
16
|
-
Requires-Dist: click (>=8.1.8,<9.0.0)
|
|
17
|
-
Requires-Dist: rich (>=14.1.0,<15.0.0)
|
|
18
|
-
Description-Content-Type: text/markdown
|
|
19
|
-
|
|
20
1
|
# **Bigeye CLI**
|
|
21
|
-
Version: 0.
|
|
2
|
+
Version: 0.9.2
|
|
22
3
|
## Installation
|
|
23
4
|
|
|
24
5
|
**Setting up your local/build environment**
|
|
@@ -709,7 +690,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
709
690
|
|
|
710
691
|
**Commands**:
|
|
711
692
|
|
|
712
|
-
* `regen-autometrics`: Regenerates Autometrics by warehouse id OR... (DEPRECATED)
|
|
713
693
|
* `delete-metrics`: Delete metrics in a warehouse id, by...
|
|
714
694
|
* `rebuild`: Rebuilds/Reprofiles a source by warehouse...
|
|
715
695
|
* `get-table-info`: Outputs table info to a file for an entire...
|
|
@@ -717,7 +697,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
717
697
|
* `run-metrics`: Runs metrics by warehouse id, schema...
|
|
718
698
|
* `add-source`: Adds a source to specified Bigeye workspace.
|
|
719
699
|
* `delete-source`: Delete a source from specified Bigeye...
|
|
720
|
-
* `backfill-autothresholds`: Backfills autothresholds by warehouse id,...
|
|
721
700
|
* `backfill-metrics`: Backfills metrics by warehouse id, schema...
|
|
722
701
|
* `schedule-all-metrics`: Updates schedule for all metrics in a...
|
|
723
702
|
* `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
|
|
@@ -737,26 +716,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
737
716
|
* `sync-custom-repository`: Sync a custom repository from a YAML file.
|
|
738
717
|
* `custom-repo`: Import and export custom repositories as...
|
|
739
718
|
|
|
740
|
-
## `bigeye catalog regen-autometrics`
|
|
741
|
-
|
|
742
|
-
Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids.
|
|
743
|
-
|
|
744
|
-
**Usage**:
|
|
745
|
-
|
|
746
|
-
```console
|
|
747
|
-
$ bigeye catalog regen-autometrics [OPTIONS]
|
|
748
|
-
```
|
|
749
|
-
|
|
750
|
-
**Options**:
|
|
751
|
-
|
|
752
|
-
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
753
|
-
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
754
|
-
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
755
|
-
* `-wid, --warehouse_id INTEGER`: Warehouse ID. If none will look for Table IDs. If value then will pull all table ids for warehouse
|
|
756
|
-
* `-sn, --schema_name TEXT`: List of Schema Names E.g. -sn schema_1 -sn schema_2. Do not include warehouse name -- GREENE_HOMES_DEMO_STANDARD.CONFORMED is fully qualified and CONFORMED is the schema name.
|
|
757
|
-
* `-tid, --table_id INTEGER`: List of Table IDs. E.g. -tid 123 -tid 124
|
|
758
|
-
* `--help`: Show this message and exit.
|
|
759
|
-
|
|
760
719
|
## `bigeye catalog delete-metrics`
|
|
761
720
|
|
|
762
721
|
Delete metrics in a warehouse id, by schema names, or by table_ids. Also, can filter by multipe
|
|
@@ -903,26 +862,6 @@ $ bigeye catalog delete-source [OPTIONS]
|
|
|
903
862
|
* `-wid, --warehouse_id INTEGER`: The ID of the warehouse to delete.
|
|
904
863
|
* `--help`: Show this message and exit.
|
|
905
864
|
|
|
906
|
-
## `bigeye catalog backfill-autothresholds`
|
|
907
|
-
|
|
908
|
-
Backfills autothresholds by warehouse id, schema names, and/or table ids.
|
|
909
|
-
|
|
910
|
-
**Usage**:
|
|
911
|
-
|
|
912
|
-
```console
|
|
913
|
-
$ bigeye catalog backfill-autothresholds [OPTIONS]
|
|
914
|
-
```
|
|
915
|
-
|
|
916
|
-
**Options**:
|
|
917
|
-
|
|
918
|
-
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
919
|
-
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
920
|
-
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
921
|
-
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
922
|
-
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
923
|
-
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
924
|
-
* `--help`: Show this message and exit.
|
|
925
|
-
|
|
926
865
|
## `bigeye catalog backfill-metrics`
|
|
927
866
|
|
|
928
867
|
Backfills metrics by warehouse id, schema names, and/or table ids.
|
|
@@ -1308,6 +1247,9 @@ $ bigeye catalog custom-repo [OPTIONS] COMMAND [ARGS]...
|
|
|
1308
1247
|
* `import`: Import a custom repository from an Excel...
|
|
1309
1248
|
* `export`: Export a custom repository to an Excel...
|
|
1310
1249
|
* `delete`: Entirely delete a custom repository,...
|
|
1250
|
+
* `contents`: List the Bigeye assets (schemas, tables,...
|
|
1251
|
+
* `add-contents`: Add existing Bigeye assets to a custom...
|
|
1252
|
+
* `remove-contents`: Remove assets from a custom node (e.g.
|
|
1311
1253
|
|
|
1312
1254
|
### `bigeye catalog custom-repo init`
|
|
1313
1255
|
|
|
@@ -1328,7 +1270,8 @@ $ bigeye catalog custom-repo init [OPTIONS]
|
|
|
1328
1270
|
|
|
1329
1271
|
### `bigeye catalog custom-repo import`
|
|
1330
1272
|
|
|
1331
|
-
Import a custom repository from an Excel workbook
|
|
1273
|
+
Import a custom repository from an Excel workbook, and/or add or update
|
|
1274
|
+
attributes on nodes already in Bigeye (by node id, catalog path, or FQN).
|
|
1332
1275
|
|
|
1333
1276
|
**Usage**:
|
|
1334
1277
|
|
|
@@ -1343,8 +1286,8 @@ $ bigeye catalog custom-repo import [OPTIONS]
|
|
|
1343
1286
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1344
1287
|
* `-f, --file TEXT`: Path to the custom repository .xlsx workbook. [required]
|
|
1345
1288
|
* `--cleanup-stale`: Delete nodes/edges present in Bigeye but missing from the sheet. Off by default.
|
|
1346
|
-
* `--skip-unresolved-edges / --no-skip-unresolved-edges`: Import the rest instead of aborting when some edge endpoints don't resolve to a Bigeye node (default: on). Skipped
|
|
1347
|
-
* `--unresolved-log TEXT`: Path for the unresolved-
|
|
1289
|
+
* `--skip-unresolved-edges / --no-skip-unresolved-edges`: Import the rest instead of aborting when some edge endpoints or attribute IDs don't resolve to a Bigeye node (default: on). Skipped references are written to the unresolved log. Pass --no-skip-unresolved-edges to abort on any unresolved reference. [default: skip-unresolved-edges]
|
|
1290
|
+
* `--unresolved-log TEXT`: Path for the unresolved-references log. Defaults to custom_repo_unresolved.log in the current working directory. [default: custom_repo_unresolved.log]
|
|
1348
1291
|
* `--help`: Show this message and exit.
|
|
1349
1292
|
|
|
1350
1293
|
### `bigeye catalog custom-repo export`
|
|
@@ -1386,6 +1329,72 @@ $ bigeye catalog custom-repo delete [OPTIONS]
|
|
|
1386
1329
|
* `-y, --yes`: Skip the confirmation prompt.
|
|
1387
1330
|
* `--help`: Show this message and exit.
|
|
1388
1331
|
|
|
1332
|
+
### `bigeye catalog custom-repo contents`
|
|
1333
|
+
|
|
1334
|
+
List the Bigeye assets (schemas, tables, files, ...) a custom node contains, such as the
|
|
1335
|
+
assets assigned to a CI code. Children in the repository's own hierarchy are not listed.
|
|
1336
|
+
|
|
1337
|
+
**Usage**:
|
|
1338
|
+
|
|
1339
|
+
```console
|
|
1340
|
+
$ bigeye catalog custom-repo contents [OPTIONS]
|
|
1341
|
+
```
|
|
1342
|
+
|
|
1343
|
+
**Options**:
|
|
1344
|
+
|
|
1345
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1346
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1347
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1348
|
+
* `--repo-name TEXT`: Display name of the custom repository. [required]
|
|
1349
|
+
* `--node TEXT`: The repository node to work on (e.g. a CI code): its ID from the workbook's Nodes sheet, or its display name if that is unique. [required]
|
|
1350
|
+
* `--help`: Show this message and exit.
|
|
1351
|
+
|
|
1352
|
+
### `bigeye catalog custom-repo add-contents`
|
|
1353
|
+
|
|
1354
|
+
Add existing Bigeye assets to a custom node (e.g. assign schemas or files to a CI code) by
|
|
1355
|
+
creating a containment edge to each. Assets keep their catalog location and lineage.
|
|
1356
|
+
|
|
1357
|
+
**Usage**:
|
|
1358
|
+
|
|
1359
|
+
```console
|
|
1360
|
+
$ bigeye catalog custom-repo add-contents [OPTIONS]
|
|
1361
|
+
```
|
|
1362
|
+
|
|
1363
|
+
**Options**:
|
|
1364
|
+
|
|
1365
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1366
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1367
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1368
|
+
* `--repo-name TEXT`: Display name of the custom repository. [required]
|
|
1369
|
+
* `--node TEXT`: The repository node to work on (e.g. a CI code): its ID from the workbook's Nodes sheet, or its display name if that is unique. [required]
|
|
1370
|
+
* `-a, --asset TEXT`: An asset to add or remove: a warehouse FQN (source.schema[.table[.column]]), a catalog path (dotted, or ' / '-separated as the catalog shows it), or id:<lineage node id>. Repeatable.
|
|
1371
|
+
* `--assets-file TEXT`: CSV or Excel file with one asset per row in the first column. A first row is skipped as a header only if it is one of (in any case): asset, assets, catalog path, exclude, exclude asset, exclude assets, excluded asset, excluded assets, fqn, fqns, node, node id, path. Any other first row is read as an asset.
|
|
1372
|
+
* `--dry-run`: Show what would change without writing.
|
|
1373
|
+
* `--help`: Show this message and exit.
|
|
1374
|
+
|
|
1375
|
+
### `bigeye catalog custom-repo remove-contents`
|
|
1376
|
+
|
|
1377
|
+
Remove assets from a custom node (e.g. unassign them from a CI code). Deletes only the
|
|
1378
|
+
containment edge between the node and each asset; the asset and its lineage are untouched.
|
|
1379
|
+
|
|
1380
|
+
**Usage**:
|
|
1381
|
+
|
|
1382
|
+
```console
|
|
1383
|
+
$ bigeye catalog custom-repo remove-contents [OPTIONS]
|
|
1384
|
+
```
|
|
1385
|
+
|
|
1386
|
+
**Options**:
|
|
1387
|
+
|
|
1388
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1389
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1390
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1391
|
+
* `--repo-name TEXT`: Display name of the custom repository. [required]
|
|
1392
|
+
* `--node TEXT`: The repository node to work on (e.g. a CI code): its ID from the workbook's Nodes sheet, or its display name if that is unique. [required]
|
|
1393
|
+
* `-a, --asset TEXT`: An asset to add or remove: a warehouse FQN (source.schema[.table[.column]]), a catalog path (dotted, or ' / '-separated as the catalog shows it), or id:<lineage node id>. Repeatable.
|
|
1394
|
+
* `--assets-file TEXT`: CSV or Excel file with one asset per row in the first column. A first row is skipped as a header only if it is one of (in any case): asset, assets, catalog path, exclude, exclude asset, exclude assets, excluded asset, excluded assets, fqn, fqns, node, node id, path. Any other first row is read as an asset.
|
|
1395
|
+
* `--dry-run`: Show what would change without writing.
|
|
1396
|
+
* `--help`: Show this message and exit.
|
|
1397
|
+
|
|
1389
1398
|
# `bigeye metric`
|
|
1390
1399
|
|
|
1391
1400
|
Metric Commands for Bigeye CLI
|
|
@@ -2010,7 +2019,7 @@ $ bigeye lineage export-graphs [OPTIONS]
|
|
|
2010
2019
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
2011
2020
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
2012
2021
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
2013
|
-
* `--fqns-file TEXT`: Path to a CSV with a single column of fully-qualified catalog names. [required]
|
|
2022
|
+
* `--fqns-file TEXT`: Path to a CSV or Excel file with a single column of fully-qualified catalog names. [required]
|
|
2014
2023
|
* `--direction [upstream|downstream|both]`: Direction to traverse: upstream, downstream, or both. [default: both]
|
|
2015
2024
|
* `--content [all|nodes|edges|attributes]`: What each per-graph report contains: all, nodes, edges, or attributes. [default: all]
|
|
2016
2025
|
* `--include-etl / --no-include-etl`: Include or exclude ETL operator nodes. Defaults to including them. [default: include-etl]
|
|
@@ -2047,6 +2056,6 @@ $ bigeye lineage export-end-to-end [OPTIONS]
|
|
|
2047
2056
|
* `--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).
|
|
2048
2057
|
* `--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]
|
|
2049
2058
|
* `-o, --output TEXT`: Output .csv path. Defaults to end_to_end_<root>.csv in the current directory.
|
|
2059
|
+
* `--exclude-file TEXT`: CSV or Excel file listing assets to leave out of the paths, one per row in the first column. Each is a catalog path or warehouse FQN, as written in the Hop_* columns, or id:<lineage node id>, and also excludes everything inside it. Paths are joined across excluded assets, so A <- X <- B with X excluded becomes A <- B. A first row is skipped as a header only if it is one of (in any case): asset, assets, catalog path, exclude, exclude asset, exclude assets, excluded asset, excluded assets, fqn, fqns, node, node id, path. Any other first row is read as an asset.
|
|
2050
2060
|
* `--help`: Show this message and exit.
|
|
2051
2061
|
|
|
2052
|
-
|
|
@@ -59,7 +59,6 @@ from bigeye_cli.functions import (
|
|
|
59
59
|
write_debug_queries,
|
|
60
60
|
write_metric_templates, write_yaml_templates, write_virtual_tables,
|
|
61
61
|
)
|
|
62
|
-
from bigeye_sdk.functions.metric_functions import has_auto_threshold
|
|
63
62
|
from bigeye_sdk.functions.core_py_functs import int_enum_enum_list_joined
|
|
64
63
|
from bigeye_sdk.model.schema_change import SourceSchemaChange
|
|
65
64
|
|
|
@@ -75,49 +74,6 @@ would include metrics batched at any of these levels.
|
|
|
75
74
|
"""
|
|
76
75
|
|
|
77
76
|
|
|
78
|
-
@app.command(deprecated=True)
|
|
79
|
-
def regen_autometrics(
|
|
80
|
-
bigeye_conf: str = global_options.bigeye_conf,
|
|
81
|
-
config_file: str = global_options.config_file,
|
|
82
|
-
workspace: str = global_options.workspace,
|
|
83
|
-
warehouse_id: int = typer.Option(
|
|
84
|
-
None,
|
|
85
|
-
"--warehouse_id",
|
|
86
|
-
"-wid",
|
|
87
|
-
help="Warehouse ID. If none will look for Table IDs. If value then will pull all table ids for "
|
|
88
|
-
"warehouse",
|
|
89
|
-
),
|
|
90
|
-
schema_names: Optional[List[str]] = typer.Option(
|
|
91
|
-
None,
|
|
92
|
-
"--schema_name",
|
|
93
|
-
"-sn",
|
|
94
|
-
help="List of Schema Names E.g. -sn schema_1 -sn schema_2. Do not include warehouse name -- "
|
|
95
|
-
"GREENE_HOMES_DEMO_STANDARD.CONFORMED is fully qualified and CONFORMED is the schema name.",
|
|
96
|
-
),
|
|
97
|
-
table_ids: Optional[List[int]] = typer.Option(
|
|
98
|
-
None, "--table_id", "-tid", help="List of Table IDs. E.g. -tid 123 -tid 124"
|
|
99
|
-
),
|
|
100
|
-
):
|
|
101
|
-
"""Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids."""
|
|
102
|
-
log.warning(build_deprecation_message("bigeye catalog regen_autometrics"))
|
|
103
|
-
client = cli_client_factory(bigeye_conf, config_file, workspace)
|
|
104
|
-
|
|
105
|
-
if not table_ids:
|
|
106
|
-
table_ids = client.get_table_ids(
|
|
107
|
-
warehouse_id=[warehouse_id], schemas=schema_names
|
|
108
|
-
)
|
|
109
|
-
|
|
110
|
-
if table_ids:
|
|
111
|
-
log.info(f"Regenerating autometrics on: {table_ids}")
|
|
112
|
-
for tid in table_ids:
|
|
113
|
-
client.regen_autometrics(table_id=tid)
|
|
114
|
-
else:
|
|
115
|
-
raise Exception(
|
|
116
|
-
"Could not identify table_ids to run. Provide either a valid list of table ids OR a valid "
|
|
117
|
-
"warehouse ID OR a valid warehouse ID and list of valid schema names"
|
|
118
|
-
)
|
|
119
|
-
|
|
120
|
-
|
|
121
77
|
@app.command()
|
|
122
78
|
def delete_metrics(
|
|
123
79
|
bigeye_conf: str = global_options.bigeye_conf,
|
|
@@ -407,44 +363,6 @@ def delete_source(
|
|
|
407
363
|
client.delete_source(warehouse_id)
|
|
408
364
|
|
|
409
365
|
|
|
410
|
-
@app.command()
|
|
411
|
-
def backfill_autothresholds(
|
|
412
|
-
bigeye_conf: str = global_options.bigeye_conf,
|
|
413
|
-
config_file: str = global_options.config_file,
|
|
414
|
-
workspace: str = global_options.workspace,
|
|
415
|
-
warehouse_id: int = typer.Option(
|
|
416
|
-
None, "--warehouse_id", "-wid", help="Warehouse ID"
|
|
417
|
-
),
|
|
418
|
-
schema_names: Optional[List[str]] = typer.Option(
|
|
419
|
-
None,
|
|
420
|
-
"--schema_name",
|
|
421
|
-
"-sn",
|
|
422
|
-
help="List of Schema Names. E.g. -sn schema_1 -sn schema_2.",
|
|
423
|
-
),
|
|
424
|
-
table_ids: Optional[List[int]] = typer.Option(
|
|
425
|
-
None, "--table_id", "-tid", help="Table IDs. E.g. -tid 123 -tid 124"
|
|
426
|
-
),
|
|
427
|
-
):
|
|
428
|
-
"""Backfills autothresholds by warehouse id, schema names, and/or table ids."""
|
|
429
|
-
client = cli_client_factory(bigeye_conf, config_file, workspace)
|
|
430
|
-
|
|
431
|
-
mil: MetricInfoList = client.get_metric_info_batch_post(
|
|
432
|
-
warehouse_ids=[warehouse_id], table_ids=table_ids
|
|
433
|
-
)
|
|
434
|
-
if schema_names:
|
|
435
|
-
mil.metrics = [
|
|
436
|
-
m for m in mil.metrics if m.metric_metadata.schema_name in schema_names
|
|
437
|
-
]
|
|
438
|
-
|
|
439
|
-
mids = [
|
|
440
|
-
m.metric_configuration.id
|
|
441
|
-
for m in mil.metrics
|
|
442
|
-
if has_auto_threshold(m.metric_configuration.thresholds)
|
|
443
|
-
]
|
|
444
|
-
|
|
445
|
-
client.backfill_autothresholds(metric_ids=mids)
|
|
446
|
-
|
|
447
|
-
|
|
448
366
|
@app.command()
|
|
449
367
|
def backfill_metrics(
|
|
450
368
|
bigeye_conf: str = global_options.bigeye_conf,
|