bigeye-cli 0.3.47__tar.gz → 0.3.50__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.3.47/bigeye_cli/CLI_DOCS.md → bigeye_cli-0.3.50/PKG-INFO +78 -10
- bigeye_cli-0.3.47/PKG-INFO → bigeye_cli-0.3.50/bigeye_cli/CLI_DOCS.md +57 -30
- bigeye_cli-0.3.50/bigeye_cli/catalog/catalog_commands.py +1077 -0
- bigeye_cli-0.3.50/bigeye_cli/collections/collection_commands.py +300 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/deltas/deltas_commands.py +92 -72
- bigeye_cli-0.3.50/bigeye_cli/metric/metric_commands.py +461 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/pyproject.toml +3 -3
- bigeye_cli-0.3.47/bigeye_cli/catalog/catalog_commands.py +0 -911
- bigeye_cli-0.3.47/bigeye_cli/collections/collection_commands.py +0 -261
- bigeye_cli-0.3.47/bigeye_cli/metric/metric_commands.py +0 -397
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/LICENSE +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/__main__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/__version__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/bigconfig/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/bigconfig/bigconfig_commands.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/bigconfig/bigconfig_options.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/catalog/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/collections/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/configure/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/configure/configure_commands.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/deltas/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/enums.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/exceptions/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/exceptions/exceptions.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/functions.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/global_options.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/issues/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/issues/issue_commands.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/lineage/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/lineage/lineage_commands.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/metric/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/model/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/model/cicd_conf.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/model/github_report.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/model/vendor_report.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/workspace/__init__.py +0 -0
- {bigeye_cli-0.3.47 → bigeye_cli-0.3.50}/bigeye_cli/workspace/workspace_commands.py +0 -0
|
@@ -1,5 +1,25 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: bigeye-cli
|
|
3
|
+
Version: 0.3.50
|
|
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.9.0,<4.0.0
|
|
10
|
+
Classifier: License :: Other/Proprietary License
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Requires-Dist: bigeye-sdk (>=0.4.66,<0.5.0)
|
|
17
|
+
Requires-Dist: click (>=8.0.4,<9.0.0)
|
|
18
|
+
Requires-Dist: rich (>=12.4.4,<13.0.0)
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
|
|
1
21
|
# **Bigeye CLI**
|
|
2
|
-
Version: 0.3.
|
|
22
|
+
Version: 0.3.50
|
|
3
23
|
## Installation
|
|
4
24
|
|
|
5
25
|
**Setting up your local/build environment**
|
|
@@ -470,7 +490,8 @@ MINUTES_TIME_INTERVAL_TYPE:2
|
|
|
470
490
|
SECONDS_TIME_INTERVAL_TYPE:3
|
|
471
491
|
DAYS_TIME_INTERVAL_TYPE:4
|
|
472
492
|
WEEKDAYS_TIME_INTERVAL_TYPE:5
|
|
473
|
-
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
493
|
+
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
494
|
+
MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
|
|
474
495
|
* `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
|
|
475
496
|
* `--help`: Show this message and exit.
|
|
476
497
|
|
|
@@ -653,6 +674,7 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
653
674
|
* `get-metric-info`: Outputs metric info to a file.
|
|
654
675
|
* `get-metric-queries`: Gets the debug queries for all metrics by...
|
|
655
676
|
* `get-table-info`: Outputs table info to a file for an entire...
|
|
677
|
+
* `ingest-owners-from-dbt`: Ingest table owners from dbt manifest.json...
|
|
656
678
|
* `rebuild`: Rebuilds/Reprofiles a source by warehouse...
|
|
657
679
|
* `regen-autometrics`: Regenerates Autometrics by warehouse id OR...
|
|
658
680
|
* `run-metrics`: Runs metrics by warehouse id, schema...
|
|
@@ -723,6 +745,7 @@ $ bigeye catalog backfill-metrics [OPTIONS]
|
|
|
723
745
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
724
746
|
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
725
747
|
* `--delete_history`: Delete metric run history
|
|
748
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
726
749
|
* `--help`: Show this message and exit.
|
|
727
750
|
|
|
728
751
|
## `bigeye catalog delete-metrics`
|
|
@@ -744,7 +767,7 @@ $ bigeye catalog delete-metrics [OPTIONS]
|
|
|
744
767
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
745
768
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
746
769
|
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
747
|
-
* `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME
|
|
770
|
+
* `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME, FRESHNESS_DATA_DATE, FRESHNESS_DATA_TIMESTAMP, VOLUME_DATA
|
|
748
771
|
* `--help`: Show this message and exit.
|
|
749
772
|
|
|
750
773
|
## `bigeye catalog delete-source`
|
|
@@ -912,6 +935,26 @@ $ bigeye catalog get-table-info [OPTIONS]
|
|
|
912
935
|
* `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
|
|
913
936
|
* `--help`: Show this message and exit.
|
|
914
937
|
|
|
938
|
+
## `bigeye catalog ingest-owners-from-dbt`
|
|
939
|
+
|
|
940
|
+
Ingest table owners from dbt manifest.json file.
|
|
941
|
+
|
|
942
|
+
**Usage**:
|
|
943
|
+
|
|
944
|
+
```console
|
|
945
|
+
$ bigeye catalog ingest-owners-from-dbt [OPTIONS]
|
|
946
|
+
```
|
|
947
|
+
|
|
948
|
+
**Options**:
|
|
949
|
+
|
|
950
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
951
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
952
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
953
|
+
* `-mf, --manifest_file TEXT`: The path to the dbt manifest file.
|
|
954
|
+
* `-sn, --source_name TEXT`: The name of the source in Bigeye where owners will be ingested.
|
|
955
|
+
* `-sid, --source_id INTEGER`: The id of the source in Bigeye where owners will be ingested.
|
|
956
|
+
* `--help`: Show this message and exit.
|
|
957
|
+
|
|
915
958
|
## `bigeye catalog rebuild`
|
|
916
959
|
|
|
917
960
|
Rebuilds/Reprofiles a source by warehouse id or a schema by warehouse id and schema name.
|
|
@@ -969,6 +1012,7 @@ $ bigeye catalog run-metrics [OPTIONS]
|
|
|
969
1012
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
970
1013
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
971
1014
|
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
1015
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
972
1016
|
* `--help`: Show this message and exit.
|
|
973
1017
|
|
|
974
1018
|
## `bigeye catalog schedule-all-metrics`
|
|
@@ -994,7 +1038,8 @@ MINUTES_TIME_INTERVAL_TYPE:2
|
|
|
994
1038
|
SECONDS_TIME_INTERVAL_TYPE:3
|
|
995
1039
|
DAYS_TIME_INTERVAL_TYPE:4
|
|
996
1040
|
WEEKDAYS_TIME_INTERVAL_TYPE:5
|
|
997
|
-
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
1041
|
+
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
1042
|
+
MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
|
|
998
1043
|
* `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
|
|
999
1044
|
* `--help`: Show this message and exit.
|
|
1000
1045
|
|
|
@@ -1208,6 +1253,7 @@ $ bigeye metric run [OPTIONS]
|
|
|
1208
1253
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1209
1254
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1210
1255
|
* `-mid, --metric_id INTEGER`: Metric Ids. [required]
|
|
1256
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
1211
1257
|
* `--help`: Show this message and exit.
|
|
1212
1258
|
|
|
1213
1259
|
## `bigeye metric upsert`
|
|
@@ -1338,6 +1384,7 @@ $ bigeye deltas [OPTIONS] COMMAND [ARGS]...
|
|
|
1338
1384
|
|
|
1339
1385
|
* `cicd`: Creates a delta based on...
|
|
1340
1386
|
* `create-delta`: Creates deltas between tables from a...
|
|
1387
|
+
* `create-template`: Create a template delta configuration file...
|
|
1341
1388
|
* `run-delta`: Runs a delta by Delta ID.
|
|
1342
1389
|
* `suggest-deltas`: Suggests and creates Deltas with default...
|
|
1343
1390
|
|
|
@@ -1380,6 +1427,26 @@ $ bigeye deltas create-delta [OPTIONS]
|
|
|
1380
1427
|
* `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn't exist.
|
|
1381
1428
|
* `--help`: Show this message and exit.
|
|
1382
1429
|
|
|
1430
|
+
## `bigeye deltas create-template`
|
|
1431
|
+
|
|
1432
|
+
Create a template delta configuration file based on table names.
|
|
1433
|
+
|
|
1434
|
+
**Usage**:
|
|
1435
|
+
|
|
1436
|
+
```console
|
|
1437
|
+
$ bigeye deltas create-template [OPTIONS]
|
|
1438
|
+
```
|
|
1439
|
+
|
|
1440
|
+
**Options**:
|
|
1441
|
+
|
|
1442
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1443
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1444
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1445
|
+
* `-stn, --source_table_name TEXT`: The fully qualified name of the source table [required]
|
|
1446
|
+
* `-ttn, --target_table_name TEXT`: The fully qualified name of the target table [required]
|
|
1447
|
+
* `-op, --output_path TEXT`: Path to write the template. [required]
|
|
1448
|
+
* `--help`: Show this message and exit.
|
|
1449
|
+
|
|
1383
1450
|
## `bigeye deltas run-delta`
|
|
1384
1451
|
|
|
1385
1452
|
Runs a delta by Delta ID.
|
|
@@ -1413,12 +1480,10 @@ $ bigeye deltas suggest-deltas [OPTIONS]
|
|
|
1413
1480
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1414
1481
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1415
1482
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1416
|
-
*
|
|
1417
|
-
*
|
|
1418
|
-
* `-
|
|
1419
|
-
* `-
|
|
1420
|
-
* `-snp, --schema_name_pair TEXT`: Fully qualified schema name pairs. e.g. -snp source_schema_1:target_schema_1 -snp source_warehouse.source_schema:target_warehouse.target_schema
|
|
1421
|
-
* `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
|
|
1483
|
+
* `--source-selector TEXT`: [default: <typer.models.OptionInfo object at 0x7fa338095900>]
|
|
1484
|
+
* `--target-selector TEXT`: [default: <typer.models.OptionInfo object at 0x7fa338095930>]
|
|
1485
|
+
* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match. [default: MatchType.STRICT]
|
|
1486
|
+
* `-op, --output_path TEXT`: File to write the delta configuration. [required]
|
|
1422
1487
|
* `--help`: Show this message and exit.
|
|
1423
1488
|
|
|
1424
1489
|
# `bigeye collections`
|
|
@@ -1483,6 +1548,7 @@ $ bigeye collections backfill-metrics [OPTIONS]
|
|
|
1483
1548
|
* `--from_collections`: Scrapes all Collections in customer workspace for Metric Info.
|
|
1484
1549
|
* `--collection_ids INTEGER`: Collection IDs. Scrape certain Collections for Metric Info.
|
|
1485
1550
|
* `--delete_history`: Delete metric run history
|
|
1551
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
1486
1552
|
* `--help`: Show this message and exit.
|
|
1487
1553
|
|
|
1488
1554
|
## `bigeye collections get-metric-info`
|
|
@@ -1562,6 +1628,7 @@ $ bigeye collections run-metrics [OPTIONS]
|
|
|
1562
1628
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1563
1629
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1564
1630
|
* `-cid, --collection_id INTEGER`: Collection ID [required]
|
|
1631
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
1565
1632
|
* `--help`: Show this message and exit.
|
|
1566
1633
|
|
|
1567
1634
|
# `bigeye lineage`
|
|
@@ -1685,3 +1752,4 @@ $ bigeye lineage infer-relations [OPTIONS]
|
|
|
1685
1752
|
* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match. [default: MatchType.STRICT]
|
|
1686
1753
|
* `--help`: Show this message and exit.
|
|
1687
1754
|
|
|
1755
|
+
|
|
@@ -1,24 +1,5 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: bigeye-cli
|
|
3
|
-
Version: 0.3.47
|
|
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.9.0,<4.0.0
|
|
10
|
-
Classifier: License :: Other/Proprietary License
|
|
11
|
-
Classifier: Programming Language :: Python :: 3
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
-
Requires-Dist: bigeye-sdk (>=0.4.66,<0.5.0)
|
|
16
|
-
Requires-Dist: click (>=8.0.4,<9.0.0)
|
|
17
|
-
Requires-Dist: rich (>=12.4.4,<13.0.0)
|
|
18
|
-
Description-Content-Type: text/markdown
|
|
19
|
-
|
|
20
1
|
# **Bigeye CLI**
|
|
21
|
-
Version: 0.3.
|
|
2
|
+
Version: 0.3.50
|
|
22
3
|
## Installation
|
|
23
4
|
|
|
24
5
|
**Setting up your local/build environment**
|
|
@@ -489,7 +470,8 @@ MINUTES_TIME_INTERVAL_TYPE:2
|
|
|
489
470
|
SECONDS_TIME_INTERVAL_TYPE:3
|
|
490
471
|
DAYS_TIME_INTERVAL_TYPE:4
|
|
491
472
|
WEEKDAYS_TIME_INTERVAL_TYPE:5
|
|
492
|
-
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
473
|
+
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
474
|
+
MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
|
|
493
475
|
* `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
|
|
494
476
|
* `--help`: Show this message and exit.
|
|
495
477
|
|
|
@@ -672,6 +654,7 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
672
654
|
* `get-metric-info`: Outputs metric info to a file.
|
|
673
655
|
* `get-metric-queries`: Gets the debug queries for all metrics by...
|
|
674
656
|
* `get-table-info`: Outputs table info to a file for an entire...
|
|
657
|
+
* `ingest-owners-from-dbt`: Ingest table owners from dbt manifest.json...
|
|
675
658
|
* `rebuild`: Rebuilds/Reprofiles a source by warehouse...
|
|
676
659
|
* `regen-autometrics`: Regenerates Autometrics by warehouse id OR...
|
|
677
660
|
* `run-metrics`: Runs metrics by warehouse id, schema...
|
|
@@ -742,6 +725,7 @@ $ bigeye catalog backfill-metrics [OPTIONS]
|
|
|
742
725
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
743
726
|
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
744
727
|
* `--delete_history`: Delete metric run history
|
|
728
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
745
729
|
* `--help`: Show this message and exit.
|
|
746
730
|
|
|
747
731
|
## `bigeye catalog delete-metrics`
|
|
@@ -763,7 +747,7 @@ $ bigeye catalog delete-metrics [OPTIONS]
|
|
|
763
747
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
764
748
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
765
749
|
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
766
|
-
* `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME
|
|
750
|
+
* `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME, FRESHNESS_DATA_DATE, FRESHNESS_DATA_TIMESTAMP, VOLUME_DATA
|
|
767
751
|
* `--help`: Show this message and exit.
|
|
768
752
|
|
|
769
753
|
## `bigeye catalog delete-source`
|
|
@@ -931,6 +915,26 @@ $ bigeye catalog get-table-info [OPTIONS]
|
|
|
931
915
|
* `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
|
|
932
916
|
* `--help`: Show this message and exit.
|
|
933
917
|
|
|
918
|
+
## `bigeye catalog ingest-owners-from-dbt`
|
|
919
|
+
|
|
920
|
+
Ingest table owners from dbt manifest.json file.
|
|
921
|
+
|
|
922
|
+
**Usage**:
|
|
923
|
+
|
|
924
|
+
```console
|
|
925
|
+
$ bigeye catalog ingest-owners-from-dbt [OPTIONS]
|
|
926
|
+
```
|
|
927
|
+
|
|
928
|
+
**Options**:
|
|
929
|
+
|
|
930
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
931
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
932
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
933
|
+
* `-mf, --manifest_file TEXT`: The path to the dbt manifest file.
|
|
934
|
+
* `-sn, --source_name TEXT`: The name of the source in Bigeye where owners will be ingested.
|
|
935
|
+
* `-sid, --source_id INTEGER`: The id of the source in Bigeye where owners will be ingested.
|
|
936
|
+
* `--help`: Show this message and exit.
|
|
937
|
+
|
|
934
938
|
## `bigeye catalog rebuild`
|
|
935
939
|
|
|
936
940
|
Rebuilds/Reprofiles a source by warehouse id or a schema by warehouse id and schema name.
|
|
@@ -988,6 +992,7 @@ $ bigeye catalog run-metrics [OPTIONS]
|
|
|
988
992
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
989
993
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
990
994
|
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
995
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
991
996
|
* `--help`: Show this message and exit.
|
|
992
997
|
|
|
993
998
|
## `bigeye catalog schedule-all-metrics`
|
|
@@ -1013,7 +1018,8 @@ MINUTES_TIME_INTERVAL_TYPE:2
|
|
|
1013
1018
|
SECONDS_TIME_INTERVAL_TYPE:3
|
|
1014
1019
|
DAYS_TIME_INTERVAL_TYPE:4
|
|
1015
1020
|
WEEKDAYS_TIME_INTERVAL_TYPE:5
|
|
1016
|
-
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
1021
|
+
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
1022
|
+
MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
|
|
1017
1023
|
* `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
|
|
1018
1024
|
* `--help`: Show this message and exit.
|
|
1019
1025
|
|
|
@@ -1227,6 +1233,7 @@ $ bigeye metric run [OPTIONS]
|
|
|
1227
1233
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1228
1234
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1229
1235
|
* `-mid, --metric_id INTEGER`: Metric Ids. [required]
|
|
1236
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
1230
1237
|
* `--help`: Show this message and exit.
|
|
1231
1238
|
|
|
1232
1239
|
## `bigeye metric upsert`
|
|
@@ -1357,6 +1364,7 @@ $ bigeye deltas [OPTIONS] COMMAND [ARGS]...
|
|
|
1357
1364
|
|
|
1358
1365
|
* `cicd`: Creates a delta based on...
|
|
1359
1366
|
* `create-delta`: Creates deltas between tables from a...
|
|
1367
|
+
* `create-template`: Create a template delta configuration file...
|
|
1360
1368
|
* `run-delta`: Runs a delta by Delta ID.
|
|
1361
1369
|
* `suggest-deltas`: Suggests and creates Deltas with default...
|
|
1362
1370
|
|
|
@@ -1399,6 +1407,26 @@ $ bigeye deltas create-delta [OPTIONS]
|
|
|
1399
1407
|
* `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn't exist.
|
|
1400
1408
|
* `--help`: Show this message and exit.
|
|
1401
1409
|
|
|
1410
|
+
## `bigeye deltas create-template`
|
|
1411
|
+
|
|
1412
|
+
Create a template delta configuration file based on table names.
|
|
1413
|
+
|
|
1414
|
+
**Usage**:
|
|
1415
|
+
|
|
1416
|
+
```console
|
|
1417
|
+
$ bigeye deltas create-template [OPTIONS]
|
|
1418
|
+
```
|
|
1419
|
+
|
|
1420
|
+
**Options**:
|
|
1421
|
+
|
|
1422
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1423
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1424
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1425
|
+
* `-stn, --source_table_name TEXT`: The fully qualified name of the source table [required]
|
|
1426
|
+
* `-ttn, --target_table_name TEXT`: The fully qualified name of the target table [required]
|
|
1427
|
+
* `-op, --output_path TEXT`: Path to write the template. [required]
|
|
1428
|
+
* `--help`: Show this message and exit.
|
|
1429
|
+
|
|
1402
1430
|
## `bigeye deltas run-delta`
|
|
1403
1431
|
|
|
1404
1432
|
Runs a delta by Delta ID.
|
|
@@ -1432,12 +1460,10 @@ $ bigeye deltas suggest-deltas [OPTIONS]
|
|
|
1432
1460
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1433
1461
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1434
1462
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1435
|
-
*
|
|
1436
|
-
*
|
|
1437
|
-
* `-
|
|
1438
|
-
* `-
|
|
1439
|
-
* `-snp, --schema_name_pair TEXT`: Fully qualified schema name pairs. e.g. -snp source_schema_1:target_schema_1 -snp source_warehouse.source_schema:target_warehouse.target_schema
|
|
1440
|
-
* `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
|
|
1463
|
+
* `--source-selector TEXT`: [default: <typer.models.OptionInfo object at 0x7fa338095900>]
|
|
1464
|
+
* `--target-selector TEXT`: [default: <typer.models.OptionInfo object at 0x7fa338095930>]
|
|
1465
|
+
* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match. [default: MatchType.STRICT]
|
|
1466
|
+
* `-op, --output_path TEXT`: File to write the delta configuration. [required]
|
|
1441
1467
|
* `--help`: Show this message and exit.
|
|
1442
1468
|
|
|
1443
1469
|
# `bigeye collections`
|
|
@@ -1502,6 +1528,7 @@ $ bigeye collections backfill-metrics [OPTIONS]
|
|
|
1502
1528
|
* `--from_collections`: Scrapes all Collections in customer workspace for Metric Info.
|
|
1503
1529
|
* `--collection_ids INTEGER`: Collection IDs. Scrape certain Collections for Metric Info.
|
|
1504
1530
|
* `--delete_history`: Delete metric run history
|
|
1531
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
1505
1532
|
* `--help`: Show this message and exit.
|
|
1506
1533
|
|
|
1507
1534
|
## `bigeye collections get-metric-info`
|
|
@@ -1581,6 +1608,7 @@ $ bigeye collections run-metrics [OPTIONS]
|
|
|
1581
1608
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1582
1609
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1583
1610
|
* `-cid, --collection_id INTEGER`: Collection ID [required]
|
|
1611
|
+
* `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
|
|
1584
1612
|
* `--help`: Show this message and exit.
|
|
1585
1613
|
|
|
1586
1614
|
# `bigeye lineage`
|
|
@@ -1704,4 +1732,3 @@ $ bigeye lineage infer-relations [OPTIONS]
|
|
|
1704
1732
|
* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match. [default: MatchType.STRICT]
|
|
1705
1733
|
* `--help`: Show this message and exit.
|
|
1706
1734
|
|
|
1707
|
-
|