bigeye-cli 0.3.61__tar.gz → 0.3.62__tar.gz

bigeye_cli-0.3.61/bigeye_cli/CLI_DOCS.md → bigeye_cli-0.3.62/PKG-INFO

@@ -1,5 +1,25 @@
+Metadata-Version: 2.1
+Name: bigeye-cli
+Version: 0.3.62
+Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
+Home-page: https://docs.bigeye.com/docs
+License: Proprietary
+Author: Bigeye
+Author-email: support@bigeye.com
+Requires-Python: >=3.9.0,<4.0.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: PyGithub (>=1.57,<2.0)
+Requires-Dist: bigeye-sdk (>=0.4.83,<0.5.0)
+Requires-Dist: click (>=8.0.4,<9.0.0)
+Requires-Dist: rich (>=12.4.4,<13.0.0)
+Description-Content-Type: text/markdown
+
 # **Bigeye CLI**
-Version: 0.3.61
+Version: 0.3.55
 ## Installation
 
 **Setting up your local/build environment**  
@@ -171,7 +191,9 @@ password = fakepassword1234
 
 **Note:** Most use cases will only require you to have a single `DEFAULT` credential that all workspaces can utilize. Running the `bigeye configure -w <workspace-name>` command for a non-default workspace will prompt you to inherit the credentials from default or create a new set of credentials. A workspace credential is only required if the `use_default_credential` setting is set to False in the configuration of the corresponding workspace.
 
-# CLI Documentation# `bigeye configure`
+# CLI Documentation
+
+# `bigeye configure`
 
 Configuration Commands for Bigeye CLI
 
@@ -285,7 +307,6 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
 * `schedule-all-metrics`: Schedule all metrics in a workspace.
 * `unschedule-all-metrics`: Unschedule all metrics in a workspace.
 * `upsert-group`: Create or update a group.
-* `upsert-named-schedule`: Create a named, cron based schedule
 * `upsert-workspace`: Create or update a workspace.
 
 ## `bigeye workspace create-named-schedule`
@@ -512,25 +533,6 @@ $ bigeye workspace upsert-group [OPTIONS]
 * `-id, --group_id INTEGER`: Group ID.
 * `--help`: Show this message and exit.
 
-## `bigeye workspace upsert-named-schedule`
-
-Create a named, cron based schedule
-
-**Usage**:
-
-```console
-$ bigeye workspace upsert-named-schedule [OPTIONS]
-```
-
-**Options**:
-
-* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
-* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
-* `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-sn, --name TEXT`: The user defined name of the schedule  [required]
-* `-c, --cron TEXT`: The cron string to define the schedule  [required]
-* `--help`: Show this message and exit.
-
 ## `bigeye workspace upsert-workspace`
 
 Create or update a workspace.
@@ -642,7 +644,6 @@ $ bigeye bigconfig plan [OPTIONS]
 * `-nq, --no_queue`: Don't submit to queue: True or False.
 * `-r, --recursive`: Search all input directories recursively.
 * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
-* `-cicd, --cicd_report`: Add the report to a pull request. (Github only)
 * `--help`: Show this message and exit.
 
 # `bigeye catalog`
@@ -682,7 +683,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
 * `run-metrics`: Runs metrics by warehouse id, schema...
 * `schedule-all-metrics`: Updates schedule for all metrics in a...
 * `set-metric-time`: Sets metric times from a list of possible...
-* `track-schema-changes`: Track schema changes for sources on demand...
 * `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
 * `unset-metric-time`: Unsets metric times for whole warehouse or...
 * `upsert-template`: Create or update a template for a source.
@@ -770,7 +770,7 @@ $ bigeye catalog delete-metrics [OPTIONS]
 * `-wid, --warehouse_id INTEGER`: Warehouse ID
 * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
 * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
-* `-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, VOLUME_DATA, COUNT_VALUE_IN_LIST
+* `-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, VOLUME_DATA
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog delete-source`
@@ -1093,32 +1093,6 @@ $ bigeye catalog set-metric-time [OPTIONS]
 * `-r, --replace`: replace metric times if already present on tables?  Default is false.
 * `--help`: Show this message and exit.
 
