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

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

@@ -1,5 +1,26 @@
+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.55
+Version: 0.3.61
 ## Installation
 
 **Setting up your local/build environment**  
@@ -171,9 +192,7 @@ 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
 
@@ -287,6 +306,7 @@ $ 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`
@@ -513,6 +533,25 @@ $ 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.
@@ -624,6 +663,7 @@ $ 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`
@@ -663,6 +703,7 @@ $ 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.
@@ -750,7 +791,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_DATE, FRESHNESS_DATA_TIMESTAMP, VOLUME_DATA
+* `-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
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog delete-source`
@@ -1073,6 +1114,32 @@ $ 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.
@@ -1127,12 +1194,13 @@ $ 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  [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]
+* `-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
 * `-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`
@@ -1490,7 +1558,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: MatchType.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: strict]
 * `-op, --output_path TEXT`: File to write the delta configuration.  [required]
 * `--help`: Show this message and exit.
 
@@ -1757,6 +1825,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: MatchType.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: strict]
 * `--help`: Show this message and exit.
 
+

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

@@ -1,26 +1,5 @@
-Metadata-Version: 2.1
-Name: bigeye-cli
-Version: 0.3.55
-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.75,<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.55
+Version: 0.3.61
 ## Installation
 
 **Setting up your local/build environment**  
@@ -192,9 +171,7 @@ 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
 
@@ -308,6 +285,7 @@ $ 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`
@@ -534,6 +512,25 @@ $ 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.
@@ -645,6 +642,7 @@ $ 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`
@@ -684,6 +682,7 @@ $ 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.
@@ -771,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_DATE, FRESHNESS_DATA_TIMESTAMP, VOLUME_DATA
+* `-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
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog delete-source`
@@ -1094,6 +1093,32 @@ $ 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.
@@ -1148,12 +1173,13 @@ $ 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  [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]
+* `-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
 * `-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`
@@ -1511,7 +1537,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: MatchType.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: strict]
 * `-op, --output_path TEXT`: File to write the delta configuration.  [required]
 * `--help`: Show this message and exit.
 
@@ -1778,7 +1804,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: MatchType.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: strict]
 * `--help`: Show this message and exit.
 
-

{bigeye_cli-0.3.55 → bigeye_cli-0.3.61}/bigeye_cli/__main__.py

@@ -6,6 +6,8 @@ import bigeye_cli.__version__ as bigeye_cli_version
 import bigeye_sdk.__version__ as bigeye_sdk_version
 
 from bigeye_cli.functions import print_markdown
+from bigeye_sdk.authentication.config import Config, WorkspaceConfig
+from bigeye_sdk.functions.version import check_package_for_updates
 from bigeye_sdk.log import get_logger
 
 from bigeye_cli import CLI_DOCS_MD
@@ -37,6 +39,29 @@ app.add_typer(lineage_commands.app, name='lineage')
 app.add_typer(configure_commands.app, name='configure')
 
 
