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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/PKG-INFO +426 -425
  2. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/CLI_DOCS.md +425 -424
  3. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/bigconfig/bigconfig_commands.py +2 -1
  4. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/catalog/catalog_commands.py +29 -13
  5. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/model/github_report.py +19 -7
  6. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/model/vendor_report.py +2 -1
  7. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/workspace/workspace_commands.py +18 -23
  8. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/pyproject.toml +1 -1
  9. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/LICENSE +0 -0
  10. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/__init__.py +0 -0
  11. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/__main__.py +0 -0
  12. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/__version__.py +0 -0
  13. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/bigconfig/__init__.py +0 -0
  14. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/bigconfig/bigconfig_options.py +0 -0
  15. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/catalog/__init__.py +0 -0
  16. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/collections/__init__.py +0 -0
  17. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/collections/collection_commands.py +0 -0
  18. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/configure/__init__.py +0 -0
  19. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/configure/configure_commands.py +0 -0
  20. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/deltas/__init__.py +0 -0
  21. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/deltas/deltas_commands.py +0 -0
  22. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/enums.py +0 -0
  23. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/exceptions/__init__.py +0 -0
  24. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/exceptions/exceptions.py +0 -0
  25. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/functions.py +0 -0
  26. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/global_options.py +0 -0
  27. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/issues/__init__.py +0 -0
  28. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/issues/issue_commands.py +0 -0
  29. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/lineage/__init__.py +0 -0
  30. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/lineage/lineage_commands.py +0 -0
  31. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/metric/__init__.py +0 -0
  32. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/metric/metric_commands.py +0 -0
  33. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/model/__init__.py +0 -0
  34. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/model/cicd_conf.py +0 -0
  35. {bigeye_cli-0.3.66 → bigeye_cli-0.3.68}/bigeye_cli/workspace/__init__.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: bigeye-cli
3
- Version: 0.3.66
3
+ Version: 0.3.68
4
4
  Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
5
5
  Home-page: https://docs.bigeye.com/docs
6
6
  License: Proprietary
@@ -19,7 +19,7 @@ Requires-Dist: rich (>=12.4.4,<13.0.0)
19
19
  Description-Content-Type: text/markdown
20
20
 
21
21
  # **Bigeye CLI**
22
- Version: 0.3.66
22
+ Version: 0.3.68
23
23
  ## Installation
24
24
 
25
25
  **Setting up your local/build environment**
@@ -212,23 +212,24 @@ $ bigeye configure [OPTIONS] COMMAND [ARGS]...
212
212
 
213
213
  **Commands**:
214
214
 
215
+ * `set`: Set any specific configuration settings.
215
216
  * `get`: Get any specific configuration settings.
216
217
  * `list`: List all configured workspaces.
217
- * `set`: Set any specific configuration settings.
218
218
 
219
- ## `bigeye configure get`
219
+ ## `bigeye configure set`
220
220
 
221
- Get any specific configuration settings.
221
+ Set any specific configuration settings.
222
222
 
223
223
  **Usage**:
224
224
 
225
225
  ```console
226
- $ bigeye configure get [OPTIONS] [SETTING_KEY]
226
+ $ bigeye configure set [OPTIONS] [SETTING_KEY] [SETTING_VALUE]
227
227
  ```
228
228
 
229
229
  **Arguments**:
230
230
 
231
231
  * `[SETTING_KEY]`: The name of the configuration setting.
232
+ * `[SETTING_VALUE]`: The value of the configuration setting.
232
233
 
233
234
  **Options**:
234
235
 
@@ -236,41 +237,40 @@ $ bigeye configure get [OPTIONS] [SETTING_KEY]
236
237
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
237
238
  * `--help`: Show this message and exit.
238
239
 
239
- ## `bigeye configure list`
240
+ ## `bigeye configure get`
240
241
 
241
- List all configured workspaces.
242
+ Get any specific configuration settings.
242
243
 
243
244
  **Usage**:
244
245
 
245
246
  ```console
246
- $ bigeye configure list [OPTIONS]
247
+ $ bigeye configure get [OPTIONS] [SETTING_KEY]
247
248
  ```
248
249
 
250
+ **Arguments**:
251
+
252
+ * `[SETTING_KEY]`: The name of the configuration setting.
253
+
249
254
  **Options**:
250
255
 
251
- * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
252
256
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
257
+ * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
253
258
  * `--help`: Show this message and exit.
254
259
 
255
- ## `bigeye configure set`
260
+ ## `bigeye configure list`
256
261
 
257
- Set any specific configuration settings.
262
+ List all configured workspaces.
258
263
 
259
264
  **Usage**:
260
265
 
261
266
  ```console
262
- $ bigeye configure set [OPTIONS] [SETTING_KEY] [SETTING_VALUE]
267
+ $ bigeye configure list [OPTIONS]
263
268
  ```
264
269
 
265
- **Arguments**:
266
-
267
- * `[SETTING_KEY]`: The name of the configuration setting.
268
- * `[SETTING_VALUE]`: The value of the configuration setting.
269
-
270
270
  **Options**:
271
271
 
272
+ * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
272
273
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
273
- * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
274
274
  * `--help`: Show this message and exit.
275
275
 
276
276
  # `bigeye workspace`
@@ -291,29 +291,29 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
291
291
 
292
292
  **Commands**:
293
293
 
294
+ * `unschedule-all-metrics`: Unschedule all metrics in a workspace.
295
+ * `schedule-all-metrics`: Schedule all metrics in a workspace.
294
296
  * `create-named-schedule`: Create a named, cron based schedule
295
- * `delete-group`: Delete a group.
297
+ * `upsert-named-schedule`: Create a named, cron based schedule.
296
298
  * `delete-named-schedule`: Delete a named schedule.
297
- * `delete-user`: Deletes a users account.
298
- * `delete-workspace`: Delete a workspace.
299
- * `edit-group-access`: Edit the workspaces that a group can access.
300
- * `edit-user`: Edit an existing user's access to groups.
301
299
  * `export-named-schedule`: Export cron schedule to yaml file
302
300
  * `invite-user`: Invite a user to a workspace.
303
- * `schedule-all-metrics`: Schedule all metrics in a workspace.
304
- * `unschedule-all-metrics`: Unschedule all metrics in a workspace.
305
- * `upsert-group`: Create or update a group.
306
- * `upsert-named-schedule`: Create a named, cron based schedule.
301
+ * `edit-user`: Edit an existing user&#x27;s access to groups.
302
+ * `delete-user`: Deletes a users account.
307
303
  * `upsert-workspace`: Create or update a workspace.
304
+ * `delete-workspace`: Delete a workspace.
305
+ * `upsert-group`: Create or update a group.
306
+ * `edit-group-access`: Edit the workspaces that a group can access.
307
+ * `delete-group`: Delete a group.
308
308
 
309
- ## `bigeye workspace create-named-schedule`
309
+ ## `bigeye workspace unschedule-all-metrics`
310
310
 
311
- Create a named, cron based schedule
311
+ Unschedule all metrics in a workspace.
312
312
 
313
313
  **Usage**:
314
314
 
315
315
  ```console
316
- $ bigeye workspace create-named-schedule [OPTIONS]
316
+ $ bigeye workspace unschedule-all-metrics [OPTIONS]
317
317
  ```
318
318
 
319
319
  **Options**:
@@ -321,18 +321,16 @@ $ bigeye workspace create-named-schedule [OPTIONS]
321
321
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
322
322
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
323
323
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
324
- * `-sn, --name TEXT`: The user defined name of the schedule [required]
325
- * `-c, --cron TEXT`: The cron string to define the schedule [required]
326
324
  * `--help`: Show this message and exit.
327
325
 
328
- ## `bigeye workspace delete-group`
326
+ ## `bigeye workspace schedule-all-metrics`
329
327
 
330
- Delete a group.
328
+ Schedule all metrics in a workspace.
331
329
 
332
330
  **Usage**:
333
331
 
334
332
  ```console
335
- $ bigeye workspace delete-group [OPTIONS]
333
+ $ bigeye workspace schedule-all-metrics [OPTIONS]
336
334
  ```
337
335
 
338
336
  **Options**:
@@ -340,17 +338,26 @@ $ bigeye workspace delete-group [OPTIONS]
340
338
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
341
339
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
342
340
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
343
- * `-name, --group_name TEXT`: Group name. [required]
341
+ * `-type, --time_interval_type INTEGER`: Time interval type.
342
+ UNDEFINED_TIME_INTERVAL_TYPE:0
343
+ HOURS_TIME_INTERVAL_TYPE:1
344
+ MINUTES_TIME_INTERVAL_TYPE:2
345
+ SECONDS_TIME_INTERVAL_TYPE:3
346
+ DAYS_TIME_INTERVAL_TYPE:4
347
+ WEEKDAYS_TIME_INTERVAL_TYPE:5
348
+ MARKET_DAYS_TIME_INTERVAL_TYPE:6
349
+ MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
350
+ * `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
344
351
  * `--help`: Show this message and exit.
345
352
 
346
- ## `bigeye workspace delete-named-schedule`
353
+ ## `bigeye workspace create-named-schedule`
347
354
 
348
- Delete a named schedule.
355
+ Create a named, cron based schedule
349
356
 
350
357
  **Usage**:
351
358
 
352
359
  ```console
353
- $ bigeye workspace delete-named-schedule [OPTIONS]
360
+ $ bigeye workspace create-named-schedule [OPTIONS]
354
361
  ```
355
362
 
356
363
  **Options**:
@@ -359,16 +366,17 @@ $ bigeye workspace delete-named-schedule [OPTIONS]
359
366
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
360
367
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
361
368
  * `-sn, --name TEXT`: The user defined name of the schedule [required]
369
+ * `-c, --cron TEXT`: The cron string to define the schedule [required]
362
370
  * `--help`: Show this message and exit.
363
371
 
364
- ## `bigeye workspace delete-user`
372
+ ## `bigeye workspace upsert-named-schedule`
365
373
 
366
- Deletes a users account.
374
+ Create a named, cron based schedule. Files have priority over arguments
367
375
 
368
376
  **Usage**:
369
377
 
370
378
  ```console
371
- $ bigeye workspace delete-user [OPTIONS]
379
+ $ bigeye workspace upsert-named-schedule [OPTIONS]
372
380
  ```
373
381
 
374
382
  **Options**:
@@ -376,18 +384,19 @@ $ bigeye workspace delete-user [OPTIONS]
376
384
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
377
385
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
378
386
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
379
- * `-name, --user_name TEXT`: User name.
380
- * `-email, --user_email TEXT`: User email.
387
+ * `-sn, --name TEXT`: The user defined name of the schedule
388
+ * `-c, --cron TEXT`: The cron string to define the schedule
389
+ * `-sf, --schedule_file TEXT`: A yaml file containing a schedule definition.
381
390
  * `--help`: Show this message and exit.
382
391
 
383
- ## `bigeye workspace delete-workspace`
392
+ ## `bigeye workspace delete-named-schedule`
384
393
 
385
- Delete a workspace.
394
+ Delete a named schedule.
386
395
 
387
396
  **Usage**:
388
397
 
389
398
  ```console