-## `bigeye catalog track-schema-changes`
-
-Track schema changes for sources on demand or every n hour(s) and notify specified channels.
-Environment variables SMTP_USER and SMTP_PASSWORD MUST be set if using email notification.
-
-**Usage**:
-
-```console
-$ bigeye catalog track-schema-changes [OPTIONS]
-```
-
-**Options**:
-
-* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
-* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
-* `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-src, --source TEXT`: A list of source names to track. (None will track changes from all sources)
-* `-s, --since TEXT`: Track schema changes from this date. (Formatted as yyyy-MM-dd)  [default: 1970-01-01]
-* `-f, --frequency INTEGER`: Every n hours to check for schema changes. (None will only run the check once)  [default: 0]
-* `-ct, --change_type [CREATED|DELETED|TYPE_CHANGED]`: The types of changes to track; i.e additions, changes, deletions. (None will track all types)  [default: DELETED, CREATED, TYPE_CHANGED]
-* `-nc, --channel TEXT`: A list of notification channels; e.g. -nc email@mydomain.com -nc #slack_channel -nc https://www.webhook.com
-* `-smtp, --server TEXT`: The server to send emails.
-* `-p, --port INTEGER`: The server port to send emails.  [default: 587]
-* `-t, --token TEXT`: The token to utilize the Slack web client. (Will attempt to use environment variable SLACK_BOT_TOKEN, if not set)
-* `--help`: Show this message and exit.
-
 ## `bigeye catalog unschedule-all-metrics`
 
 Unschedule all metrics by warehouse, schema or tables.
@@ -1173,13 +1147,12 @@ $ bigeye catalog upsert-template [OPTIONS]
 * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
 * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-sn, --source_name TEXT`: The name of the source where the template will be defined
-* `-tn, --name TEXT`: The user defined name of the template
-* `-tb, --body TEXT`: The string to define the template
-* `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN
-* `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING
+* `-sn, --source_name TEXT`: The name of the source where the template will be defined  [required]
+* `-tn, --name TEXT`: The user defined name of the template  [required]
+* `-tb, --body TEXT`: The string to define the template  [required]
+* `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN  [required]
+* `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING  [required]
 * `-id, --template_id INTEGER`: The template ID (Only required when updating a template).  [default: 0]
-* `-tf, --template_file TEXT`: A file containing a template definition.
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog upsert-virtual-table`
@@ -1537,7 +1510,7 @@ $ bigeye deltas suggest-deltas [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-source, --source_selector TEXT`: The pattern of tables in the source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.  [required]
 * `-target, --target_selector TEXT`: The pattern of tables in the target to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.  [required]
-* `-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: strict]
+* `-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]
 * `-op, --output_path TEXT`: File to write the delta configuration.  [required]
 * `--help`: Show this message and exit.
 
@@ -1804,6 +1777,7 @@ $ bigeye lineage infer-relations [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-upstream, --upstream_selector TEXT`: The pattern of tables in the upstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.
 * `-downstream, --downstream_selector TEXT`: The pattern of tables in the downstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.
-* `-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: strict]
+* `-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]
 * `--help`: Show this message and exit.
 
+

bigeye_cli-0.3.61/PKG-INFO → bigeye_cli-0.3.62/bigeye_cli/CLI_DOCS.md

@@ -1,26 +1,5 @@
-Metadata-Version: 2.1
-Name: bigeye-cli
-Version: 0.3.61
-Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
-Home-page: https://docs.bigeye.com/docs
-License: Proprietary
-Author: Bigeye
-Author-email: support@bigeye.com
-Requires-Python: >=3.9.0,<4.0.0
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: PyGithub (>=1.57,<2.0)
-Requires-Dist: bigeye-sdk (>=0.4.81,<0.5.0)
-Requires-Dist: click (>=8.0.4,<9.0.0)
-Requires-Dist: rich (>=12.4.4,<13.0.0)
-Description-Content-Type: text/markdown
-
 # **Bigeye CLI**
