bigeye-cli 0.3.65__tar.gz → 0.3.66__tar.gz

{bigeye_cli-0.3.65 → bigeye_cli-0.3.66}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bigeye-cli
-Version: 0.3.65
+Version: 0.3.66
 Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
 Home-page: https://docs.bigeye.com/docs
 License: Proprietary
@@ -19,7 +19,7 @@ Requires-Dist: rich (>=12.4.4,<13.0.0)
 Description-Content-Type: text/markdown
 
 # **Bigeye CLI**
-Version: 0.3.65
+Version: 0.3.66
 ## Installation
 
 **Setting up your local/build environment**  
@@ -298,11 +298,12 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
 * `delete-workspace`: Delete a workspace.
 * `edit-group-access`: Edit the workspaces that a group can access.
 * `edit-user`: Edit an existing user's access to groups.
+* `export-named-schedule`: Export cron schedule to yaml file
 * `invite-user`: Invite a user to a workspace.
 * `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-named-schedule`: Create a named, cron based schedule.
 * `upsert-workspace`: Create or update a workspace.
 
 ## `bigeye workspace create-named-schedule`
@@ -446,6 +447,25 @@ GROUP_USER_OPERATION_ADD:1
 GROUP_USER_OPERATION_REMOVE:2  [default: 1]
 * `--help`: Show this message and exit.
 
+## `bigeye workspace export-named-schedule`
+
+Export cron schedule to yaml file
+
+**Usage**:
+
+```console
+$ bigeye workspace export-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 name of the schedule(s) to export. None means all
+* `-op, --output_path TEXT`: Path to output files. None means current directory
+* `--help`: Show this message and exit.
+
 ## `bigeye workspace invite-user`
 
 Invite a user to a workspace.
@@ -531,7 +551,7 @@ $ bigeye workspace upsert-group [OPTIONS]
 
 ## `bigeye workspace upsert-named-schedule`
 
-Create a named, cron based schedule
+Create a named, cron based schedule. Files have priority over arguments
 
 **Usage**:
 
@@ -544,8 +564,9 @@ $ bigeye workspace upsert-named-schedule [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]
+* `-sn, --name TEXT`: The user defined name of the schedule
+* `-c, --cron TEXT`: The cron string to define the schedule
+* `-sf, --schedule_file TEXT`: A yaml file containing a schedule definition.
 * `--help`: Show this message and exit.
 
 ## `bigeye workspace upsert-workspace`
@@ -687,6 +708,8 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
 * `delete-source`: Delete a source from specified Bigeye...
 * `delete-template`: Delete a template.
 * `delete-virtual-table`: Delete a virtual table.
+* `export-metric-template`: Export metric templates to yaml files
+* `export-virtual-table`: Export virtual table to yaml file
 * `get-all-metric-templates`: Retrieve all metric templates and output...
 * `get-metric-info`: Outputs metric info to a file.
 * `get-metric-queries`: Gets the debug queries for all metrics by...
@@ -841,7 +864,45 @@ $ bigeye catalog delete-virtual-table [OPTIONS]
 * `-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]
 * `-vtn, --table_name TEXT`: The name of the virtual table  [required]
-* `-sn, --source_name TEXT`: The name of the source where the template will be defined  [required]
+* `-sn, --source_name TEXT`: The name of the source that contains the virtual table  [required]
+* `--help`: Show this message and exit.
+
+## `bigeye catalog export-metric-template`
+
+Export metric templates to yaml files
+
+**Usage**:
+
+```console
+$ bigeye catalog export-metric-template [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]
+* `-tn, --name TEXT`: The name of the template(s) to export. None means all
+* `-op, --output_path TEXT`: Path to output files. None means current directory
+* `--help`: Show this message and exit.
+
+## `bigeye catalog export-virtual-table`
+
+Export virtual table to yaml file
+
+**Usage**:
+
+```console
+$ bigeye catalog export-virtual-table [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]
+* `-vtn, --name TEXT`: The name of the virtual table(s) to export. None means all
+* `-op, --output_path TEXT`: Path to output files. None means current directory
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog get-all-metric-templates`
@@ -1153,7 +1214,7 @@ $ bigeye catalog unset-metric-time [OPTIONS]
 
 ## `bigeye catalog upsert-template`
 
-Create or update a template for a source.
+Create or update a template for a source. Files have priority over arguments
 
 **Usage**:
 
@@ -1171,13 +1232,12 @@ $ bigeye catalog upsert-template [OPTIONS]
 * `-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`
 
-Create or update a virtual table.
+Create or update a virtual table. Files have priority over arguments
 
 **Usage**:
 
@@ -1190,10 +1250,11 @@ $ bigeye catalog upsert-virtual-table [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]
-* `-vtn, --table_name TEXT`: The name of the virtual table  [required]
-* `-s, --sql TEXT`: The SQL to define the table  [required]
-* `-sn, --source_name TEXT`: The name of the source where the virtual table will be defined  [required]
+* `-vtn, --table_name TEXT`: The name of the virtual table
+* `-s, --sql TEXT`: The SQL to define the table
+* `-sn, --source_name TEXT`: The name of the source where the virtual table will be defined
 * `-u, --update`: Create if false. Update if true.
+* `-tf, --table_file TEXT`: A yaml file containing a template definition.
 * `--help`: Show this message and exit.
 
 # `bigeye metric`

{bigeye_cli-0.3.65 → bigeye_cli-0.3.66}/bigeye_cli/CLI_DOCS.md

@@ -1,5 +1,5 @@
 # **Bigeye CLI**
-Version: 0.3.65
+Version: 0.3.66
 ## Installation
 
 **Setting up your local/build environment**  
@@ -278,11 +278,12 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
 * `delete-workspace`: Delete a workspace.
 * `edit-group-access`: Edit the workspaces that a group can access.
 * `edit-user`: Edit an existing user's access to groups.
+* `export-named-schedule`: Export cron schedule to yaml file
 * `invite-user`: Invite a user to a workspace.
 * `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-named-schedule`: Create a named, cron based schedule.
 * `upsert-workspace`: Create or update a workspace.
 
 ## `bigeye workspace create-named-schedule`
@@ -426,6 +427,25 @@ GROUP_USER_OPERATION_ADD:1
 GROUP_USER_OPERATION_REMOVE:2  [default: 1]
 * `--help`: Show this message and exit.
 
+## `bigeye workspace export-named-schedule`
+
+Export cron schedule to yaml file
+
+**Usage**:
+
+```console
+$ bigeye workspace export-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 name of the schedule(s) to export. None means all
+* `-op, --output_path TEXT`: Path to output files. None means current directory
+* `--help`: Show this message and exit.
+
 ## `bigeye workspace invite-user`
 
 Invite a user to a workspace.