390
- $ bigeye workspace delete-workspace [OPTIONS]
399
+ $ bigeye workspace delete-named-schedule [OPTIONS]
391
400
  ```
392
401
 
393
402
  **Options**:
@@ -395,17 +404,17 @@ $ bigeye workspace delete-workspace [OPTIONS]
395
404
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
396
405
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
397
406
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
398
- * `-name, --workspace_name TEXT`: Workspace name. [required]
407
+ * `-sn, --name TEXT`: The user defined name of the schedule [required]
399
408
  * `--help`: Show this message and exit.
400
409
 
401
- ## `bigeye workspace edit-group-access`
410
+ ## `bigeye workspace export-named-schedule`
402
411
 
403
- Edit the workspaces that a group can access.
412
+ Export cron schedule to yaml file
404
413
 
405
414
  **Usage**:
406
415
 
407
416
  ```console
408
- $ bigeye workspace edit-group-access [OPTIONS]
417
+ $ bigeye workspace export-named-schedule [OPTIONS]
409
418
  ```
410
419
 
411
420
  **Options**:
@@ -413,24 +422,18 @@ $ bigeye workspace edit-group-access [OPTIONS]
413
422
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
414
423
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
415
424
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
416
- * `-name, --group-name TEXT`: Group name. [required]
417
- * `-id, --group-id INTEGER`: Group ID.
418
- * `-wn, --workspace-name TEXT`: List of workspace names to edit access. E.g. -wn workspace1 -wn workspace2 [required]
419
- * `-access, --access-level TEXT`: The access this group should have to the workspaces provided. Must be either `Edit` or `Manage` [default: Edit]
420
- * `-op, --operation INTEGER`: Operation type.
421
- ROLE_OPERATION_UNSPECIFIED:0
422
- ROLE_OPERATION_GRANT:1
423
- ROLE_OPERATION_REVOKE:2 [default: 1]
425
+ * `-sn, --name TEXT`: The name of the schedule(s) to export. None means all
426
+ * `-op, --output_path TEXT`: Path to output files. None means current directory
424
427
  * `--help`: Show this message and exit.
425
428
 
426
- ## `bigeye workspace edit-user`
429
+ ## `bigeye workspace invite-user`
427
430
 
428
- Edit an existing user's access to groups.
431
+ Invite a user to a workspace.
429
432
 
430
433
  **Usage**:
431
434
 
432
435
  ```console
433
- $ bigeye workspace edit-user [OPTIONS]
436
+ $ bigeye workspace invite-user [OPTIONS]
434
437
  ```
435
438
 
436
439
  **Options**:
@@ -438,23 +441,19 @@ $ bigeye workspace edit-user [OPTIONS]
438
441
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
439
442
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
440
443
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
441
- * `-name, --user_name TEXT`: User name.
442
- * `-email, --user_email TEXT`: User email.
443
- * `-group, --group_name TEXT`: The names of the groups that should be edited for this users access. E.g. -group team1 -group team2 [required]
444
- * `-op, --operation INTEGER`: Operation type.
445
- GROUP_USER_OPERATION_UNSPECIFIED:0
446
- GROUP_USER_OPERATION_ADD:1
447
- GROUP_USER_OPERATION_REMOVE:2 [default: 1]
444
+ * `-name, --user_name TEXT`: User name. [required]
445
+ * `-email, --user_email TEXT`: Email where invite will be sent. [required]
446
+ * `-group, --group_name TEXT`: The names of the groups that the user should belong to. E.g. -group team1 -group team2
448
447
  * `--help`: Show this message and exit.
449
448
 
450
- ## `bigeye workspace export-named-schedule`
449
+ ## `bigeye workspace edit-user`
451
450
 
452
- Export cron schedule to yaml file
451
+ Edit an existing user&#x27;s access to groups.
453
452
 
454
453
  **Usage**:
455
454
 
456
455
  ```console
457
- $ bigeye workspace export-named-schedule [OPTIONS]
456
+ $ bigeye workspace edit-user [OPTIONS]
458
457
  ```
459
458
 
460
459
  **Options**:
@@ -462,18 +461,23 @@ $ bigeye workspace export-named-schedule [OPTIONS]
462
461
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
463
462
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
464
463
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
465
- * `-sn, --name TEXT`: The name of the schedule(s) to export. None means all
466
- * `-op, --output_path TEXT`: Path to output files. None means current directory
464
+ * `-name, --user_name TEXT`: User name.
465
+ * `-email, --user_email TEXT`: User email.
466
+ * `-group, --group_name TEXT`: The names of the groups that should be edited for this users access. E.g. -group team1 -group team2 [required]
467
+ * `-op, --operation INTEGER`: Operation type.
468
+ GROUP_USER_OPERATION_UNSPECIFIED:0
469
+ GROUP_USER_OPERATION_ADD:1
470
+ GROUP_USER_OPERATION_REMOVE:2 [default: 1]
467
471
  * `--help`: Show this message and exit.
468
472
 
469
- ## `bigeye workspace invite-user`
473
+ ## `bigeye workspace delete-user`
470
474
 
471
- Invite a user to a workspace.
475
+ Deletes a users account.
472
476
 
473
477
  **Usage**:
474
478
 
475
479
  ```console
476
- $ bigeye workspace invite-user [OPTIONS]
480
+ $ bigeye workspace delete-user [OPTIONS]
477
481
  ```
478
482
 
479
483
  **Options**:
@@ -481,19 +485,18 @@ $ bigeye workspace invite-user [OPTIONS]
481
485
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
482
486
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
483
487
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
484
- * `-name, --user_name TEXT`: User name. [required]
485
- * `-email, --user_email TEXT`: Email where invite will be sent. [required]
486
- * `-group, --group_name TEXT`: The names of the groups that the user should belong to. E.g. -group team1 -group team2
488
+ * `-name, --user_name TEXT`: User name.
489
+ * `-email, --user_email TEXT`: User email.
487
490
  * `--help`: Show this message and exit.
488
491
 
489
- ## `bigeye workspace schedule-all-metrics`
492
+ ## `bigeye workspace upsert-workspace`
490
493
 
491
- Schedule all metrics in a workspace.
494
+ Create or update a workspace.
492
495
 
493
496
  **Usage**:
494
497
 
495
498
  ```console
496
- $ bigeye workspace schedule-all-metrics [OPTIONS]
499
+ $ bigeye workspace upsert-workspace [OPTIONS]
497
500
  ```
498
501
 
499
502
  **Options**:
@@ -501,26 +504,18 @@ $ bigeye workspace schedule-all-metrics [OPTIONS]
501
504
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
502
505
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
503
506
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
504
- * `-type, --time_interval_type INTEGER`: Time interval type.
505
- UNDEFINED_TIME_INTERVAL_TYPE:0
506
- HOURS_TIME_INTERVAL_TYPE:1
507
- MINUTES_TIME_INTERVAL_TYPE:2
508
- SECONDS_TIME_INTERVAL_TYPE:3
509
- DAYS_TIME_INTERVAL_TYPE:4
510
- WEEKDAYS_TIME_INTERVAL_TYPE:5
511
- MARKET_DAYS_TIME_INTERVAL_TYPE:6
512
- MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
513
- * `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
507
+ * `-name, --workspace_name TEXT`: Workspace name. [required]
508
+ * `-id, --workspace_id INTEGER`: Workspace ID.
514
509
  * `--help`: Show this message and exit.
515
510
 
516
- ## `bigeye workspace unschedule-all-metrics`
511
+ ## `bigeye workspace delete-workspace`
517
512
 
518
- Unschedule all metrics in a workspace.
513
+ Delete a workspace.
519
514
 
520
515
  **Usage**:
521
516
 
522
517
  ```console
523
- $ bigeye workspace unschedule-all-metrics [OPTIONS]
518
+ $ bigeye workspace delete-workspace [OPTIONS]
524
519
  ```
525
520
 
526
521
  **Options**:
@@ -528,6 +523,7 @@ $ bigeye workspace unschedule-all-metrics [OPTIONS]
528
523
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
529
524
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
530
525
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
526
+ * `-name, --workspace_name TEXT`: Workspace name. [required]
531
527
  * `--help`: Show this message and exit.
532
528
 
533
529
  ## `bigeye workspace upsert-group`
@@ -549,14 +545,14 @@ $ bigeye workspace upsert-group [OPTIONS]
549
545
  * `-id, --group_id INTEGER`: Group ID.
550
546
  * `--help`: Show this message and exit.
551
547
 
552
- ## `bigeye workspace upsert-named-schedule`
548
+ ## `bigeye workspace edit-group-access`
553
549
 
554
- Create a named, cron based schedule. Files have priority over arguments
550
+ Edit the workspaces that a group can access.
555
551
 
556
552
  **Usage**:
557
553
 
558
554
  ```console
559
- $ bigeye workspace upsert-named-schedule [OPTIONS]
555
+ $ bigeye workspace edit-group-access [OPTIONS]
560
556
  ```
561
557
 
562
558
  **Options**:
@@ -564,19 +560,24 @@ $ bigeye workspace upsert-named-schedule [OPTIONS]
564
560
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
565
561
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
566
562
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
567
- * `-sn, --name TEXT`: The user defined name of the schedule
568
- * `-c, --cron TEXT`: The cron string to define the schedule
569
- * `-sf, --schedule_file TEXT`: A yaml file containing a schedule definition.
563
+ * `-name, --group-name TEXT`: Group name. [required]
564
+ * `-id, --group-id INTEGER`: Group ID.
565
+ * `-wn, --workspace-name TEXT`: List of workspace names to edit access. E.g. -wn workspace1 -wn workspace2 [required]
566
+ * `-access, --access-level TEXT`: The access this group should have to the workspaces provided. Must be `View`, `Edit`, or `Manage` [default: Edit]
567
+ * `-op, --operation INTEGER`: Operation type.
568
+ ROLE_OPERATION_UNSPECIFIED:0
569
+ ROLE_OPERATION_GRANT:1
570
+ ROLE_OPERATION_REVOKE:2 [default: 1]
570
571
  * `--help`: Show this message and exit.
571
572
 
572
- ## `bigeye workspace upsert-workspace`
573
+ ## `bigeye workspace delete-group`
573
574
 
574
- Create or update a workspace.
575
+ Delete a group.
575
576
 
576
577
  **Usage**:
577
578
 
578
579
  ```console
579
- $ bigeye workspace upsert-workspace [OPTIONS]
580
+ $ bigeye workspace delete-group [OPTIONS]
580
581
  ```
581
582
 
582
583
  **Options**:
@@ -584,8 +585,7 @@ $ bigeye workspace upsert-workspace [OPTIONS]
584
585
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
585
586
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
586
587
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
587
- * `-name, --workspace_name TEXT`: Workspace name. [required]
588
- * `-id, --workspace_id INTEGER`: Workspace ID.
588
+ * `-name, --group_name TEXT`: Group name. [required]
589
589
  * `--help`: Show this message and exit.
590
590
 
591
591
  # `bigeye bigconfig`
@@ -606,19 +606,19 @@ $ bigeye bigconfig [OPTIONS] COMMAND [ARGS]...
606
606
 