-Version: 0.3.61
+Version: 0.3.55
 ## Installation
 
 **Setting up your local/build environment**  
@@ -192,7 +171,9 @@ password = fakepassword1234
 
 **Note:** Most use cases will only require you to have a single `DEFAULT` credential that all workspaces can utilize. Running the `bigeye configure -w <workspace-name>` command for a non-default workspace will prompt you to inherit the credentials from default or create a new set of credentials. A workspace credential is only required if the `use_default_credential` setting is set to False in the configuration of the corresponding workspace.
 
-# CLI Documentation# `bigeye configure`
+# CLI Documentation
+
+# `bigeye configure`
 
 Configuration Commands for Bigeye CLI
 
@@ -306,7 +287,6 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
 * `schedule-all-metrics`: Schedule all metrics in a workspace.
 * `unschedule-all-metrics`: Unschedule all metrics in a workspace.
 * `upsert-group`: Create or update a group.
-* `upsert-named-schedule`: Create a named, cron based schedule
 * `upsert-workspace`: Create or update a workspace.
 
 ## `bigeye workspace create-named-schedule`
@@ -533,25 +513,6 @@ $ bigeye workspace upsert-group [OPTIONS]
 * `-id, --group_id INTEGER`: Group ID.
 * `--help`: Show this message and exit.
 
-## `bigeye workspace upsert-named-schedule`
-
-Create a named, cron based schedule
-
-**Usage**:
-
-```console
-$ bigeye workspace upsert-named-schedule [OPTIONS]
-```
-
-**Options**:
-
-* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
-* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
-* `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-sn, --name TEXT`: The user defined name of the schedule  [required]
-* `-c, --cron TEXT`: The cron string to define the schedule  [required]
-* `--help`: Show this message and exit.
-
 ## `bigeye workspace upsert-workspace`
 
 Create or update a workspace.
@@ -663,7 +624,6 @@ $ bigeye bigconfig plan [OPTIONS]
 * `-nq, --no_queue`: Don't submit to queue: True or False.
 * `-r, --recursive`: Search all input directories recursively.
 * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
-* `-cicd, --cicd_report`: Add the report to a pull request. (Github only)
 * `--help`: Show this message and exit.
 
 # `bigeye catalog`
@@ -703,7 +663,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
 * `run-metrics`: Runs metrics by warehouse id, schema...
 * `schedule-all-metrics`: Updates schedule for all metrics in a...
 * `set-metric-time`: Sets metric times from a list of possible...
-* `track-schema-changes`: Track schema changes for sources on demand...
 * `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
 * `unset-metric-time`: Unsets metric times for whole warehouse or...
 * `upsert-template`: Create or update a template for a source.
@@ -791,7 +750,7 @@ $ bigeye catalog delete-metrics [OPTIONS]
 * `-wid, --warehouse_id INTEGER`: Warehouse ID
 * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
 * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
-* `-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, VOLUME_DATA, COUNT_VALUE_IN_LIST
+* `-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, VOLUME_DATA
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog delete-source`
@@ -1114,32 +1073,6 @@ $ bigeye catalog set-metric-time [OPTIONS]
 * `-r, --replace`: replace metric times if already present on tables?  Default is false.
 * `--help`: Show this message and exit.
 