+def _check_cli_and_sdk_versions(config_file: str, workspace: str):
+    try:
+        config = Config.load_config(config_file)
+        workspace_config = WorkspaceConfig(**config[workspace])
+        check_package_for_updates(
+            pypi_package_name='bigeye-cli',
+            internal_package_name='Bigeye CLI',
+            installed_version=bigeye_cli_version.version,
+            auto_update_enabled=workspace_config.auto_update_enabled,
+            warning_message_disabled=workspace_config.disable_auto_update_message
+        )
+
+        check_package_for_updates(
+            pypi_package_name='bigeye-sdk',
+            internal_package_name='Bigeye SDK',
+            installed_version=bigeye_sdk_version.version,
+            auto_update_enabled=workspace_config.auto_update_enabled,
+            warning_message_disabled=workspace_config.disable_auto_update_message
+        )
+    except:
+        pass
+
+
 @app.callback(invoke_without_command=True)
 def options_callback(
         version: Optional[bool] = typer.Option(
@@ -44,8 +69,16 @@ def options_callback(
         readme: Optional[bool] = typer.Option(
             None, "--readme", help="Prints Readme."),
         verbose: Optional[bool] = typer.Option(
-            None, "--verbose", help="Enables full output.")
+            None, "--verbose", help="Enables full output."),
+        config_file: str = typer.Option(
+            None, "--config_file", "-c",
+            help="Bigeye CLI Configuration File Path", envvar='BIGEYE_API_CONFIG_FILE'),
+        workspace: str = typer.Option(
+            'DEFAULT', "--workspace", "-w",
+            help="Name of the workspace configuration.", envvar='BIGEYE_WORKSPACE')
 ):
+    _check_cli_and_sdk_versions(config_file, workspace)
+
     if version:
         typer.echo(f'Bigeye CLI Version: {bigeye_cli_version.version}\n'
                    f'Bigeye SDK Version: {bigeye_sdk_version.version}')

bigeye_cli-0.3.61/bigeye_cli/bigconfig/bigconfig_commands.py

@@ -0,0 +1,198 @@
+import os
+from pathlib import Path
+from typing import Optional, List
+
+import typer
+
+from bigeye_cli.functions import cli_client_factory
+from bigeye_cli import global_options
+from bigeye_cli.bigconfig import bigconfig_options
+from bigeye_cli.model.github_report import GitHubReport
+from bigeye_sdk.controller.metric_controller import MetricController
+from bigeye_sdk.controller.metric_suite_controller import MetricSuiteController
+from bigeye_sdk.generated.com.bigeye.models.generated import MetricInfoList
+from bigeye_sdk.model.protobuf_message_facade import SimpleCollection
+from bigeye_sdk.log import get_logger
+
+log = get_logger(__file__)
+
+app = typer.Typer(no_args_is_help=True, help="Bigconfig Commands for Bigeye CLI")
+
+"""
+File should contain commands relating to deploying Bigconfig files.
+"""
+
+
+@app.command()
+def plan(
+    bigeye_conf: str = global_options.bigeye_conf,
+    config_file: str = global_options.config_file,
+    workspace: str = global_options.workspace,
+    input_path: Optional[List[str]] = bigconfig_options.input_path,
+    output_path: str = bigconfig_options.output_path,
+    purge_source_names: Optional[List[str]] = bigconfig_options.purge_source_names,
+    purge_all_sources: bool = bigconfig_options.purge_all_sources,
+    no_queue: bool = bigconfig_options.no_queue,
+    recursive: bool = bigconfig_options.recursive,
+    strict_mode: bool = bigconfig_options.strict_mode,
+    cicd: bool = typer.Option(
+        False,
+        "--cicd_report",
+        "-cicd",
+        help="Add the report to a pull request. (Github only)",
+    ),
+):
+    """Executes a plan for purging sources or processing bigconfig files in the input path/current
+    working directory."""
+
+    client = cli_client_factory(bigeye_conf, config_file, workspace)
+    mc = MetricSuiteController(client=client)
+
+    # Resolve args to first true or first non None values
+    if not input_path:
+        input_path = client.config.bigconfig_input_path or [Path.cwd()]
+    if not output_path:
+        output_path = client.config.bigconfig_output_path or Path.cwd()
+    strict_mode = strict_mode or client.config.bigconfig_strict_mode
+
+    if purge_source_names or purge_all_sources:
+        report = mc.execute_purge(
+            purge_source_names=purge_source_names,
+            purge_all_sources=purge_all_sources,
+            output_path=output_path,
+            apply=False,
+        )
+    else:
+        report = mc.execute_bigconfig(
+            input_path=input_path,
+            output_path=output_path,
+            apply=False,
+            recursive=recursive,
+            no_queue=no_queue,
+            strict_mode=strict_mode,
+        )
+    if cicd:
+        gh_report = GitHubReport(github_token=os.environ["GITHUB_TOKEN"])
+        gh_report.publish_bigconfig_plan(plan=report)
+
+
+@app.command()
+def apply(
+    bigeye_conf: str = global_options.bigeye_conf,
+    config_file: str = global_options.config_file,
+    workspace: str = global_options.workspace,
+    input_path: Optional[List[str]] = bigconfig_options.input_path,
+    output_path: str = bigconfig_options.output_path,
+    purge_source_names: Optional[List[str]] = bigconfig_options.purge_source_names,
+    purge_all_sources: bool = bigconfig_options.purge_all_sources,
+    no_queue: bool = bigconfig_options.no_queue,
+    recursive: bool = bigconfig_options.recursive,
+    strict_mode: bool = bigconfig_options.strict_mode,
+    auto_approve: bool = bigconfig_options.auto_approve,
+):
+    """Applies a purge of deployed metrics or applies Bigconfig files from the input path/current working directory to
+    the Bigeye workspace."""
+
+    client = cli_client_factory(bigeye_conf, config_file, workspace)
+    mc = MetricSuiteController(client=client)
+
+    # Resolve args to first true or first non None values
+    if not input_path:
+        input_path = client.config.bigconfig_input_path or [Path.cwd()]
+    if not output_path:
+        output_path = client.config.bigconfig_output_path or Path.cwd()
+    strict_mode = strict_mode or client.config.bigconfig_strict_mode
+    auto_approve = auto_approve or client.config.bigconfig_auto_approve
+
+    if purge_source_names or purge_all_sources:
+        mc.execute_purge(
+            purge_source_names=purge_source_names,
+            purge_all_sources=purge_all_sources,
+            output_path=output_path,
+            apply=True,
+        )
+    else:
+        mc.execute_bigconfig(
+            input_path=input_path,
+            output_path=output_path,
+            apply=True,
+            no_queue=no_queue,
+            recursive=recursive,
+            strict_mode=strict_mode,
+            auto_approve=auto_approve,
+        )
+
+
+@app.command()
+def export(
+    bigeye_conf: str = global_options.bigeye_conf,
+    config_file: str = global_options.config_file,
+    workspace: str = global_options.workspace,
+    output_path: str = bigconfig_options.output_path,
+    collection_id: int = typer.Option(
+        None, "--collection_id", "-cid", help="Collection ID of metrics to be exported."
+    ),
+    table_id: int = typer.Option(
+        None, "--table_id", "-tid", help="Table ID of metrics to be exported."
+    ),
+    metric_ids: List[int] = typer.Option(
+        None, "--metric_id", "-mid", help="Metric ID of metrics to be exported."
+    ),
+):
+    """Exports existing metrics into a valid Bigconfig file."""
+
+    client = cli_client_factory(bigeye_conf, config_file, workspace)
+    mc = MetricController(client=client)
+    collection: SimpleCollection = SimpleCollection(
+        name="Sample", description="SDK Generated"
+    )
+
+    # Require at least 1 option to be specified
+    if not collection_id and not table_id and not metric_ids:
+        raise typer.BadParameter(
+            "At least 1 option must be provided for bigconfig export. Please provide the "
+            "collection id (-cid), table id (-tid), or list of metric ids (-mid). "
+        )
+
+    # Get existing collection if passed
+    if collection_id:
+        collection: SimpleCollection = SimpleCollection.from_datawatch_object(
+            client.get_collection(collection_id=collection_id).collection
+        )
+        metric_ids.extend(collection.metric_ids)
+
+    # Get metrics from table if passed
+    if table_id:
+        metrics_from_table = client.get_metric_info_batch_post(
+            table_ids=[table_id]
+        ).metrics
+        metric_ids.extend([m.metric_configuration.id for m in metrics_from_table])
+        if not metrics_from_table:
+            raise typer.BadParameter(
+                f"No metrics found for given table id. Please check arguments and try again."
+            )
+        if not collection_id:
+            collection.name = metrics_from_table[0].metric_metadata.dataset_name
+
+    # Pull metric information
+    metrics: MetricInfoList = client.get_metric_info_batch_post(metric_ids=metric_ids)
+
+    if not output_path:
+        output_path = client.config.bigconfig_output_path or Path.cwd()
+
+    if not metrics.metrics:
+        raise typer.BadParameter(
+            "No metrics found for given arguments. Please check again."
+        )
+
+    bigconfig = mc.metric_info_to_bigconfig(metric_info=metrics, collection=collection)
+
+    file_name = collection.name.lower().replace(" ", "_")
+    output = bigconfig.save(
+        output_path=output_path,
+        default_file_name=f"{file_name}.bigconfig",
+        custom_formatter=bigconfig.format_bigconfig_export,
+    )
+    typer.secho(
+        f"\nSample bigconfig file generated at: {output}\n", fg="green", bold=True
+    )