607
607
  **Commands**:
608
608
 
609
+ * `plan`: Executes a plan for purging sources or...
609
610
  * `apply`: Applies a purge of deployed metrics or...
610
611
  * `export`: Exports existing metrics into a valid...
611
- * `plan`: Executes a plan for purging sources or...
612
612
 
613
- ## `bigeye bigconfig apply`
613
+ ## `bigeye bigconfig plan`
614
614
 
615
- Applies a purge of deployed metrics or applies Bigconfig files from the input path/current working directory to
616
- the Bigeye workspace.
615
+ Executes a plan for purging sources or processing bigconfig files in the input path/current
616
+ working directory.
617
617
 
618
618
  **Usage**:
619
619
 
620
620
  ```console
621
- $ bigeye bigconfig apply [OPTIONS]
621
+ $ bigeye bigconfig plan [OPTIONS]
622
622
  ```
623
623
 
624
624
  **Options**:
@@ -630,20 +630,21 @@ $ bigeye bigconfig apply [OPTIONS]
630
630
  * `-op, --output_path TEXT`: Output path where reports and fixme files will be saved. If no output path is defined then current working directory will be used.
631
631
  * `-psn, --purge_source_name TEXT`: List of source names to purge E.g. -psn source_1 -psn source_2.
632
632
  * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
633
- * `-nq, --no_queue`: Don't submit to queue: True or False.
633
+ * `-nq, --no_queue`: Don&#x27;t submit to queue: True or False.
634
634
  * `-r, --recursive`: Search all input directories recursively.
635
635
  * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
636
- * `-auto_approve, --auto_approve`: Explicit plan approval is not needed prior to execution.
636
+ * `-cicd, --cicd_report`: Add the report to a pull request. (Github only)
637
637
  * `--help`: Show this message and exit.
638
638
 
639
- ## `bigeye bigconfig export`
639
+ ## `bigeye bigconfig apply`
640
640
 
641
- Exports existing metrics into a valid Bigconfig file.
641
+ Applies a purge of deployed metrics or applies Bigconfig files from the input path/current working directory to
642
+ the Bigeye workspace.
642
643
 
643
644
  **Usage**:
644
645
 
645
646
  ```console
646
- $ bigeye bigconfig export [OPTIONS]
647
+ $ bigeye bigconfig apply [OPTIONS]
647
648
  ```
648
649
 
649
650
  **Options**:
@@ -651,21 +652,24 @@ $ bigeye bigconfig export [OPTIONS]
651
652
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
652
653
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
653
654
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
655
+ * `-ip, --input_path TEXT`: List of paths containing Bigconfig files or pointing to a Bigconfig file. E.g. -ip path1 -ip path2. If no input path is defined then current working directory will be used.
654
656
  * `-op, --output_path TEXT`: Output path where reports and fixme files will be saved. If no output path is defined then current working directory will be used.
655
- * `-cid, --collection_id INTEGER`: Collection ID of metrics to be exported.
656
- * `-tid, --table_id INTEGER`: Table ID of metrics to be exported.
657
- * `-mid, --metric_id INTEGER`: Metric ID of metrics to be exported.
657
+ * `-psn, --purge_source_name TEXT`: List of source names to purge E.g. -psn source_1 -psn source_2.
658
+ * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
659
+ * `-nq, --no_queue`: Don&#x27;t submit to queue: True or False.
660
+ * `-r, --recursive`: Search all input directories recursively.
661
+ * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
662
+ * `-auto_approve, --auto_approve`: Explicit plan approval is not needed prior to execution.
658
663
  * `--help`: Show this message and exit.
659
664
 
660
- ## `bigeye bigconfig plan`
665
+ ## `bigeye bigconfig export`
661
666
 
662
- Executes a plan for purging sources or processing bigconfig files in the input path/current
663
- working directory.
667
+ Exports existing metrics into a valid Bigconfig file.
664
668
 
665
669
  **Usage**:
666
670
 
667
671
  ```console
668
- $ bigeye bigconfig plan [OPTIONS]
672
+ $ bigeye bigconfig export [OPTIONS]
669
673
  ```
670
674
 
671
675
  **Options**:
@@ -673,14 +677,10 @@ $ bigeye bigconfig plan [OPTIONS]
673
677
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
674
678
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
675
679
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
676
- * `-ip, --input_path TEXT`: List of paths containing Bigconfig files or pointing to a Bigconfig file. E.g. -ip path1 -ip path2. If no input path is defined then current working directory will be used.
677
680
  * `-op, --output_path TEXT`: Output path where reports and fixme files will be saved. If no output path is defined then current working directory will be used.
678
- * `-psn, --purge_source_name TEXT`: List of source names to purge E.g. -psn source_1 -psn source_2.
679
- * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
680
- * `-nq, --no_queue`: Don't submit to queue: True or False.
681
- * `-r, --recursive`: Search all input directories recursively.
682
- * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
683
- * `-cicd, --cicd_report`: Add the report to a pull request. (Github only)
681
+ * `-cid, --collection_id INTEGER`: Collection ID of metrics to be exported.
682
+ * `-tid, --table_id INTEGER`: Table ID of metrics to be exported.
683
+ * `-mid, --metric_id INTEGER`: Metric ID of metrics to be exported.
684
684
  * `--help`: Show this message and exit.
685
685
 
686
686
  # `bigeye catalog`
@@ -701,41 +701,40 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
701
701
 
702
702
  **Commands**:
703
703
 
704
+ * `regen-autometrics`: Regenerates Autometrics by warehouse id OR...
705
+ * `delete-metrics`: Delete metrics in a warehouse id, by...
706
+ * `rebuild`: Rebuilds/Reprofiles a source by warehouse...
707
+ * `get-table-info`: Outputs table info to a file for an entire...
708
+ * `get-metric-info`: Outputs metric info to a file.
709
+ * `run-metrics`: Runs metrics by warehouse id, schema...
704
710
  * `add-source`: Adds a source to specified Bigeye workspace.
711
+ * `delete-source`: Delete a source from specified Bigeye...
705
712
  * `backfill-autothresholds`: Backfills autothresholds by warehouse id,...
706
713
  * `backfill-metrics`: Backfills metrics by warehouse id, schema...
707
- * `delete-metrics`: Delete metrics in a warehouse id, by...
708
- * `delete-source`: Delete a source from specified Bigeye...
709
- * `delete-template`: Delete a template.
710
- * `delete-virtual-table`: Delete a virtual table.
711
- * `export-metric-template`: Export metric templates to yaml files
712
- * `export-virtual-table`: Export virtual table to yaml file
713
- * `get-all-metric-templates`: Retrieve all metric templates and output...
714
- * `get-metric-info`: Outputs metric info to a file.
715
- * `get-metric-queries`: Gets the debug queries for all metrics by...
716
- * `get-table-info`: Outputs table info to a file for an entire...
717
- * `ingest-dbt-core-run-info`: Ingest manifest.json and run_results.json...
718
- * `ingest-owners-from-dbt`: Ingest table owners from dbt manifest.json...
719
- * `rebuild`: Rebuilds/Reprofiles a source by warehouse...
720
- * `regen-autometrics`: Regenerates Autometrics by warehouse id OR...
721
- * `run-metrics`: Runs metrics by warehouse id, schema...
722
714
  * `schedule-all-metrics`: Updates schedule for all metrics in a...
723
- * `set-metric-time`: Sets metric times from a list of possible...
724
- * `track-schema-changes`: Track schema changes for sources on demand...
725
715
  * `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
716
+ * `set-metric-time`: Sets metric times from a list of possible...
726
717
  * `unset-metric-time`: Unsets metric times for whole warehouse or...
718
+ * `get-metric-queries`: Gets the debug queries for all metrics by...
727
719
  * `upsert-template`: Create or update a template for a source.
720
+ * `export-metric-template`: Export metric templates to yaml files
721
+ * `get-all-metric-templates`: Retrieve all metric templates and output...
722
+ * `delete-template`: Delete a template.
728
723
  * `upsert-virtual-table`: Create or update a virtual table.
724
+ * `delete-virtual-table`: Delete a virtual table.
725
+ * `export-virtual-table`: Export virtual table to yaml file
726
+ * `ingest-owners-from-dbt`: Ingest table owners from dbt manifest.json...
727
+ * `ingest-dbt-core-run-info`: Ingest manifest.json and run_results.json...
728
+ * `track-schema-changes`: Track schema changes for sources on demand...
729
729
 
730
- ## `bigeye catalog add-source`
730
+ ## `bigeye catalog regen-autometrics`
731
731
 
732
- Adds a source to specified Bigeye workspace. Supports either source configs stored in AWS Secrets manager OR
733
- locally in file.
732
+ Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids.
734
733
 
735
734
  **Usage**:
736
735
 
737
736
  ```console
738
- $ bigeye catalog add-source [OPTIONS]
737
+ $ bigeye catalog regen-autometrics [OPTIONS]
739
738
  ```
740
739
 
741
740
  **Options**:
@@ -743,19 +742,20 @@ $ bigeye catalog add-source [OPTIONS]
743
742
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
744
743
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
745
744
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
746
- * `-sn, --secret_name TEXT`: The name of the secret to retrieve from AWS Secrets Manager
747
- * `-srn, --secret_region_name TEXT`: AWS Secret Manager Region Name [default: us-west-2]
748
- * `-sccf, --source_catalog_config_file TEXT`: The file containing the necessary parameters for adding a source to Bigeye.
745
+ * `-wid, --warehouse_id INTEGER`: Warehouse ID. If none will look for Table IDs. If value then will pull all table ids for warehouse
746
+ * `-sn, --schema_name TEXT`: List of Schema Names E.g. -sn schema_1 -sn schema_2. Do not include warehouse name -- GREENE_HOMES_DEMO_STANDARD.CONFORMED is fully qualified and CONFORMED is the schema name.
747
+ * `-tid, --table_id INTEGER`: List of Table IDs. E.g. -tid 123 -tid 124
749
748
  * `--help`: Show this message and exit.
750
749
 
751
- ## `bigeye catalog backfill-autothresholds`
750
+ ## `bigeye catalog delete-metrics`
752
751
 
753
- Backfills autothresholds by warehouse id, schema names, and/or table ids.
752
+ Delete metrics in a warehouse id, by schema names, or by table_ids. Also, can filter by multipe
753
+ metric types.
754
754
 
755
755
  **Usage**:
756
756
 
757
757
  ```console
758
- $ bigeye catalog backfill-autothresholds [OPTIONS]
758
+ $ bigeye catalog delete-metrics [OPTIONS]
759
759
  ```
760
760
 
761
761
  **Options**:
@@ -766,16 +766,17 @@ $ bigeye catalog backfill-autothresholds [OPTIONS]
766
766
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
767
767
  * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
768
768
  * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
769
+ * `-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
769
770
  * `--help`: Show this message and exit.
770
771
 
771
- ## `bigeye catalog backfill-metrics`
772
+ ## `bigeye catalog rebuild`
772
773
 
773
- Backfills metrics by warehouse id, schema names, and/or table ids.
774
+ Rebuilds/Reprofiles a source by warehouse id or a schema by warehouse id and schema name.
774
775
 