-## `bigeye catalog track-schema-changes`
-
-Track schema changes for sources on demand or every n hour(s) and notify specified channels.
-Environment variables SMTP_USER and SMTP_PASSWORD MUST be set if using email notification.
-
-**Usage**:
-
-```console
-$ bigeye catalog track-schema-changes [OPTIONS]
-```
-
-**Options**:
-
-* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
-* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
-* `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-src, --source TEXT`: A list of source names to track. (None will track changes from all sources)
-* `-s, --since TEXT`: Track schema changes from this date. (Formatted as yyyy-MM-dd)  [default: 1970-01-01]
-* `-f, --frequency INTEGER`: Every n hours to check for schema changes. (None will only run the check once)  [default: 0]
-* `-ct, --change_type [CREATED|DELETED|TYPE_CHANGED]`: The types of changes to track; i.e additions, changes, deletions. (None will track all types)  [default: DELETED, CREATED, TYPE_CHANGED]
-* `-nc, --channel TEXT`: A list of notification channels; e.g. -nc email@mydomain.com -nc #slack_channel -nc https://www.webhook.com
-* `-smtp, --server TEXT`: The server to send emails.
-* `-p, --port INTEGER`: The server port to send emails.  [default: 587]
-* `-t, --token TEXT`: The token to utilize the Slack web client. (Will attempt to use environment variable SLACK_BOT_TOKEN, if not set)
-* `--help`: Show this message and exit.
-
 ## `bigeye catalog unschedule-all-metrics`
 
 Unschedule all metrics by warehouse, schema or tables.
@@ -1194,13 +1127,12 @@ $ bigeye catalog upsert-template [OPTIONS]
 * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
 * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-sn, --source_name TEXT`: The name of the source where the template will be defined
-* `-tn, --name TEXT`: The user defined name of the template
-* `-tb, --body TEXT`: The string to define the template
-* `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN
-* `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING
+* `-sn, --source_name TEXT`: The name of the source where the template will be defined  [required]
+* `-tn, --name TEXT`: The user defined name of the template  [required]
+* `-tb, --body TEXT`: The string to define the template  [required]
+* `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN  [required]
+* `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING  [required]
 * `-id, --template_id INTEGER`: The template ID (Only required when updating a template).  [default: 0]
-* `-tf, --template_file TEXT`: A file containing a template definition.
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog upsert-virtual-table`
@@ -1558,7 +1490,7 @@ $ bigeye deltas suggest-deltas [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-source, --source_selector TEXT`: The pattern of tables in the source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.  [required]
 * `-target, --target_selector TEXT`: The pattern of tables in the target to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.  [required]
-* `-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: strict]
+* `-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]
 * `-op, --output_path TEXT`: File to write the delta configuration.  [required]
 * `--help`: Show this message and exit.
 
@@ -1825,7 +1757,6 @@ $ bigeye lineage infer-relations [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-upstream, --upstream_selector TEXT`: The pattern of tables in the upstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.
 * `-downstream, --downstream_selector TEXT`: The pattern of tables in the downstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.
-* `-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: strict]
+* `-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]
 * `--help`: Show this message and exit.
 
-

{bigeye_cli-0.3.61 → bigeye_cli-0.3.62}/bigeye_cli/deltas/deltas_commands.py

@@ -14,7 +14,7 @@ from bigeye_cli.functions import cli_client_factory
 from bigeye_cli import global_options
 from bigeye_sdk.controller.delta_controller import DeltaController
 from bigeye_sdk.controller.lineage_controller import LineageController