@@ -511,7 +531,7 @@ $ bigeye workspace upsert-group [OPTIONS]
 
 ## `bigeye workspace upsert-named-schedule`
 
-Create a named, cron based schedule
+Create a named, cron based schedule. Files have priority over arguments
 
 **Usage**:
 
@@ -524,8 +544,9 @@ $ bigeye workspace upsert-named-schedule [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]
+* `-sn, --name TEXT`: The user defined name of the schedule
+* `-c, --cron TEXT`: The cron string to define the schedule
+* `-sf, --schedule_file TEXT`: A yaml file containing a schedule definition.
 * `--help`: Show this message and exit.
 
 ## `bigeye workspace upsert-workspace`
@@ -667,6 +688,8 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
 * `delete-source`: Delete a source from specified Bigeye...
 * `delete-template`: Delete a template.
 * `delete-virtual-table`: Delete a virtual table.
+* `export-metric-template`: Export metric templates to yaml files
+* `export-virtual-table`: Export virtual table to yaml file
 * `get-all-metric-templates`: Retrieve all metric templates and output...
 * `get-metric-info`: Outputs metric info to a file.
 * `get-metric-queries`: Gets the debug queries for all metrics by...
@@ -821,7 +844,45 @@ $ bigeye catalog delete-virtual-table [OPTIONS]
 * `-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]
 * `-vtn, --table_name TEXT`: The name of the virtual table  [required]
-* `-sn, --source_name TEXT`: The name of the source where the template will be defined  [required]
+* `-sn, --source_name TEXT`: The name of the source that contains the virtual table  [required]
+* `--help`: Show this message and exit.
+
+## `bigeye catalog export-metric-template`
+
+Export metric templates to yaml files
+
+**Usage**:
+
+```console
+$ bigeye catalog export-metric-template [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]
+* `-tn, --name TEXT`: The name of the template(s) to export. None means all
+* `-op, --output_path TEXT`: Path to output files. None means current directory
+* `--help`: Show this message and exit.
+
+## `bigeye catalog export-virtual-table`
+
+Export virtual table to yaml file
+
+**Usage**:
+
+```console
+$ bigeye catalog export-virtual-table [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]
+* `-vtn, --name TEXT`: The name of the virtual table(s) to export. None means all
+* `-op, --output_path TEXT`: Path to output files. None means current directory
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog get-all-metric-templates`
@@ -1133,7 +1194,7 @@ $ bigeye catalog unset-metric-time [OPTIONS]
 
 ## `bigeye catalog upsert-template`
 
-Create or update a template for a source.
+Create or update a template for a source. Files have priority over arguments
 
 **Usage**:
 
@@ -1151,13 +1212,12 @@ $ bigeye catalog upsert-template [OPTIONS]
 * `-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`
 
-Create or update a virtual table.
+Create or update a virtual table. Files have priority over arguments
 
 **Usage**:
 
@@ -1170,10 +1230,11 @@ $ bigeye catalog upsert-virtual-table [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]
-* `-vtn, --table_name TEXT`: The name of the virtual table  [required]
-* `-s, --sql TEXT`: The SQL to define the table  [required]
-* `-sn, --source_name TEXT`: The name of the source where the virtual table will be defined  [required]
+* `-vtn, --table_name TEXT`: The name of the virtual table
+* `-s, --sql TEXT`: The SQL to define the table
+* `-sn, --source_name TEXT`: The name of the source where the virtual table will be defined
 * `-u, --update`: Create if false. Update if true.
+* `-tf, --table_file TEXT`: A yaml file containing a template definition.
 * `--help`: Show this message and exit.
 
 # `bigeye metric`