775
776
  **Usage**:
776
777
 
777
778
  ```console
778
- $ bigeye catalog backfill-metrics [OPTIONS]
779
+ $ bigeye catalog rebuild [OPTIONS]
779
780
  ```
780
781
 
781
782
  **Options**:
@@ -783,22 +784,18 @@ $ bigeye catalog backfill-metrics [OPTIONS]
783
784
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
784
785
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
785
786
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
786
- * `-wid, --warehouse_id INTEGER`: Warehouse ID
787
- * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
788
- * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
789
- * `--delete_history`: Delete metric run history
790
- * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
787
+ * `-wid, --warehouse_id INTEGER`: Warehouse ID [required]
788
+ * `-sn, --schema_name TEXT`: Schema Name
791
789
  * `--help`: Show this message and exit.
792
790
 
793
- ## `bigeye catalog delete-metrics`
791
+ ## `bigeye catalog get-table-info`
794
792
 
795
- Delete metrics in a warehouse id, by schema names, or by table_ids. Also, can filter by multipe
796
- metric types.
793
+ Outputs table info to a file for an entire warehouse, certain schemas, or certain tables.
797
794
 
798
795
  **Usage**:
799
796
 
800
797
  ```console
801
- $ bigeye catalog delete-metrics [OPTIONS]
798
+ $ bigeye catalog get-table-info [OPTIONS]
802
799
  ```
803
800
 
804
801
  **Options**:
@@ -808,18 +805,19 @@ $ bigeye catalog delete-metrics [OPTIONS]
808
805
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
809
806
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
810
807
  * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
811
- * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
812
- * `-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
808
+ * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
809
+ * `-tn, --table_name TEXT`: Table Namess. E.g. -tn some_table -tn some_other_table
810
+ * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
813
811
  * `--help`: Show this message and exit.
814
812
 
815
- ## `bigeye catalog delete-source`
813
+ ## `bigeye catalog get-metric-info`
816
814
 
817
- Delete a source from specified Bigeye workspace.
815
+ Outputs metric info to a file. Includes metric configuration and details about recent runs.
818
816
 
819
817
  **Usage**:
820
818
 
821
819
  ```console
822
- $ bigeye catalog delete-source [OPTIONS]
820
+ $ bigeye catalog get-metric-info [OPTIONS]
823
821
  ```
824
822
 
825
823
  **Options**:
@@ -827,17 +825,22 @@ $ bigeye catalog delete-source [OPTIONS]
827
825
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
828
826
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
829
827
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
830
- * `-wid, --warehouse_id INTEGER`: The ID of the warehouse to delete.
828
+ * `-wid, --warehouse_id INTEGER`: Warehouse ID
829
+ * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
830
+ * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124or schema names.
831
+ * `-ms, --metric_status [HEALTHY|ALERTING|FAILED|UNKNOWN]`: Used to query metric of particular status.
832
+ * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
833
+ * `--conf_only`: Output only the metric configuration.
831
834
  * `--help`: Show this message and exit.
832
835
 
833
- ## `bigeye catalog delete-template`
836
+ ## `bigeye catalog run-metrics`
834
837
 
835
- Delete a template.
838
+ Runs metrics by warehouse id, schema names, and/or table ids
836
839
 
837
840
  **Usage**:
838
841
 
839
842
  ```console
840
- $ bigeye catalog delete-template [OPTIONS]
843
+ $ bigeye catalog run-metrics [OPTIONS]
841
844
  ```
842
845
 
843
846
  **Options**:
@@ -845,17 +848,21 @@ $ bigeye catalog delete-template [OPTIONS]
845
848
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
846
849
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
847
850
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
848
- * `-tid, --template_id INTEGER`: The ID of the metric template [required]
851
+ * `-wid, --warehouse_id INTEGER`: Warehouse ID
852
+ * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
853
+ * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
854
+ * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
849
855
  * `--help`: Show this message and exit.
850
856
 
851
- ## `bigeye catalog delete-virtual-table`
857
+ ## `bigeye catalog add-source`
852
858
 
853
- Delete a virtual table.
859
+ Adds a source to specified Bigeye workspace. Supports either source configs stored in AWS Secrets manager OR
860
+ locally in file.
854
861
 
855
862
  **Usage**:
856
863
 
857
864
  ```console
858
- $ bigeye catalog delete-virtual-table [OPTIONS]
865
+ $ bigeye catalog add-source [OPTIONS]
859
866
  ```
860
867
 
861
868
  **Options**:
@@ -863,18 +870,19 @@ $ bigeye catalog delete-virtual-table [OPTIONS]
863
870
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
864
871
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
865
872
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
866
- * `-vtn, --table_name TEXT`: The name of the virtual table [required]
867
- * `-sn, --source_name TEXT`: The name of the source that contains the virtual table [required]
873
+ * `-sn, --secret_name TEXT`: The name of the secret to retrieve from AWS Secrets Manager
874
+ * `-srn, --secret_region_name TEXT`: AWS Secret Manager Region Name [default: us-west-2]
875
+ * `-sccf, --source_catalog_config_file TEXT`: The file containing the necessary parameters for adding a source to Bigeye.
868
876
  * `--help`: Show this message and exit.
869
877
 
870
- ## `bigeye catalog export-metric-template`
878
+ ## `bigeye catalog delete-source`
871
879
 
872
- Export metric templates to yaml files
880
+ Delete a source from specified Bigeye workspace.
873
881
 
874
882
  **Usage**:
875
883
 
876
884
  ```console
877
- $ bigeye catalog export-metric-template [OPTIONS]
885
+ $ bigeye catalog delete-source [OPTIONS]
878
886
  ```
879
887
 
880
888
  **Options**:
@@ -882,18 +890,17 @@ $ bigeye catalog export-metric-template [OPTIONS]
882
890
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
883
891
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
884
892
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
885
- * `-tn, --name TEXT`: The name of the template(s) to export. None means all
886
- * `-op, --output_path TEXT`: Path to output files. None means current directory
893
+ * `-wid, --warehouse_id INTEGER`: The ID of the warehouse to delete.
887
894
  * `--help`: Show this message and exit.
888
895
 
889
- ## `bigeye catalog export-virtual-table`
896
+ ## `bigeye catalog backfill-autothresholds`
890
897
 
891
- Export virtual table to yaml file
898
+ Backfills autothresholds by warehouse id, schema names, and/or table ids.
892
899
 
893
900
  **Usage**:
894
901
 
895
902
  ```console
896
- $ bigeye catalog export-virtual-table [OPTIONS]
903
+ $ bigeye catalog backfill-autothresholds [OPTIONS]
897
904
  ```
898
905
 
899
906
  **Options**:
@@ -901,18 +908,19 @@ $ bigeye catalog export-virtual-table [OPTIONS]
901
908
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
902
909
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
903
910
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
904
- * `-vtn, --name TEXT`: The name of the virtual table(s) to export. None means all
905
- * `-op, --output_path TEXT`: Path to output files. None means current directory
911
+ * `-wid, --warehouse_id INTEGER`: Warehouse ID
912
+ * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
913
+ * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
906
914
  * `--help`: Show this message and exit.
907
915
 
908
- ## `bigeye catalog get-all-metric-templates`
916
+ ## `bigeye catalog backfill-metrics`
909
917
 
910
- Retrieve all metric templates and output to a file.
918
+ Backfills metrics by warehouse id, schema names, and/or table ids.
911
919
 
912
920
  **Usage**:
913
921
 
914
922
  ```console
915
- $ bigeye catalog get-all-metric-templates [OPTIONS]
923
+ $ bigeye catalog backfill-metrics [OPTIONS]
916
924
  ```
917
925
 
918
926
  **Options**:
@@ -920,20 +928,21 @@ $ bigeye catalog get-all-metric-templates [OPTIONS]
920
928
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
921
929
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
922
930
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
923
- * `-ps, --page_size INTEGER`: How many results to return per page [default: 0]
924
- * `-s, --search TEXT`: A search string to narrow results
925
- * `-op, --output_path TEXT`: The path to output templates
926
- * `-fn, --file_name TEXT`: User defined file name
931
+ * `-wid, --warehouse_id INTEGER`: Warehouse ID
932
+ * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
933
+ * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
934
+ * `--delete_history`: Delete metric run history
935
+ * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
927
936
  * `--help`: Show this message and exit.
928
937
 
929
- ## `bigeye catalog get-metric-info`
938
+ ## `bigeye catalog schedule-all-metrics`
930
939
 
931
- Outputs metric info to a file. Includes metric configuration and details about recent runs.
940
+ Updates schedule for all metrics in a warehouse.
932
941
 
933
942
  **Usage**:
934
943
 
935
944
  ```console
936
- $ bigeye catalog get-metric-info [OPTIONS]
945
+ $ bigeye catalog schedule-all-metrics [OPTIONS]
937
946
  ```
938
947
 
939
948
  **Options**:
@@ -942,21 +951,26 @@ $ bigeye catalog get-metric-info [OPTIONS]
942
951
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
943
952
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
944
953
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
945
- * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
946
- * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124or schema names.
947
- * `-ms, --metric_status [HEALTHY|ALERTING|FAILED|UNKNOWN]`: Used to query metric of particular status.
948
- * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
949
- * `--conf_only`: Output only the metric configuration.
954
+ * `-type, --time_interval_type INTEGER`: Time interval type.
955
+ UNDEFINED_TIME_INTERVAL_TYPE:0
956
+ HOURS_TIME_INTERVAL_TYPE:1
957
+ MINUTES_TIME_INTERVAL_TYPE:2
958
+ SECONDS_TIME_INTERVAL_TYPE:3
959
+ DAYS_TIME_INTERVAL_TYPE:4
960
+ WEEKDAYS_TIME_INTERVAL_TYPE:5
961
+ MARKET_DAYS_TIME_INTERVAL_TYPE:6
962
+ MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
963
+ * `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
950
964
  * `--help`: Show this message and exit.
951
965
 
952
- ## `bigeye catalog get-metric-queries`
966
+ ## `bigeye catalog unschedule-all-metrics`
953
967
 
954
- Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
968
+ Unschedule all metrics by warehouse, schema or tables.
955
969
 
956
970
  **Usage**:
957
971
 
958
972
  ```console
959
- $ bigeye catalog get-metric-queries [OPTIONS]
973
+ $ bigeye catalog unschedule-all-metrics [OPTIONS]
960
974
  ```
961
975
 
962
976
  **Options**:
@@ -965,19 +979,19 @@ $ bigeye catalog get-metric-queries [OPTIONS]
965
979
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
966
980
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
967
981
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
968
- * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
982
+ * `-sn, --schema_name TEXT`: List of Schema Name. E.g. -sn schema_1.
969
983
  * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
970
- * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
971
984
  * `--help`: Show this message and exit.
972
985
 
973
- ## `bigeye catalog get-table-info`
986
+ ## `bigeye catalog set-metric-time`
974
987
 
975
- Outputs table info to a file for an entire warehouse, certain schemas, or certain tables.
988
+ Sets metric times from a list of possible metric column names. Can set for whole warehouse or for a list of
989
+ table IDs.
976
990
 