-from bigeye_sdk.functions.delta_functions import infer_column_mappings
+from bigeye_sdk.functions.delta_functions import infer_column_mappings, build_ccm
 from bigeye_sdk.functions.table_functions import fully_qualified_table_to_elements
 from bigeye_sdk.generated.com.bigeye.models.generated import (
     Delta,
@@ -355,13 +355,32 @@ def cicd(
 
     log.info("Looking for existing Delta with same name.")
     client.delete_deltas_by_name(delta_names=[delta_cicd.delta_name])
+    if not delta_cicd.delta_column_mapping:
+        source_metrics_types = client.get_delta_applicable_metric_types(
+            table_id=source.id
+        ).metric_types
+        target_metric_types = client.get_delta_applicable_metric_types(
+            table_id=target.id
+        ).metric_types
+        column_mappings = infer_column_mappings(
+            source_metric_types=source_metrics_types,
+            target_metric_types=target_metric_types,
+        )
+    else:
+        column_mappings = [
+            build_ccm(scm=cm, source_table=source, target_table=target) for cm in delta_cicd.delta_column_mapping
+        ]
+
+
     comparisons = [
-        ComparisonTableConfiguration(name=delta_cicd.delta_name, source_table_id=source.id, target_table_id=target.id)
+        ComparisonTableConfiguration(name=delta_cicd.delta_name,
+                                     source_table_id=source.id,
+                                     target_table_id=target.id,
+                                     column_mappings=column_mappings)
     ]
 
     delta = Delta(
         name=delta_cicd.delta_name,
-        named_schedule=delta_cicd.cron_schedule.to_datawatch_object(),
         source_table=IdAndDisplayName(id=source.id, display_name=source.name),
         comparison_table_configurations=comparisons,
         notification_channels=[
@@ -372,10 +391,11 @@ def cicd(
     response = client.upsert_delta(delta=delta)
     delta_run = client.run_a_delta(delta_id=response.delta.id, await_results=True)
 
-    delta_info = client.get_delta_information(delta_ids=[delta_run.id])
+    delta_info = client.get_delta_info(delta_id=delta_run.id)
 
+    base_url = f"{client.get_base_url()}/w/{client.config.workspace_id}/deltas"
     exit_code = vendor_report.publish(
-        delta_cicd.fq_source_table_name, delta_cicd.fq_target_table_name, delta_info[0]
+            base_url, delta_cicd.fq_source_table_name, delta_cicd.fq_target_table_name, delta_info
     )
 
     if exit_code != 0 and delta_cicd.group_bys:
@@ -384,20 +404,21 @@ def cicd(
         group_by_name = f"{delta_cicd.delta_name} -- GROUPED BY {group_by_columns}"
         client.delete_deltas_by_name(delta_names=[group_by_name])
         group_bys = [gbc.to_datawatch_object() for gbc in delta_cicd.group_bys]
-        gb_response = client.create_delta(
-            name=group_by_name,
-            source_table_id=source.id,
-            target_table_id=target.id,
-            group_bys=group_bys,
-        )
+        gb_compare = comparisons[0]
+        gb_compare.group_bys = group_bys
+        delta.name = group_by_name
+        delta.comparison_table_configurations = [gb_compare]
+
 
-        client.run_a_delta(delta_id=gb_response.comparison_table_configuration.id)
-        delta_gb_run = client.get_delta_information(
-            delta_ids=[gb_response.comparison_table_configuration.id]
-        )[0]
+        gb_response = client.upsert_delta(delta=delta)
+        gb_delta_run = client.run_a_delta(delta_id=gb_response.delta.id, await_results=True)
+        delta_gb_run = client.get_delta_info(
+            delta_id=gb_delta_run.id
+        )
 
-        if delta_gb_run.alerting_metric_count != 0:
+        if delta_gb_run.delta.alerting_metric_count != 0 or delta_gb_run.delta.failed_metric_count != 0:
             vendor_report.publish_group_bys(
+                base_url,
                 delta_cicd.fq_source_table_name,
                 delta_cicd.fq_target_table_name,
                 delta_gb_run,

{bigeye_cli-0.3.61 → bigeye_cli-0.3.62}/bigeye_cli/lineage/lineage_commands.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, List
 
 import typer
 
@@ -9,7 +9,8 @@ from bigeye_cli import global_options
 from bigeye_sdk.controller.lineage_controller import LineageController
 from bigeye_sdk.model.enums import MatchType
 from bigeye_sdk.log import get_logger
-
+from bigeye_sdk.model.lineage_facade import LineageConfigurationFile, SimpleLineageConfigurationFile, \
+    LineageColumnOverride
 
 log = get_logger(__file__)
 
@@ -85,14 +86,34 @@ def create_relation(
             , "--downstream"
             , "-down"
             , help="The fully qualified table name"
+        ),
+        column_overrides: List[str] = typer.Option(
+            None
+            , "--column_overrides"
+            , "-co"
+            , help="The list of column overrides, formatted as upstream_column_name:downstream_column_name"
         )
 ):
     """Create a lineage relationship for 2 entities"""
     client = cli_client_factory(bigeye_conf, config_file, workspace)
     lineage_controller = LineageController(client)
-    r = lineage_controller.create_relation_from_name(upstream_table_name=upstream_table_name,
-                                                     downstream_table_name=downstream_table_name)
-    log.info(f"Relationship created:\n\tID: {r.id}\n\tupstream ID: {r.upstream.id}\n\tdownstream ID:{r.downstream.id}")
+
+    c_overrides: List[LineageColumnOverride] = []
+    if column_overrides is not None:
+        for co in column_overrides:
+            split_by_colon = co.split(":")
+            c_overrides.append(
+                LineageColumnOverride(
+                    upstream_column_name=split_by_colon[0],
+                    downstream_column_name=split_by_colon[1]
+                )
+            )
+
+    lineage_controller.create_edges_from_table_names(
+        upstream_table_name=upstream_table_name,
+        downstream_table_name=downstream_table_name,
+        column_overrides=c_overrides
+    )
 
 
 @app.command()
@@ -157,17 +178,40 @@ def infer_relations(
             , help="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."
             , case_sensitive=False
+        ),
+        lineage_configuration_file: str = typer.Option(
+            None,
+            "--lineage_conf",
+            "-lc",
+            help="The path to a Simple Lineage configuration file."
+        ),
+        purge_lineage: bool = typer.Option(
+            False,
+            "--purge_lineage",
+            "-purge",
+            help="Purge all lineage edges."
         )
 ):
     """Given an upstream and downstream path, infers lineage based on table/column names and creates the edges."""
     client = cli_client_factory(bigeye_conf, config_file, workspace)
     lineage_controller = LineageController(client)
 
-    # Get matching tables
-    matching_tables = lineage_controller.get_matching_tables_from_selectors(upstream_selector=upstream_selector,
-                                                                            downstream_selector=downstream_selector,
-                                                                            match_type=match_type)
+    if lineage_configuration_file:
+        lc = SimpleLineageConfigurationFile.load(lineage_configuration_file)
+        lineage_controller.infer_column_level_lineage_from_file(
+            lineage_configuration_file=lc,
+            purge_lineage=purge_lineage
+        )
 
-    log.info(f'Identified {len(matching_tables)} table relationships between upstream and downstream sources.')
+    else:
+        # Get matching tables
+        matching_tables = lineage_controller.get_matching_tables_from_selectors(upstream_selector=upstream_selector,
+                                                                                downstream_selector=downstream_selector,
+                                                                                match_type=match_type)
 
-    lineage_controller.infer_column_level_lineage_from_tables(matching_tables)
+        log.info(f'Identified {len(matching_tables)} table relationships between upstream and downstream sources.')
+
+        lineage_controller.infer_column_level_lineage_from_tables(
+            tables=matching_tables,
+            purge_lineage=purge_lineage
+        )

{bigeye_cli-0.3.61 → bigeye_cli-0.3.62}/bigeye_cli/model/github_report.py

@@ -7,7 +7,7 @@ from github.PullRequest import PullRequest
 from github.Repository import Repository
 
 from bigeye_sdk.log import get_logger
-from bigeye_sdk.generated.com.bigeye.models.generated import ComparisonTableInfo
+from bigeye_sdk.generated.com.bigeye.models.generated import DeltaInfo
 from bigeye_cli.model.vendor_report import (
     VendorReport,
     _format_report,
@@ -31,40 +31,44 @@ class GitHubReport(VendorReport):
         self.pr = self.repo.get_pull(int(os.environ["PR_NUMBER"]))
 
     def publish(
-        self, source_table_name: str, target_table_name: str, cti: ComparisonTableInfo
+        self, base_url: str, source_table_name: str, target_table_name: str, di: DeltaInfo
     ) -> int:
 
-        # NOTE: Do we want to add the ability to notify based on tolerance??
-        if cti.alerting_metric_count != 0:
+        dti = di.comparison_target_infos[0]
+        url = f"{base_url}/{di.delta.id}"
+        if dti.alerting_metric_count != 0 or dti.failed_metric_count != 0:
             log.info(
                 "Delta has alerting metrics. A grouped delta will run, if columns have been specified."
             )
             log.error("The process will exit as failed.")
-            report = _format_report(source_table_name, target_table_name, cti)
-            failure_title = f"Bigeye Delta failure for PR: {self.pr.title}"
-            self.issue = self.repo.create_issue(
-                title=failure_title, body=report, assignee=self.pr.user, labels=["bug"]
-            )
+            report = _format_report(url, source_table_name, target_table_name, dti)
+            body = f"Bigeye Delta failure for PR: {self.pr.title}\n\n{report}"
+            # self.issue = self.repo.create_issue(
+            #     title=failure_title, body=report, assignee=self.pr.user, labels=["bug"]
+            # )
+            self.pr.create_issue_comment(body=body)
             return 1
-        elif cti.schema_match is False:
-            question_title = f"Schema mismatch detected in delta. Is this expected?"
+        elif dti.schema_match is False:
+            question_title = f"## Schema mismatch detected in delta. Is this expected?"
             header = "#### Please confirm that the schemas are not supposed to match before approving Pull Request."
             tables = (
                 f"Source Table: {source_table_name}\nTarget Table: {target_table_name}"
             )
-            body = f"{header}\n{tables}"
+            body = f"{question_title}\n{header}\n{tables}"
 
-            self.repo.create_issue(title=question_title, body=body, labels=["question"])
+            self.pr.create_issue_comment(body=body)
             return 0
         else:
             return 0
 
     def publish_group_bys(
-        self, source_table_name: str, target_table_name: str, cti: ComparisonTableInfo
+        self, base_url: str, source_table_name: str, target_table_name: str, di: DeltaInfo
     ):
-
-        report = _format_group_report(source_table_name, target_table_name, cti)
-        self.issue.create_comment(report)
+        dti = di.comparison_target_infos[0]
+        group_bys = di.delta.comparison_table_configurations[0].group_bys
+        url = f"{base_url}/{di.delta.id}"
+        report = _format_group_report(url, source_table_name, target_table_name, dti, group_bys)
+        self.pr.create_issue_comment(body=report)
 
     def publish_bigconfig_plan(self, plan: str):
         self.pr.create_issue_comment(body=plan)

{bigeye_cli-0.3.61 → bigeye_cli-0.3.62}/bigeye_cli/model/vendor_report.py

@@ -2,9 +2,7 @@ import abc
 from typing import List
 
 from bigeye_sdk.generated.com.bigeye.models.generated import ComparisonMetricInfo, ComparisonMetricStatus, \
-    PredefinedMetricName, ComparisonTableInfo
-
-deltas_url = "https://app.bigeye.com/deltas"
+    PredefinedMetricName, DeltaTargetInfo, ColumnNamePair, Delta, DeltaInfo
 
 # TODO: This can all be dynamically generated. If we want to allow users to provide the desired fields.
 __delta_header = """|  metric_name   | source_column | target_column | source_value | target_value | difference |"""
@@ -52,12 +50,12 @@ def __format_delta_table(cmis: List[ComparisonMetricInfo]) -> str:
     return __collapsed_section.format(details=table)
 
 
-def _format_report(source_table: str, target_table: str, cti: ComparisonTableInfo):
-    link = f"[View Full Delta in Bigeye]({deltas_url}/{cti.comparison_table_configuration.id})"
-    schema_match = f"#### Source and Target schema match is {cti.schema_match}"
+def _format_report(deltas_url: str, source_table: str, target_table: str, dti: DeltaTargetInfo):
+    link = f"[View Full Delta in Bigeye]({deltas_url})"
+    schema_match = f"#### Source and Target schema match is {dti.schema_match}"
     table_names = f"Source Table: {source_table}\nTarget Table: {target_table}"
-    failed_metric_ratio = f"{cti.failed_metric_count} of {cti.metric_count} metrics have failed"
-    report = f"{table_names}\n{__format_delta_table(cti.comparison_metric_infos)}\n{failed_metric_ratio}"
+    failed_metric_ratio = f"{dti.failed_metric_count} of {dti.metric_count} metrics have failed"
+    report = f"{table_names}\n{__format_delta_table(dti.comparison_metric_infos)}\n{failed_metric_ratio}"
 
     return f"{report}\n{schema_match}\n{link}"
 
@@ -82,14 +80,14 @@ def __format_group_table(cmis: List[ComparisonMetricInfo]):
     return __collapsed_section.format(details=table)
 
 
-def _format_group_report(source_table: str, target_table: str, cti: ComparisonTableInfo):
+def _format_group_report(deltas_url: str, source_table: str, target_table: str, dti: DeltaTargetInfo, group_bys: List[ColumnNamePair]):
     title = "### Grouped Delta Summary"
     table_names = f"Source Table: {source_table}\nTarget Table: {target_table}"
     group_by_columns = "Grouped by: " + ", ".join(gb.source_column_name
-                                                  for gb in cti.comparison_table_configuration.group_bys)
-    table = "\n".join([__format_group_table(cti.comparison_metric_infos)])
-    failed_metric_ratio = f"{cti.failed_metric_count} of {cti.metric_count} metrics have failed"
-    link = f"[View Full Delta in Bigeye]({deltas_url}/{cti.comparison_table_configuration.id})"
+                                                  for gb in group_bys)
+    table = "\n".join([__format_group_table(dti.comparison_metric_infos)])
+    failed_metric_ratio = f"{dti.failed_metric_count} of {dti.metric_count} metrics have failed"
+    link = f"[View Full Delta in Bigeye]({deltas_url})"
 
     return f"{title}\n{table_names}\n\n{group_by_columns}\n{table}\n{failed_metric_ratio}\n{link}"
 
@@ -97,11 +95,11 @@ def _format_group_report(source_table: str, target_table: str, cti: ComparisonTa
 class VendorReport(abc.ABC):
 
     @abc.abstractmethod
-    def publish(self, source_table_name: str, target_table_name: str, cti: ComparisonTableInfo):
+    def publish(self, base_url: str, source_table_name: str, target_table_name: str, di: DeltaInfo):
         pass
 
     @abc.abstractmethod
-    def publish_group_bys(self, source_table_name: str, target_table_name: str, cti: ComparisonTableInfo):
+    def publish_group_bys(self, base_url: str, source_table_name: str, target_table_name: str, di: DeltaInfo):
         pass
 
     @abc.abstractmethod

{bigeye_cli-0.3.61 → bigeye_cli-0.3.62}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bigeye-cli"
-version = "0.3.61"
+version = "0.3.62"
 description = "Bigeye CLI offers developer tools for maintaining your developer workspace."
 license = "Proprietary"
 authors = ["Bigeye <support@bigeye.com>"]
@@ -19,7 +19,7 @@ bigeye = "bigeye_cli.__main__:app"
 [tool.poetry.dependencies]
 python = "^3.9.0"
 click = "^8.0.4"
-bigeye-sdk = "^0.4.81"
+bigeye-sdk = "^0.4.83"
 rich = "^12.4.4"
 PyGithub = '^1.57'
 
@@ -29,7 +29,7 @@ poethepoet = "^0.24.3"
 
 [tool.poe.tasks]
     pre_build = []
-    pre_publish = ["clean"]
+    pre_publish = ["clean", "docgen"]
     post_publish = ["clean"]
 
     [tool.poe.poetry_hooks]