977
991
  **Usage**:
978
992
 
979
993
  ```console
980
- $ bigeye catalog get-table-info [OPTIONS]
994
+ $ bigeye catalog set-metric-time [OPTIONS]
981
995
  ```
982
996
 
983
997
  **Options**:
@@ -986,20 +1000,20 @@ $ bigeye catalog get-table-info [OPTIONS]
986
1000
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
987
1001
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
988
1002
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
989
- * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
990
- * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
991
- * `-tn, --table_name TEXT`: Table Namess. E.g. -tn some_table -tn some_other_table
992
- * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
1003
+ * `-sid, --schema_id INTEGER`: Schema ID
1004
+ * `-tid, --table_id INTEGER`: List of table IDs.
1005
+ * `-cn, --metric_column_name TEXT`: Possible metric column names. [required]
1006
+ * `-r, --replace`: replace metric times if already present on tables? Default is false.
993
1007
  * `--help`: Show this message and exit.
994
1008
 
995
- ## `bigeye catalog ingest-dbt-core-run-info`
1009
+ ## `bigeye catalog unset-metric-time`
996
1010
 
997
- Ingest manifest.json and run_results.json from different dbt commands.
1011
+ Unsets metric times for whole warehouse or for a list og table IDs.
998
1012
 
999
1013
  **Usage**:
1000
1014
 
1001
1015
  ```console
1002
- $ bigeye catalog ingest-dbt-core-run-info [OPTIONS]
1016
+ $ bigeye catalog unset-metric-time [OPTIONS]
1003
1017
  ```
1004
1018
 
1005
1019
  **Options**:
@@ -1007,23 +1021,18 @@ $ bigeye catalog ingest-dbt-core-run-info [OPTIONS]
1007
1021
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1008
1022
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1009
1023
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1010
- * `-tp, --target_path TEXT`: The path to the target directory created with dbt run, build, and test commands. [default: ./target]
1011
- * `-pn, --project_name TEXT`: The name of the dbt project. Will attempt to parse from metadata section of manifest.json, if not present
1012
- * `-jn, --job_name TEXT`: The name of the dbt job.
1013
- * `-jid, --job_run_id TEXT`: The ID of the dbt job run.
1014
- * `-purl, --project_url TEXT`: The URL of the project.
1015
- * `-jurl, --job_url TEXT`: The URL of the job.
1016
- * `-jrurl, --job_run_url TEXT`: The URL of the job run.
1024
+ * `-wid, --warehouse_id INTEGER`: Warehouse ID
1025
+ * `-tid, --table_id INTEGER`: List of table IDs.
1017
1026
  * `--help`: Show this message and exit.
1018
1027
 
1019
- ## `bigeye catalog ingest-owners-from-dbt`
1028
+ ## `bigeye catalog get-metric-queries`
1020
1029
 
1021
- Ingest table owners from dbt manifest.json file.
1030
+ Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
1022
1031
 
1023
1032
  **Usage**:
1024
1033
 
1025
1034
  ```console
1026
- $ bigeye catalog ingest-owners-from-dbt [OPTIONS]
1035
+ $ bigeye catalog get-metric-queries [OPTIONS]
1027
1036
  ```
1028
1037
 
1029
1038
  **Options**:
@@ -1031,19 +1040,20 @@ $ bigeye catalog ingest-owners-from-dbt [OPTIONS]
1031
1040
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1032
1041
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1033
1042
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1034
- * `-mf, --manifest_file TEXT`: The path to the dbt manifest file.
1035
- * `-sn, --source_name TEXT`: The name of the source in Bigeye where owners will be ingested.
1036
- * `-sid, --source_id INTEGER`: The id of the source in Bigeye where owners will be ingested.
1043
+ * `-wid, --warehouse_id INTEGER`: Warehouse ID
1044
+ * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
1045
+ * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
1046
+ * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
1037
1047
  * `--help`: Show this message and exit.
1038
1048
 
1039
- ## `bigeye catalog rebuild`
1049
+ ## `bigeye catalog upsert-template`
1040
1050
 
1041
- Rebuilds/Reprofiles a source by warehouse id or a schema by warehouse id and schema name.
1051
+ Create or update a template for a source. Files have priority over arguments
1042
1052
 
1043
1053
  **Usage**:
1044
1054
 
1045
1055
  ```console
1046
- $ bigeye catalog rebuild [OPTIONS]
1056
+ $ bigeye catalog upsert-template [OPTIONS]
1047
1057
  ```
1048
1058
 
1049
1059
  **Options**:
@@ -1051,18 +1061,22 @@ $ bigeye catalog rebuild [OPTIONS]
1051
1061
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1052
1062
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1053
1063
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1054
- * `-wid, --warehouse_id INTEGER`: Warehouse ID [required]
1055
- * `-sn, --schema_name TEXT`: Schema Name
1064
+ * `-sn, --source_name TEXT`: The name of the source where the template will be defined
1065
+ * `-tn, --name TEXT`: The user defined name of the template
1066
+ * `-tb, --body TEXT`: The string to define the template
1067
+ * `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN
1068
+ * `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING
1069
+ * `-tf, --template_file TEXT`: A file containing a template definition.
1056
1070
  * `--help`: Show this message and exit.
1057
1071
 
1058
- ## `bigeye catalog regen-autometrics`
1072
+ ## `bigeye catalog export-metric-template`
1059
1073
 
1060
- Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids.
1074
+ Export metric templates to yaml files
1061
1075
 
1062
1076
  **Usage**:
1063
1077
 
1064
1078
  ```console
1065
- $ bigeye catalog regen-autometrics [OPTIONS]
1079
+ $ bigeye catalog export-metric-template [OPTIONS]
1066
1080
  ```
1067
1081
 
1068
1082
  **Options**:
@@ -1070,19 +1084,18 @@ $ bigeye catalog regen-autometrics [OPTIONS]
1070
1084
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1071
1085
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1072
1086
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1073
- * `-wid, --warehouse_id INTEGER`: Warehouse ID. If none will look for Table IDs. If value then will pull all table ids for warehouse
1074
- * `-sn, --schema_name TEXT`: List of Schema Names E.g. -sn schema_1 -sn schema_2. Do not include warehouse name -- GREENE_HOMES_DEMO_STANDARD.CONFORMED is fully qualified and CONFORMED is the schema name.
1075
- * `-tid, --table_id INTEGER`: List of Table IDs. E.g. -tid 123 -tid 124
1087
+ * `-tn, --name TEXT`: The name of the template(s) to export. None means all
1088
+ * `-op, --output_path TEXT`: Path to output files. None means current directory
1076
1089
  * `--help`: Show this message and exit.
1077
1090
 
1078
- ## `bigeye catalog run-metrics`
1091
+ ## `bigeye catalog get-all-metric-templates`
1079
1092
 
1080
- Runs metrics by warehouse id, schema names, and/or table ids
1093
+ Retrieve all metric templates and output to a file.
1081
1094
 
1082
1095
  **Usage**:
1083
1096
 
1084
1097
  ```console
1085
- $ bigeye catalog run-metrics [OPTIONS]
1098
+ $ bigeye catalog get-all-metric-templates [OPTIONS]
1086
1099
  ```
1087
1100
 
1088
1101
  **Options**:
@@ -1090,20 +1103,20 @@ $ bigeye catalog run-metrics [OPTIONS]
1090
1103
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1091
1104
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1092
1105
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1093
- * `-wid, --warehouse_id INTEGER`: Warehouse ID
1094
- * `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
1095
- * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
1096
- * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
1106
+ * `-ps, --page_size INTEGER`: How many results to return per page [default: 0]
1107
+ * `-s, --search TEXT`: A search string to narrow results
1108
+ * `-op, --output_path TEXT`: The path to output templates
1109
+ * `-fn, --file_name TEXT`: User defined file name
1097
1110
  * `--help`: Show this message and exit.
1098
1111
 
1099
- ## `bigeye catalog schedule-all-metrics`
1112
+ ## `bigeye catalog delete-template`
1100
1113
 
1101
- Updates schedule for all metrics in a warehouse.
1114
+ Delete a template.
1102
1115
 
1103
1116
  **Usage**:
1104
1117
 
1105
1118
  ```console
1106
- $ bigeye catalog schedule-all-metrics [OPTIONS]
1119
+ $ bigeye catalog delete-template [OPTIONS]
1107
1120
  ```
1108
1121
 
1109
1122
  **Options**:
@@ -1111,28 +1124,18 @@ $ bigeye catalog schedule-all-metrics [OPTIONS]
1111
1124
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1112
1125
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1113
1126
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1114
- * `-wid, --warehouse_id INTEGER`: Warehouse ID
1115
- * `-type, --time_interval_type INTEGER`: Time interval type.
1116
- UNDEFINED_TIME_INTERVAL_TYPE:0
1117
- HOURS_TIME_INTERVAL_TYPE:1
1118
- MINUTES_TIME_INTERVAL_TYPE:2
1119
- SECONDS_TIME_INTERVAL_TYPE:3
1120
- DAYS_TIME_INTERVAL_TYPE:4
1121
- WEEKDAYS_TIME_INTERVAL_TYPE:5
1122
- MARKET_DAYS_TIME_INTERVAL_TYPE:6
1123
- MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
1124
- * `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
1127
+ * `-tid, --template_id INTEGER`: The ID of the metric template
1128
+ * `-tn, --name TEXT`: The name of the metric template
1125
1129
  * `--help`: Show this message and exit.
1126
1130
 
1127
- ## `bigeye catalog set-metric-time`
1131
+ ## `bigeye catalog upsert-virtual-table`
1128
1132
 
1129
- Sets metric times from a list of possible metric column names. Can set for whole warehouse or for a list of
1130
- table IDs.
1133
+ Create or update a virtual table. Files have priority over arguments
1131
1134
 
1132
1135
  **Usage**:
1133
1136
 
1134
1137
  ```console
1135
- $ bigeye catalog set-metric-time [OPTIONS]
1138
+ $ bigeye catalog upsert-virtual-table [OPTIONS]
1136
1139
  ```
1137
1140
 
1138
1141
  **Options**:
@@ -1140,22 +1143,21 @@ $ bigeye catalog set-metric-time [OPTIONS]
1140
1143
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1141
1144
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1142
1145
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1143
- * `-wid, --warehouse_id INTEGER`: Warehouse ID
1144
- * `-sid, --schema_id INTEGER`: Schema ID
1145
- * `-tid, --table_id INTEGER`: List of table IDs.
1146
- * `-cn, --metric_column_name TEXT`: Possible metric column names. [required]
1147
- * `-r, --replace`: replace metric times if already present on tables? Default is false.
1146
+ * `-vtn, --table_name TEXT`: The name of the virtual table
1147
+ * `-s, --sql TEXT`: The SQL to define the table
1148
+ * `-sn, --source_name TEXT`: The name of the source where the virtual table will be defined
1149
+ * `-u, --update`: Create if false. Update if true.
1150
+ * `-tf, --table_file TEXT`: A yaml file containing a template definition.
1148
1151
  * `--help`: Show this message and exit.
1149
1152
 
1150
- ## `bigeye catalog track-schema-changes`
1153
+ ## `bigeye catalog delete-virtual-table`
1151
1154
 
1152
- Track schema changes for sources on demand or every n hour(s) and notify specified channels.
1153
- Environment variables SMTP_USER and SMTP_PASSWORD MUST be set if using email notification.
1155
+ Delete a virtual table.
1154
1156
 
1155
1157
  **Usage**:
1156
1158
 
1157
1159
  ```console
1158
- $ bigeye catalog track-schema-changes [OPTIONS]
1160
+ $ bigeye catalog delete-virtual-table [OPTIONS]
1159
1161
  ```
1160
1162
 
1161
1163
  **Options**:
@@ -1163,24 +1165,18 @@ $ bigeye catalog track-schema-changes [OPTIONS]
1163
1165
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1164
1166
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1165
1167
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1166
- * `-src, --source TEXT`: A list of source names to track. (None will track changes from all sources)
1167
- * `-s, --since TEXT`: Track schema changes from this date. (Formatted as yyyy-MM-dd) [default: 1970-01-01]
1168
- * `-f, --frequency INTEGER`: Every n hours to check for schema changes. (None will only run the check once) [default: 0]
1169
- * `-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]
1170
- * `-nc, --channel TEXT`: A list of notification channels; e.g. -nc email@mydomain.com -nc #slack_channel -nc https://www.webhook.com
1171
- * `-smtp, --server TEXT`: The server to send emails.
1172
- * `-p, --port INTEGER`: The server port to send emails. [default: 587]
1173
- * `-t, --token TEXT`: The token to utilize the Slack web client. (Will attempt to use environment variable SLACK_BOT_TOKEN, if not set)
1168
+ * `-vtn, --table_name TEXT`: The name of the virtual table [required]
1169
+ * `-sn, --source_name TEXT`: The name of the source that contains the virtual table [required]
1174
1170
  * `--help`: Show this message and exit.
1175
1171
 
1176
- ## `bigeye catalog unschedule-all-metrics`
1172
+ ## `bigeye catalog export-virtual-table`
1177
1173
 
1178
- Unschedule all metrics by warehouse, schema or tables.
1174
+ Export virtual table to yaml file
1179
1175
 
1180
1176
  **Usage**:
1181
1177
 
1182
1178
  ```console
1183
- $ bigeye catalog unschedule-all-metrics [OPTIONS]
1179
+ $ bigeye catalog export-virtual-table [OPTIONS]
1184
1180
  ```
1185
1181
 
1186
1182
  **Options**:
@@ -1188,19 +1184,18 @@ $ bigeye catalog unschedule-all-metrics [OPTIONS]
1188
1184
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1189
1185
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1190
1186
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1191
- * `-wid, --warehouse_id INTEGER`: Warehouse ID
1192
- * `-sn, --schema_name TEXT`: List of Schema Name. E.g. -sn schema_1.
1193
- * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
1187
+ * `-vtn, --name TEXT`: The name of the virtual table(s) to export. None means all
1188
+ * `-op, --output_path TEXT`: Path to output files. None means current directory
1194
1189
  * `--help`: Show this message and exit.
1195
1190
 
1196
- ## `bigeye catalog unset-metric-time`
1191
+ ## `bigeye catalog ingest-owners-from-dbt`
1197
1192
 
1198
- Unsets metric times for whole warehouse or for a list og table IDs.
1193
+ Ingest table owners from dbt manifest.json file.
1199
1194
 
1200
1195
  **Usage**:
1201
1196
 
1202
1197
  ```console
1203
- $ bigeye catalog unset-metric-time [OPTIONS]
1198
+ $ bigeye catalog ingest-owners-from-dbt [OPTIONS]
1204
1199
  ```
1205
1200
 
1206
1201
  **Options**:
@@ -1208,18 +1203,19 @@ $ bigeye catalog unset-metric-time [OPTIONS]
1208
1203
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1209
1204
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1210
1205
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1211
- * `-wid, --warehouse_id INTEGER`: Warehouse ID
1212
- * `-tid, --table_id INTEGER`: List of table IDs.
1206
+ * `-mf, --manifest_file TEXT`: The path to the dbt manifest file.
1207
+ * `-sn, --source_name TEXT`: The name of the source in Bigeye where owners will be ingested.
1208
+ * `-sid, --source_id INTEGER`: The id of the source in Bigeye where owners will be ingested.
1213
1209
  * `--help`: Show this message and exit.
1214
1210
 
1215
- ## `bigeye catalog upsert-template`
1211
+ ## `bigeye catalog ingest-dbt-core-run-info`
1216
1212
 
1217
- Create or update a template for a source. Files have priority over arguments
1213
+ Ingest manifest.json and run_results.json from different dbt commands.
1218
1214
 
1219
1215
  **Usage**:
1220
1216
 
1221
1217
  ```console
1222
- $ bigeye catalog upsert-template [OPTIONS]
1218
+ $ bigeye catalog ingest-dbt-core-run-info [OPTIONS]
1223
1219
  ```
1224
1220
 
1225
1221
  **Options**:
@@ -1227,22 +1223,24 @@ $ bigeye catalog upsert-template [OPTIONS]
1227
1223
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1228
1224
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1229
1225
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1230
- * `-sn, --source_name TEXT`: The name of the source where the template will be defined
1231
- * `-tn, --name TEXT`: The user defined name of the template
1232
- * `-tb, --body TEXT`: The string to define the template
1233
- * `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN
1234
- * `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING
1235
- * `-tf, --template_file TEXT`: A file containing a template definition.
1226
+ * `-tp, --target_path TEXT`: The path to the target directory created with dbt run, build, and test commands. [default: ./target]
1227
+ * `-pn, --project_name TEXT`: The name of the dbt project. Will attempt to parse from metadata section of manifest.json, if not present
1228
+ * `-jn, --job_name TEXT`: The name of the dbt job.
1229
+ * `-jid, --job_run_id TEXT`: The ID of the dbt job run.
1230
+ * `-purl, --project_url TEXT`: The URL of the project.
1231
+ * `-jurl, --job_url TEXT`: The URL of the job.
1232
+ * `-jrurl, --job_run_url TEXT`: The URL of the job run.
1236
1233
  * `--help`: Show this message and exit.
1237
1234
 
1238
- ## `bigeye catalog upsert-virtual-table`
1235
+ ## `bigeye catalog track-schema-changes`
1239
1236
 
1240
- Create or update a virtual table. Files have priority over arguments
1237
+ Track schema changes for sources on demand or every n hour(s) and notify specified channels.
1238
+ Environment variables SMTP_USER and SMTP_PASSWORD MUST be set if using email notification.
1241
1239
 
1242
1240
  **Usage**:
1243
1241
 
1244
1242
  ```console
1245
- $ bigeye catalog upsert-virtual-table [OPTIONS]
1243
+ $ bigeye catalog track-schema-changes [OPTIONS]
1246
1244
  ```
1247
1245
 
1248
1246
  **Options**:
@@ -1250,11 +1248,14 @@ $ bigeye catalog upsert-virtual-table [OPTIONS]
1250
1248
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1251
1249
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1252
1250
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1253
- * `-vtn, --table_name TEXT`: The name of the virtual table
1254
- * `-s, --sql TEXT`: The SQL to define the table
1255
- * `-sn, --source_name TEXT`: The name of the source where the virtual table will be defined
1256
- * `-u, --update`: Create if false. Update if true.
1257
- * `-tf, --table_file TEXT`: A yaml file containing a template definition.
1251
+ * `-src, --source TEXT`: A list of source names to track. (None will track changes from all sources)
1252
+ * `-s, --since TEXT`: Track schema changes from this date. (Formatted as yyyy-MM-dd) [default: 1970-01-01]
1253
+ * `-f, --frequency INTEGER`: Every n hours to check for schema changes. (None will only run the check once) [default: 0]
1254
+ * `-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]
1255
+ * `-nc, --channel TEXT`: A list of notification channels; e.g. -nc email@mydomain.com -nc #slack_channel -nc https://www.webhook.com
1256
+ * `-smtp, --server TEXT`: The server to send emails.
1257
+ * `-p, --port INTEGER`: The server port to send emails. [default: 587]
1258
+ * `-t, --token TEXT`: The token to utilize the Slack web client. (Will attempt to use environment variable SLACK_BOT_TOKEN, if not set)
1258
1259
  * `--help`: Show this message and exit.
1259
1260
 
1260
1261
  # `bigeye metric`
@@ -1275,21 +1276,21 @@ $ bigeye metric [OPTIONS] COMMAND [ARGS]...
1275
1276
 
1276
1277
  **Commands**:
1277
1278
 
1278
- * `dbt-tests-to-metrics`: Convert tests in a dbt schema.yml to...
1279
- * `get-info`: Outputs metric info to a file.
1280
- * `get-metric-queries`: Gets the debug queries for all metrics by...
1281
1279
  * `run`: Run metric by id(s)
1282
- * `upsert`: Upsert single metric from file.
1280
+ * `get-info`: Outputs metric info to a file.
1283
1281
  * `upsert-from-path`: Upsert multiple metrics from files stored...
1282
+ * `upsert`: Upsert single metric from file.
1283
+ * `get-metric-queries`: Gets the debug queries for all metrics by...
1284
+ * `dbt-tests-to-metrics`: Convert tests in a dbt schema.yml to...
1284
1285
 
1285
- ## `bigeye metric dbt-tests-to-metrics`
1286
+ ## `bigeye metric run`
1286
1287
 
1287
- Convert tests in a dbt schema.yml to metrics in Bigeye
1288
+ Run metric by id(s)
1288
1289
 
1289
1290
  **Usage**:
1290
1291
 
1291
1292
  ```console
1292
- $ bigeye metric dbt-tests-to-metrics [OPTIONS]
1293
+ $ bigeye metric run [OPTIONS]
1293
1294
  ```
1294
1295
 
1295
1296
  **Options**:
@@ -1297,12 +1298,8 @@ $ bigeye metric dbt-tests-to-metrics [OPTIONS]
1297
1298
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1298
1299
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1299
1300
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1300
- * `-wn, --warehouse_name TEXT`: The name of the source to deploy metrics [required]
1301
- * `-sn, --schema_name TEXT`: The name of the schema to deploy metrics [required]
1302
- * `-sf, --schema_file TEXT`: The path to the dbt schema file [required]
1303
- * `-auto, --use_auto`: Use autothresholds over default constant
1304
- * `-bigconfig, --to_bigconfig`: Convert the dbt tests to bigconfig.
1305
- * `-op, --output_path TEXT`: Output path where bigconfig file will be saved. If no output path is defined then current working directory will be used. Requires --to_bigconfig to be true. [default: /home/runner/work/semantic-data-platform/semantic-data-platform/bigeye-integrations/bigeye-cli]
1301
+ * `-mid, --metric_id INTEGER`: Metric Ids. [required]
1302
+ * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
1306
1303
  * `--help`: Show this message and exit.
1307
1304
 
1308
1305
  ## `bigeye metric get-info`
@@ -1326,14 +1323,14 @@ $ bigeye metric get-info [OPTIONS]
1326
1323
  * `--conf_only`: Output only the metric configuration.
1327
1324
  * `--help`: Show this message and exit.
1328
1325
 
1329
- ## `bigeye metric get-metric-queries`
1326
+ ## `bigeye metric upsert-from-path`
1330
1327
 
1331
- Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
1328
+ Upsert multiple metrics from files stored in path.
1332
1329
 
1333
1330
  **Usage**:
1334
1331
 
1335
1332
  ```console
1336
- $ bigeye metric get-metric-queries [OPTIONS]
1333
+ $ bigeye metric upsert-from-path [OPTIONS]
1337
1334
  ```
1338
1335
 
1339
1336
  **Options**:
@@ -1341,18 +1338,20 @@ $ bigeye metric get-metric-queries [OPTIONS]
1341
1338
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1342
1339
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1343
1340
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1344
- * `-mid, --metric_id INTEGER`: Metric Ids. [required]
1345
- * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
1341
+ * `-twid, --target_warehouse_id INTEGER`: Deploy Metrics to target Warehouse ID. [required]
1342
+ * `-sp, --source_path TEXT`: Source path file containing the metrics to migrate. [required]
1343
+ * `-srct, --set_row_creation_time`: Set the row creation time in target warehouse for tables found in source path.
1344
+ * `-uc, --update_collections`: Update existing collections to include new metrics from target warehouse.
1346
1345
  * `--help`: Show this message and exit.
1347
1346
 
1348
- ## `bigeye metric run`
1347
+ ## `bigeye metric upsert`
1349
1348
 
1350
- Run metric by id(s)
1349
+ Upsert single metric from file.
1351
1350
 
1352
1351
  **Usage**:
1353
1352
 
1354
1353
  ```console
1355
- $ bigeye metric run [OPTIONS]
1354
+ $ bigeye metric upsert [OPTIONS]
1356
1355
  ```
1357
1356
 
1358
1357
  **Options**:
@@ -1360,18 +1359,20 @@ $ bigeye metric run [OPTIONS]
1360
1359
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1361
1360
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1362
1361
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1363
- * `-mid, --metric_id INTEGER`: Metric Ids. [required]
1364
- * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
1362
+ * `-f, --file TEXT`: File containing SimpleUpsedrtMetricRequest or MetricConfiguration [required]
1363
+ * `-t, --file_type [SIMPLE|FULL]`: Metric File Type. Simple conforms to SimpleUpsertMetricRequest and Full conforms to MetricConfiguration [required]
1364
+ * `-wid, --warehouse_id INTEGER`: (Optional) Warehouse ID. If specified it will reduce the text based search for the table.warehouse
1365
+ * `-mid, --metric_id INTEGER`: (Optional) Metric Id. If specified it will reduce the text based search for existing metric.
1365
1366
  * `--help`: Show this message and exit.
1366
1367
 
1367
- ## `bigeye metric upsert`
1368
+ ## `bigeye metric get-metric-queries`
1368
1369
 
1369
- Upsert single metric from file.
1370
+ Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
1370
1371
 
1371
1372
  **Usage**:
1372
1373
 
1373
1374
  ```console
1374
- $ bigeye metric upsert [OPTIONS]
1375
+ $ bigeye metric get-metric-queries [OPTIONS]
1375
1376
  ```
1376
1377
 
1377
1378
  **Options**:
@@ -1379,20 +1380,18 @@ $ bigeye metric upsert [OPTIONS]
1379
1380
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1380
1381
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1381
1382
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1382
- * `-f, --file TEXT`: File containing SimpleUpsedrtMetricRequest or MetricConfiguration [required]
1383
- * `-t, --file_type [SIMPLE|FULL]`: Metric File Type. Simple conforms to SimpleUpsertMetricRequest and Full conforms to MetricConfiguration [required]
1384
- * `-wid, --warehouse_id INTEGER`: (Optional) Warehouse ID. If specified it will reduce the text based search for the table.warehouse
1385
- * `-mid, --metric_id INTEGER`: (Optional) Metric Id. If specified it will reduce the text based search for existing metric.
1383
+ * `-mid, --metric_id INTEGER`: Metric Ids. [required]
1384
+ * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
1386
1385
  * `--help`: Show this message and exit.
1387
1386
 
1388
- ## `bigeye metric upsert-from-path`
1387
+ ## `bigeye metric dbt-tests-to-metrics`
1389
1388
 
1390
- Upsert multiple metrics from files stored in path.
1389
+ Convert tests in a dbt schema.yml to metrics in Bigeye
1391
1390
 
1392
1391
  **Usage**:
1393
1392
 
1394
1393
  ```console
1395
- $ bigeye metric upsert-from-path [OPTIONS]
1394
+ $ bigeye metric dbt-tests-to-metrics [OPTIONS]
1396
1395
  ```
1397
1396
 
1398
1397
  **Options**:
@@ -1400,10 +1399,12 @@ $ bigeye metric upsert-from-path [OPTIONS]
1400
1399
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1401
1400
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1402
1401
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1403
- * `-twid, --target_warehouse_id INTEGER`: Deploy Metrics to target Warehouse ID. [required]
1404
- * `-sp, --source_path TEXT`: Source path file containing the metrics to migrate. [required]
1405
- * `-srct, --set_row_creation_time`: Set the row creation time in target warehouse for tables found in source path.
1406
- * `-uc, --update_collections`: Update existing collections to include new metrics from target warehouse.
1402
+ * `-wn, --warehouse_name TEXT`: The name of the source to deploy metrics [required]
1403
+ * `-sn, --schema_name TEXT`: The name of the schema to deploy metrics [required]
1404
+ * `-sf, --schema_file TEXT`: The path to the dbt schema file [required]
1405
+ * `-auto, --use_auto`: Use autothresholds over default constant
1406
+ * `-bigconfig, --to_bigconfig`: Convert the dbt tests to bigconfig.
1407
+ * `-op, --output_path TEXT`: Output path where bigconfig file will be saved. If no output path is defined then current working directory will be used. Requires --to_bigconfig to be true. [default: /home/runner/work/semantic-data-platform/semantic-data-platform/bigeye-integrations/bigeye-cli]
1407
1408
  * `--help`: Show this message and exit.
1408
1409
 
1409
1410
  # `bigeye issues`
@@ -1490,20 +1491,20 @@ $ bigeye deltas [OPTIONS] COMMAND [ARGS]...
1490
1491
 
1491
1492
  **Commands**:
1492
1493
 
1493
- * `cicd`: Creates a delta based on...
1494
+ * `suggest-deltas`: Suggests and creates Deltas with default...
1494
1495
  * `create-delta`: Creates deltas between tables from a...
1495
- * `create-template`: Create a template delta configuration file...
1496
1496
  * `run-delta`: Runs a delta by Delta ID.
1497
- * `suggest-deltas`: Suggests and creates Deltas with default...
1497
+ * `create-template`: Create a template delta configuration file...
1498
+ * `cicd`: Creates a delta based on...
1498
1499
 
1499
- ## `bigeye deltas cicd`
1500
+ ## `bigeye deltas suggest-deltas`
1500
1501
 
1501
- Creates a delta based on SimpleDeltaConfiguration and integrates the results with the provided VCS vendor.
1502
+ Suggests and creates Deltas with default behavior and outputs all Simple Delta Configurations to a file.
1502
1503
 
1503
1504
  **Usage**:
1504
1505
 
1505
1506
  ```console
1506
- $ bigeye deltas cicd [OPTIONS]
1507
+ $ bigeye deltas suggest-deltas [OPTIONS]
1507
1508
  ```
1508
1509
 
1509
1510
  **Options**:
@@ -1511,7 +1512,10 @@ $ bigeye deltas cicd [OPTIONS]
1511
1512
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1512
1513
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1513
1514
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1514
- * `-dcc, --delta_cicd_config TEXT`: The yaml file containing the parameters for the DeltaCICDConfig class [required]
1515
+ * `-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]
1516
+ * `-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]
1517
+ * `-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]
1518
+ * `-op, --output_path TEXT`: File to write the delta configuration. [required]
1515
1519
  * `--help`: Show this message and exit.
1516
1520
 
1517
1521
  ## `bigeye deltas create-delta`
@@ -1532,17 +1536,17 @@ $ bigeye deltas create-delta [OPTIONS]
1532
1536
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1533
1537
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1534
1538
  * `-dc, --delta_conf TEXT`: Simple Delta configuration file. [required]
1535
- * `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn't exist.
1539
+ * `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn&#x27;t exist.
1536
1540
  * `--help`: Show this message and exit.
1537
1541
 
1538
- ## `bigeye deltas create-template`
1542
+ ## `bigeye deltas run-delta`
1539
1543
 
1540
- Create a template delta configuration file based on table names.
1544
+ Runs a delta by Delta ID.
1541
1545
 
1542
1546
  **Usage**:
1543
1547
 
1544
1548
  ```console
1545
- $ bigeye deltas create-template [OPTIONS]
1549
+ $ bigeye deltas run-delta [OPTIONS]
1546
1550
  ```
1547
1551
 
1548
1552
  **Options**:
@@ -1550,19 +1554,18 @@ $ bigeye deltas create-template [OPTIONS]
1550
1554
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1551
1555
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1552
1556
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1553
- * `-stn, --source_table_name TEXT`: The fully qualified name of the source table [required]
1554
- * `-ttn, --target_table_name TEXT`: The fully qualified name of the target table [required]
1555
- * `-op, --output_path TEXT`: Path to write the template. [required]
1557
+ * `-did, --delta_id INTEGER`: Id of delta. [required]
1558
+ * `-ar, --await_results`: Should command wait for delta run to complete, default False.
1556
1559
  * `--help`: Show this message and exit.
1557
1560
 
1558
- ## `bigeye deltas run-delta`
1561
+ ## `bigeye deltas create-template`
1559
1562
 
1560
- Runs a delta by Delta ID.
1563
+ Create a template delta configuration file based on table names.
1561
1564
 
1562
1565
  **Usage**:
1563
1566
 
1564
1567
  ```console
1565
- $ bigeye deltas run-delta [OPTIONS]
1568
+ $ bigeye deltas create-template [OPTIONS]
1566
1569
  ```
1567
1570
 
1568
1571
  **Options**:
@@ -1570,18 +1573,19 @@ $ bigeye deltas run-delta [OPTIONS]
1570
1573
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1571
1574
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1572
1575
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1573
- * `-did, --delta_id INTEGER`: Id of delta. [required]
1574
- * `-ar, --await_results`: Should command wait for delta run to complete, default False.
1576
+ * `-stn, --source_table_name TEXT`: The fully qualified name of the source table [required]
1577
+ * `-ttn, --target_table_name TEXT`: The fully qualified name of the target table [required]
1578
+ * `-op, --output_path TEXT`: Path to write the template. [required]
1575
1579
  * `--help`: Show this message and exit.
1576
1580
 
1577
- ## `bigeye deltas suggest-deltas`
1581
+ ## `bigeye deltas cicd`
1578
1582
 
1579
- Suggests and creates Deltas with default behavior and outputs all Simple Delta Configurations to a file.
1583
+ Creates a delta based on SimpleDeltaConfiguration and integrates the results with the provided VCS vendor.
1580
1584
 
1581
1585
  **Usage**:
1582
1586
 
1583
1587
  ```console
1584
- $ bigeye deltas suggest-deltas [OPTIONS]
1588
+ $ bigeye deltas cicd [OPTIONS]
1585
1589
  ```
1586
1590
 
1587
1591
  **Options**:
@@ -1589,10 +1593,7 @@ $ bigeye deltas suggest-deltas [OPTIONS]
1589
1593
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1590
1594
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1591
1595
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1592
- * `-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]
1593
- * `-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]
1594
- * `-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]
1595
- * `-op, --output_path TEXT`: File to write the delta configuration. [required]
1596
+ * `-dcc, --delta_cicd_config TEXT`: The yaml file containing the parameters for the DeltaCICDConfig class [required]
1596
1597
  * `--help`: Show this message and exit.
1597
1598
 
1598
1599
  # `bigeye collections`
@@ -1614,11 +1615,11 @@ $ bigeye collections [OPTIONS] COMMAND [ARGS]...
1614
1615
  **Commands**:
1615
1616
 
1616
1617
  * `add-metric`: Add metric to a Collection.
1617
- * `backfill-metrics`: Backfill all metrics in a Collection.
1618
1618
  * `get-metric-info`: Get metric info for all metrics in...
1619
- * `get-metric-queries`: Gets the debug queries for all metrics by...
1620
1619
  * `migrate-from-json`: Loads metrics from Collection oriented...
1620
+ * `backfill-metrics`: Backfill all metrics in a Collection.
1621
1621
  * `run-metrics`: Run all metrics in a Collection.
1622
+ * `get-metric-queries`: Gets the debug queries for all metrics by...
1622
1623
 
1623
1624
  ## `bigeye collections add-metric`
1624
1625
 
@@ -1639,14 +1640,14 @@ $ bigeye collections add-metric [OPTIONS]
1639
1640
  * `-cid, --collection_id INTEGER`: Collection ID [required]
1640
1641
  * `--help`: Show this message and exit.
1641
1642
 
1642
- ## `bigeye collections backfill-metrics`
1643
+ ## `bigeye collections get-metric-info`
1643
1644
 
1644
- Backfill all metrics in a Collection.
1645
+ Get metric info for all metrics in Collection.
1645
1646
 
1646
1647
  **Usage**:
1647
1648
 
1648
1649
  ```console
1649
- $ bigeye collections backfill-metrics [OPTIONS]
1650
+ $ bigeye collections get-metric-info [OPTIONS]
1650
1651
  ```
1651
1652
 
1652
1653
  **Options**:
@@ -1656,18 +1657,18 @@ $ bigeye collections backfill-metrics [OPTIONS]
1656
1657
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1657
1658
  * `--from_collections`: Scrapes all Collections in customer workspace for Metric Info.
1658
1659
  * `--collection_ids INTEGER`: Collection IDs. Scrape certain Collections for Metric Info.
1659
- * `--delete_history`: Delete metric run history
1660
- * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
1660
+ * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
1661
1661
  * `--help`: Show this message and exit.
1662
1662
 
1663
- ## `bigeye collections get-metric-info`
1663
+ ## `bigeye collections migrate-from-json`
1664
1664
 
1665
- Get metric info for all metrics in Collection.
1665
+ Loads metrics from Collection oriented metric info output. Used to migrate metrics from one warehouse to
1666
+ another, identical, warehouse
1666
1667
 
1667
1668
  **Usage**:
1668
1669
 
1669
1670
  ```console
1670
- $ bigeye collections get-metric-info [OPTIONS]
1671
+ $ bigeye collections migrate-from-json [OPTIONS]
1671
1672
  ```
1672
1673
 
1673
1674
  **Options**:
@@ -1675,19 +1676,20 @@ $ bigeye collections get-metric-info [OPTIONS]
1675
1676
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1676
1677
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1677
1678
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1678
- * `--from_collections`: Scrapes all Collections in customer workspace for Metric Info.
1679
- * `--collection_ids INTEGER`: Collection IDs. Scrape certain Collections for Metric Info.
1680
- * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
1679
+ * `-twid, --target_warehouse_id INTEGER`: Deploy Metrics to target Warehouse ID. [required]
1680
+ * `-ip, --input_path TEXT`: Path to read from. [required]
1681
+ * `-kn, --keep_notifications`: Keep Notifications from versioned or templated metric configuration.
1682
+ * `-kid, --keep_ids`: Keep Metric and Collection IDs from versioned or templated metric configuration. If kept this would update existing metrics and collections. If not kept it would create new.
1681
1683
  * `--help`: Show this message and exit.
1682
1684
 
1683
- ## `bigeye collections get-metric-queries`
1685
+ ## `bigeye collections backfill-metrics`
1684
1686
 
1685
- Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
1687
+ Backfill all metrics in a Collection.
1686
1688
 
1687
1689
  **Usage**:
1688
1690
 
1689
1691
  ```console
1690
- $ bigeye collections get-metric-queries [OPTIONS]
1692
+ $ bigeye collections backfill-metrics [OPTIONS]
1691
1693
  ```
1692
1694
 
1693
1695
  **Options**:
@@ -1695,19 +1697,20 @@ $ bigeye collections get-metric-queries [OPTIONS]
1695
1697
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1696
1698
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1697
1699
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1698
- * `-cid, --collection_id INTEGER`: Collection ID [required]
1699
- * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
1700
+ * `--from_collections`: Scrapes all Collections in customer workspace for Metric Info.
1701
+ * `--collection_ids INTEGER`: Collection IDs. Scrape certain Collections for Metric Info.
1702
+ * `--delete_history`: Delete metric run history
1703
+ * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
1700
1704
  * `--help`: Show this message and exit.
1701
1705
 
1702
- ## `bigeye collections migrate-from-json`
1706
+ ## `bigeye collections run-metrics`
1703
1707
 
1704
- Loads metrics from Collection oriented metric info output. Used to migrate metrics from one warehouse to
1705
- another, identical, warehouse
1708
+ Run all metrics in a Collection.
1706
1709
 
1707
1710
  **Usage**:
1708
1711
 
1709
1712
  ```console
1710
- $ bigeye collections migrate-from-json [OPTIONS]
1713
+ $ bigeye collections run-metrics [OPTIONS]
1711
1714
  ```
1712
1715
 
1713
1716
  **Options**:
@@ -1715,20 +1718,18 @@ $ bigeye collections migrate-from-json [OPTIONS]
1715
1718
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1716
1719
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1717
1720
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1718
- * `-twid, --target_warehouse_id INTEGER`: Deploy Metrics to target Warehouse ID. [required]
1719
- * `-ip, --input_path TEXT`: Path to read from. [required]
1720
- * `-kn, --keep_notifications`: Keep Notifications from versioned or templated metric configuration.
1721
- * `-kid, --keep_ids`: Keep Metric and Collection IDs from versioned or templated metric configuration. If kept this would update existing metrics and collections. If not kept it would create new.
1721
+ * `-cid, --collection_id INTEGER`: Collection ID [required]
1722
+ * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
1722
1723
  * `--help`: Show this message and exit.
1723
1724
 
1724
- ## `bigeye collections run-metrics`
1725
+ ## `bigeye collections get-metric-queries`
1725
1726
 
1726
- Run all metrics in a Collection.
1727
+ Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
1727
1728
 
1728
1729
  **Usage**:
1729
1730
 
1730
1731
  ```console
1731
- $ bigeye collections run-metrics [OPTIONS]
1732
+ $ bigeye collections get-metric-queries [OPTIONS]
1732
1733
  ```
1733
1734
 
1734
1735
  **Options**:
@@ -1737,7 +1738,7 @@ $ bigeye collections run-metrics [OPTIONS]
1737
1738
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1738
1739
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1739
1740
  * `-cid, --collection_id INTEGER`: Collection ID [required]
1740
- * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
1741
+ * `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
1741
1742
  * `--help`: Show this message and exit.
1742
1743
 
1743
1744
  # `bigeye lineage`
@@ -1759,8 +1760,8 @@ $ bigeye lineage [OPTIONS] COMMAND [ARGS]...
1759
1760
  **Commands**:
1760
1761
 
1761
1762
  * `create-node`: Create a lineage node for an entity
1762
- * `create-relation`: Create a lineage relationship for 2 entities
1763
1763
  * `delete-node`: Delete a lineage node for an entity
1764
+ * `create-relation`: Create a lineage relationship for 2 entities
1764
1765
  * `delete-relation`: Deletes a single relationship based on...
1765
1766
  * `infer-relations`: Given an upstream and downstream path,...
1766
1767
 
@@ -1783,14 +1784,14 @@ $ bigeye lineage create-node [OPTIONS]
1783
1784
  * `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
1784
1785
  * `--help`: Show this message and exit.
1785
1786
 
1786
- ## `bigeye lineage create-relation`
1787
+ ## `bigeye lineage delete-node`
1787
1788
 
1788
- Create a lineage relationship for 2 entities
1789
+ Delete a lineage node for an entity
1789
1790
 
1790
1791
  **Usage**:
1791
1792
 
1792
1793
  ```console
1793
- $ bigeye lineage create-relation [OPTIONS]
1794
+ $ bigeye lineage delete-node [OPTIONS]
1794
1795
  ```
1795
1796
 
1796
1797
  **Options**:
@@ -1798,19 +1799,18 @@ $ bigeye lineage create-relation [OPTIONS]
1798
1799
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1799
1800
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1800
1801
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1801
- * `-up, --upstream TEXT`: The fully qualified table name [required]
1802
- * `-down, --downstream TEXT`: The fully qualified table name [required]
1803
- * `-co, --column_overrides TEXT`: The list of column overrides, formatted as upstream_column_name:downstream_column_name
1802
+ * `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook [required]
1803
+ * `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
1804
1804
  * `--help`: Show this message and exit.
1805
1805
 
1806
- ## `bigeye lineage delete-node`
1806
+ ## `bigeye lineage create-relation`
1807
1807
 
1808
- Delete a lineage node for an entity
1808
+ Create a lineage relationship for 2 entities
1809
1809
 
1810
1810
  **Usage**:
1811
1811
 
1812
1812
  ```console
1813
- $ bigeye lineage delete-node [OPTIONS]
1813
+ $ bigeye lineage create-relation [OPTIONS]
1814
1814
  ```
1815
1815
 
1816
1816
  **Options**:
@@ -1818,8 +1818,9 @@ $ bigeye lineage delete-node [OPTIONS]
1818
1818
  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
1819
1819
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
1820
1820
  * `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
1821
- * `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook [required]
1822
- * `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
1821
+ * `-up, --upstream TEXT`: The fully qualified table name [required]
1822
+ * `-down, --downstream TEXT`: The fully qualified table name [required]
1823
+ * `-co, --column_overrides TEXT`: The list of column overrides, formatted as upstream_column_name:downstream_column_name
1823
1824
  * `--help`: Show this message and exit.
1824
1825
 
1825
1826
  ## `bigeye lineage delete-relation`