bigeye-cli 0.3.65__tar.gz → 0.3.67__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/PKG-INFO +453 -391
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/CLI_DOCS.md +452 -390
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/catalog/catalog_commands.py +578 -510
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/functions.py +72 -5
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/workspace/workspace_commands.py +164 -131
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/pyproject.toml +1 -1
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/LICENSE +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/__main__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/__version__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/bigconfig/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/bigconfig/bigconfig_commands.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/bigconfig/bigconfig_options.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/catalog/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/collections/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/collections/collection_commands.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/configure/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/configure/configure_commands.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/deltas/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/deltas/deltas_commands.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/enums.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/exceptions/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/exceptions/exceptions.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/global_options.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/issues/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/issues/issue_commands.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/lineage/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/lineage/lineage_commands.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/metric/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/metric/metric_commands.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/model/__init__.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/model/cicd_conf.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/model/github_report.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/bigeye_cli/model/vendor_report.py +0 -0
- {bigeye_cli-0.3.65 → bigeye_cli-0.3.67}/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.
|
|
3
|
+
Version: 0.3.67
|
|
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.
|
|
22
|
+
Version: 0.3.67
|
|
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
|
|
219
|
+
## `bigeye configure set`
|
|
220
220
|
|
|
221
|
-
|
|
221
|
+
Set any specific configuration settings.
|
|
222
222
|
|
|
223
223
|
**Usage**:
|
|
224
224
|
|
|
225
225
|
```console
|
|
226
|
-
$ bigeye configure
|
|
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
|
|
240
|
+
## `bigeye configure get`
|
|
240
241
|
|
|
241
|
-
|
|
242
|
+
Get any specific configuration settings.
|
|
242
243
|
|
|
243
244
|
**Usage**:
|
|
244
245
|
|
|
245
246
|
```console
|
|
246
|
-
$ bigeye configure
|
|
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
|
|
260
|
+
## `bigeye configure list`
|
|
256
261
|
|
|
257
|
-
|
|
262
|
+
List all configured workspaces.
|
|
258
263
|
|
|
259
264
|
**Usage**:
|
|
260
265
|
|
|
261
266
|
```console
|
|
262
|
-
$ bigeye configure
|
|
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,28 +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
|
-
* `
|
|
297
|
+
* `upsert-named-schedule`: Create a named, cron based schedule.
|
|
296
298
|
* `delete-named-schedule`: Delete a named schedule.
|
|
299
|
+
* `export-named-schedule`: Export cron schedule to yaml file
|
|
300
|
+
* `invite-user`: Invite a user to a workspace.
|
|
301
|
+
* `edit-user`: Edit an existing user's access to groups.
|
|
297
302
|
* `delete-user`: Deletes a users account.
|
|
303
|
+
* `upsert-workspace`: Create or update a workspace.
|
|
298
304
|
* `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
|
-
* `invite-user`: Invite a user to a workspace.
|
|
302
|
-
* `schedule-all-metrics`: Schedule all metrics in a workspace.
|
|
303
|
-
* `unschedule-all-metrics`: Unschedule all metrics in a workspace.
|
|
304
305
|
* `upsert-group`: Create or update a group.
|
|
305
|
-
* `
|
|
306
|
-
* `
|
|
306
|
+
* `edit-group-access`: Edit the workspaces that a group can access.
|
|
307
|
+
* `delete-group`: Delete a group.
|
|
307
308
|
|
|
308
|
-
## `bigeye workspace
|
|
309
|
+
## `bigeye workspace unschedule-all-metrics`
|
|
309
310
|
|
|
310
|
-
|
|
311
|
+
Unschedule all metrics in a workspace.
|
|
311
312
|
|
|
312
313
|
**Usage**:
|
|
313
314
|
|
|
314
315
|
```console
|
|
315
|
-
$ bigeye workspace
|
|
316
|
+
$ bigeye workspace unschedule-all-metrics [OPTIONS]
|
|
316
317
|
```
|
|
317
318
|
|
|
318
319
|
**Options**:
|
|
@@ -320,18 +321,16 @@ $ bigeye workspace create-named-schedule [OPTIONS]
|
|
|
320
321
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
321
322
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
322
323
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
323
|
-
* `-sn, --name TEXT`: The user defined name of the schedule [required]
|
|
324
|
-
* `-c, --cron TEXT`: The cron string to define the schedule [required]
|
|
325
324
|
* `--help`: Show this message and exit.
|
|
326
325
|
|
|
327
|
-
## `bigeye workspace
|
|
326
|
+
## `bigeye workspace schedule-all-metrics`
|
|
328
327
|
|
|
329
|
-
|
|
328
|
+
Schedule all metrics in a workspace.
|
|
330
329
|
|
|
331
330
|
**Usage**:
|
|
332
331
|
|
|
333
332
|
```console
|
|
334
|
-
$ bigeye workspace
|
|
333
|
+
$ bigeye workspace schedule-all-metrics [OPTIONS]
|
|
335
334
|
```
|
|
336
335
|
|
|
337
336
|
**Options**:
|
|
@@ -339,17 +338,26 @@ $ bigeye workspace delete-group [OPTIONS]
|
|
|
339
338
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
340
339
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
341
340
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
342
|
-
* `-
|
|
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]
|
|
343
351
|
* `--help`: Show this message and exit.
|
|
344
352
|
|
|
345
|
-
## `bigeye workspace
|
|
353
|
+
## `bigeye workspace create-named-schedule`
|
|
346
354
|
|
|
347
|
-
|
|
355
|
+
Create a named, cron based schedule
|
|
348
356
|
|
|
349
357
|
**Usage**:
|
|
350
358
|
|
|
351
359
|
```console
|
|
352
|
-
$ bigeye workspace
|
|
360
|
+
$ bigeye workspace create-named-schedule [OPTIONS]
|
|
353
361
|
```
|
|
354
362
|
|
|
355
363
|
**Options**:
|
|
@@ -358,16 +366,17 @@ $ bigeye workspace delete-named-schedule [OPTIONS]
|
|
|
358
366
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
359
367
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
360
368
|
* `-sn, --name TEXT`: The user defined name of the schedule [required]
|
|
369
|
+
* `-c, --cron TEXT`: The cron string to define the schedule [required]
|
|
361
370
|
* `--help`: Show this message and exit.
|
|
362
371
|
|
|
363
|
-
## `bigeye workspace
|
|
372
|
+
## `bigeye workspace upsert-named-schedule`
|
|
364
373
|
|
|
365
|
-
|
|
374
|
+
Create a named, cron based schedule. Files have priority over arguments
|
|
366
375
|
|
|
367
376
|
**Usage**:
|
|
368
377
|
|
|
369
378
|
```console
|
|
370
|
-
$ bigeye workspace
|
|
379
|
+
$ bigeye workspace upsert-named-schedule [OPTIONS]
|
|
371
380
|
```
|
|
372
381
|
|
|
373
382
|
**Options**:
|
|
@@ -375,18 +384,19 @@ $ bigeye workspace delete-user [OPTIONS]
|
|
|
375
384
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
376
385
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
377
386
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
378
|
-
* `-
|
|
379
|
-
* `-
|
|
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.
|
|
380
390
|
* `--help`: Show this message and exit.
|
|
381
391
|
|
|
382
|
-
## `bigeye workspace delete-
|
|
392
|
+
## `bigeye workspace delete-named-schedule`
|
|
383
393
|
|
|
384
|
-
Delete a
|
|
394
|
+
Delete a named schedule.
|
|
385
395
|
|
|
386
396
|
**Usage**:
|
|
387
397
|
|
|
388
398
|
```console
|
|
389
|
-
$ bigeye workspace delete-
|
|
399
|
+
$ bigeye workspace delete-named-schedule [OPTIONS]
|
|
390
400
|
```
|
|
391
401
|
|
|
392
402
|
**Options**:
|
|
@@ -394,17 +404,17 @@ $ bigeye workspace delete-workspace [OPTIONS]
|
|
|
394
404
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
395
405
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
396
406
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
397
|
-
* `-
|
|
407
|
+
* `-sn, --name TEXT`: The user defined name of the schedule [required]
|
|
398
408
|
* `--help`: Show this message and exit.
|
|
399
409
|
|
|
400
|
-
## `bigeye workspace
|
|
410
|
+
## `bigeye workspace export-named-schedule`
|
|
401
411
|
|
|
402
|
-
|
|
412
|
+
Export cron schedule to yaml file
|
|
403
413
|
|
|
404
414
|
**Usage**:
|
|
405
415
|
|
|
406
416
|
```console
|
|
407
|
-
$ bigeye workspace
|
|
417
|
+
$ bigeye workspace export-named-schedule [OPTIONS]
|
|
408
418
|
```
|
|
409
419
|
|
|
410
420
|
**Options**:
|
|
@@ -412,14 +422,28 @@ $ bigeye workspace edit-group-access [OPTIONS]
|
|
|
412
422
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
413
423
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
414
424
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
415
|
-
* `-
|
|
416
|
-
* `-
|
|
417
|
-
*
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
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
|
|
427
|
+
* `--help`: Show this message and exit.
|
|
428
|
+
|
|
429
|
+
## `bigeye workspace invite-user`
|
|
430
|
+
|
|
431
|
+
Invite a user to a workspace.
|
|
432
|
+
|
|
433
|
+
**Usage**:
|
|
434
|
+
|
|
435
|
+
```console
|
|
436
|
+
$ bigeye workspace invite-user [OPTIONS]
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
**Options**:
|
|
440
|
+
|
|
441
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
442
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
443
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
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
|
|
423
447
|
* `--help`: Show this message and exit.
|
|
424
448
|
|
|
425
449
|
## `bigeye workspace edit-user`
|
|
@@ -446,14 +470,14 @@ GROUP_USER_OPERATION_ADD:1
|
|
|
446
470
|
GROUP_USER_OPERATION_REMOVE:2 [default: 1]
|
|
447
471
|
* `--help`: Show this message and exit.
|
|
448
472
|
|
|
449
|
-
## `bigeye workspace
|
|
473
|
+
## `bigeye workspace delete-user`
|
|
450
474
|
|
|
451
|
-
|
|
475
|
+
Deletes a users account.
|
|
452
476
|
|
|
453
477
|
**Usage**:
|
|
454
478
|
|
|
455
479
|
```console
|
|
456
|
-
$ bigeye workspace
|
|
480
|
+
$ bigeye workspace delete-user [OPTIONS]
|
|
457
481
|
```
|
|
458
482
|
|
|
459
483
|
**Options**:
|
|
@@ -461,19 +485,18 @@ $ bigeye workspace invite-user [OPTIONS]
|
|
|
461
485
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
462
486
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
463
487
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
464
|
-
* `-name, --user_name TEXT`: User name.
|
|
465
|
-
* `-email, --user_email TEXT`:
|
|
466
|
-
* `-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.
|
|
467
490
|
* `--help`: Show this message and exit.
|
|
468
491
|
|
|
469
|
-
## `bigeye workspace
|
|
492
|
+
## `bigeye workspace upsert-workspace`
|
|
470
493
|
|
|
471
|
-
|
|
494
|
+
Create or update a workspace.
|
|
472
495
|
|
|
473
496
|
**Usage**:
|
|
474
497
|
|
|
475
498
|
```console
|
|
476
|
-
$ bigeye workspace
|
|
499
|
+
$ bigeye workspace upsert-workspace [OPTIONS]
|
|
477
500
|
```
|
|
478
501
|
|
|
479
502
|
**Options**:
|
|
@@ -481,26 +504,18 @@ $ bigeye workspace schedule-all-metrics [OPTIONS]
|
|
|
481
504
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
482
505
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
483
506
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
484
|
-
* `-
|
|
485
|
-
|
|
486
|
-
HOURS_TIME_INTERVAL_TYPE:1
|
|
487
|
-
MINUTES_TIME_INTERVAL_TYPE:2
|
|
488
|
-
SECONDS_TIME_INTERVAL_TYPE:3
|
|
489
|
-
DAYS_TIME_INTERVAL_TYPE:4
|
|
490
|
-
WEEKDAYS_TIME_INTERVAL_TYPE:5
|
|
491
|
-
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
492
|
-
MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
|
|
493
|
-
* `-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.
|
|
494
509
|
* `--help`: Show this message and exit.
|
|
495
510
|
|
|
496
|
-
## `bigeye workspace
|
|
511
|
+
## `bigeye workspace delete-workspace`
|
|
497
512
|
|
|
498
|
-
|
|
513
|
+
Delete a workspace.
|
|
499
514
|
|
|
500
515
|
**Usage**:
|
|
501
516
|
|
|
502
517
|
```console
|
|
503
|
-
$ bigeye workspace
|
|
518
|
+
$ bigeye workspace delete-workspace [OPTIONS]
|
|
504
519
|
```
|
|
505
520
|
|
|
506
521
|
**Options**:
|
|
@@ -508,6 +523,7 @@ $ bigeye workspace unschedule-all-metrics [OPTIONS]
|
|
|
508
523
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
509
524
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
510
525
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
526
|
+
* `-name, --workspace_name TEXT`: Workspace name. [required]
|
|
511
527
|
* `--help`: Show this message and exit.
|
|
512
528
|
|
|
513
529
|
## `bigeye workspace upsert-group`
|
|
@@ -529,14 +545,14 @@ $ bigeye workspace upsert-group [OPTIONS]
|
|
|
529
545
|
* `-id, --group_id INTEGER`: Group ID.
|
|
530
546
|
* `--help`: Show this message and exit.
|
|
531
547
|
|
|
532
|
-
## `bigeye workspace
|
|
548
|
+
## `bigeye workspace edit-group-access`
|
|
533
549
|
|
|
534
|
-
|
|
550
|
+
Edit the workspaces that a group can access.
|
|
535
551
|
|
|
536
552
|
**Usage**:
|
|
537
553
|
|
|
538
554
|
```console
|
|
539
|
-
$ bigeye workspace
|
|
555
|
+
$ bigeye workspace edit-group-access [OPTIONS]
|
|
540
556
|
```
|
|
541
557
|
|
|
542
558
|
**Options**:
|
|
@@ -544,18 +560,24 @@ $ bigeye workspace upsert-named-schedule [OPTIONS]
|
|
|
544
560
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
545
561
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
546
562
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
547
|
-
* `-
|
|
548
|
-
* `-
|
|
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 either `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]
|
|
549
571
|
* `--help`: Show this message and exit.
|
|
550
572
|
|
|
551
|
-
## `bigeye workspace
|
|
573
|
+
## `bigeye workspace delete-group`
|
|
552
574
|
|
|
553
|
-
|
|
575
|
+
Delete a group.
|
|
554
576
|
|
|
555
577
|
**Usage**:
|
|
556
578
|
|
|
557
579
|
```console
|
|
558
|
-
$ bigeye workspace
|
|
580
|
+
$ bigeye workspace delete-group [OPTIONS]
|
|
559
581
|
```
|
|
560
582
|
|
|
561
583
|
**Options**:
|
|
@@ -563,8 +585,7 @@ $ bigeye workspace upsert-workspace [OPTIONS]
|
|
|
563
585
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
564
586
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
565
587
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
566
|
-
* `-name, --
|
|
567
|
-
* `-id, --workspace_id INTEGER`: Workspace ID.
|
|
588
|
+
* `-name, --group_name TEXT`: Group name. [required]
|
|
568
589
|
* `--help`: Show this message and exit.
|
|
569
590
|
|
|
570
591
|
# `bigeye bigconfig`
|
|
@@ -585,19 +606,19 @@ $ bigeye bigconfig [OPTIONS] COMMAND [ARGS]...
|
|
|
585
606
|
|
|
586
607
|
**Commands**:
|
|
587
608
|
|
|
609
|
+
* `plan`: Executes a plan for purging sources or...
|
|
588
610
|
* `apply`: Applies a purge of deployed metrics or...
|
|
589
611
|
* `export`: Exports existing metrics into a valid...
|
|
590
|
-
* `plan`: Executes a plan for purging sources or...
|
|
591
612
|
|
|
592
|
-
## `bigeye bigconfig
|
|
613
|
+
## `bigeye bigconfig plan`
|
|
593
614
|
|
|
594
|
-
|
|
595
|
-
|
|
615
|
+
Executes a plan for purging sources or processing bigconfig files in the input path/current
|
|
616
|
+
working directory.
|
|
596
617
|
|
|
597
618
|
**Usage**:
|
|
598
619
|
|
|
599
620
|
```console
|
|
600
|
-
$ bigeye bigconfig
|
|
621
|
+
$ bigeye bigconfig plan [OPTIONS]
|
|
601
622
|
```
|
|
602
623
|
|
|
603
624
|
**Options**:
|
|
@@ -612,17 +633,18 @@ $ bigeye bigconfig apply [OPTIONS]
|
|
|
612
633
|
* `-nq, --no_queue`: Don't submit to queue: True or False.
|
|
613
634
|
* `-r, --recursive`: Search all input directories recursively.
|
|
614
635
|
* `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
|
|
615
|
-
* `-
|
|
636
|
+
* `-cicd, --cicd_report`: Add the report to a pull request. (Github only)
|
|
616
637
|
* `--help`: Show this message and exit.
|
|
617
638
|
|
|
618
|
-
## `bigeye bigconfig
|
|
639
|
+
## `bigeye bigconfig apply`
|
|
619
640
|
|
|
620
|
-
|
|
641
|
+
Applies a purge of deployed metrics or applies Bigconfig files from the input path/current working directory to
|
|
642
|
+
the Bigeye workspace.
|
|
621
643
|
|
|
622
644
|
**Usage**:
|
|
623
645
|
|
|
624
646
|
```console
|
|
625
|
-
$ bigeye bigconfig
|
|
647
|
+
$ bigeye bigconfig apply [OPTIONS]
|
|
626
648
|
```
|
|
627
649
|
|
|
628
650
|
**Options**:
|
|
@@ -630,21 +652,24 @@ $ bigeye bigconfig export [OPTIONS]
|
|
|
630
652
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
631
653
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
632
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.
|
|
633
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.
|
|
634
|
-
* `-
|
|
635
|
-
* `-
|
|
636
|
-
* `-
|
|
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'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.
|
|
637
663
|
* `--help`: Show this message and exit.
|
|
638
664
|
|
|
639
|
-
## `bigeye bigconfig
|
|
665
|
+
## `bigeye bigconfig export`
|
|
640
666
|
|
|
641
|
-
|
|
642
|
-
working directory.
|
|
667
|
+
Exports existing metrics into a valid Bigconfig file.
|
|
643
668
|
|
|
644
669
|
**Usage**:
|
|
645
670
|
|
|
646
671
|
```console
|
|
647
|
-
$ bigeye bigconfig
|
|
672
|
+
$ bigeye bigconfig export [OPTIONS]
|
|
648
673
|
```
|
|
649
674
|
|
|
650
675
|
**Options**:
|
|
@@ -652,14 +677,10 @@ $ bigeye bigconfig plan [OPTIONS]
|
|
|
652
677
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
653
678
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
654
679
|
* `-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.
|
|
656
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.
|
|
657
|
-
* `-
|
|
658
|
-
* `-
|
|
659
|
-
* `-
|
|
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
|
-
* `-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.
|
|
663
684
|
* `--help`: Show this message and exit.
|
|
664
685
|
|
|
665
686
|
# `bigeye catalog`
|
|
@@ -680,39 +701,40 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
|
|
|
680
701
|
|
|
681
702
|
**Commands**:
|
|
682
703
|
|
|
683
|
-
* `
|
|
684
|
-
* `backfill-autothresholds`: Backfills autothresholds by warehouse id,...
|
|
685
|
-
* `backfill-metrics`: Backfills metrics by warehouse id, schema...
|
|
704
|
+
* `regen-autometrics`: Regenerates Autometrics by warehouse id OR...
|
|
686
705
|
* `delete-metrics`: Delete metrics in a warehouse id, by...
|
|
687
|
-
* `delete-source`: Delete a source from specified Bigeye...
|
|
688
|
-
* `delete-template`: Delete a template.
|
|
689
|
-
* `delete-virtual-table`: Delete a virtual table.
|
|
690
|
-
* `get-all-metric-templates`: Retrieve all metric templates and output...
|
|
691
|
-
* `get-metric-info`: Outputs metric info to a file.
|
|
692
|
-
* `get-metric-queries`: Gets the debug queries for all metrics by...
|
|
693
|
-
* `get-table-info`: Outputs table info to a file for an entire...
|
|
694
|
-
* `ingest-dbt-core-run-info`: Ingest manifest.json and run_results.json...
|
|
695
|
-
* `ingest-owners-from-dbt`: Ingest table owners from dbt manifest.json...
|
|
696
706
|
* `rebuild`: Rebuilds/Reprofiles a source by warehouse...
|
|
697
|
-
* `
|
|
707
|
+
* `get-table-info`: Outputs table info to a file for an entire...
|
|
708
|
+
* `get-metric-info`: Outputs metric info to a file.
|
|
698
709
|
* `run-metrics`: Runs metrics by warehouse id, schema...
|
|
710
|
+
* `add-source`: Adds a source to specified Bigeye workspace.
|
|
711
|
+
* `delete-source`: Delete a source from specified Bigeye...
|
|
712
|
+
* `backfill-autothresholds`: Backfills autothresholds by warehouse id,...
|
|
713
|
+
* `backfill-metrics`: Backfills metrics by warehouse id, schema...
|
|
699
714
|
* `schedule-all-metrics`: Updates schedule for all metrics in a...
|
|
700
|
-
* `set-metric-time`: Sets metric times from a list of possible...
|
|
701
|
-
* `track-schema-changes`: Track schema changes for sources on demand...
|
|
702
715
|
* `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
|
|
716
|
+
* `set-metric-time`: Sets metric times from a list of possible...
|
|
703
717
|
* `unset-metric-time`: Unsets metric times for whole warehouse or...
|
|
718
|
+
* `get-metric-queries`: Gets the debug queries for all metrics by...
|
|
704
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.
|
|
705
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...
|
|
706
729
|
|
|
707
|
-
## `bigeye catalog
|
|
730
|
+
## `bigeye catalog regen-autometrics`
|
|
708
731
|
|
|
709
|
-
|
|
710
|
-
locally in file.
|
|
732
|
+
Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids.
|
|
711
733
|
|
|
712
734
|
**Usage**:
|
|
713
735
|
|
|
714
736
|
```console
|
|
715
|
-
$ bigeye catalog
|
|
737
|
+
$ bigeye catalog regen-autometrics [OPTIONS]
|
|
716
738
|
```
|
|
717
739
|
|
|
718
740
|
**Options**:
|
|
@@ -720,19 +742,20 @@ $ bigeye catalog add-source [OPTIONS]
|
|
|
720
742
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
721
743
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
722
744
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
723
|
-
* `-
|
|
724
|
-
* `-
|
|
725
|
-
* `-
|
|
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
|
|
726
748
|
* `--help`: Show this message and exit.
|
|
727
749
|
|
|
728
|
-
## `bigeye catalog
|
|
750
|
+
## `bigeye catalog delete-metrics`
|
|
729
751
|
|
|
730
|
-
|
|
752
|
+
Delete metrics in a warehouse id, by schema names, or by table_ids. Also, can filter by multipe
|
|
753
|
+
metric types.
|
|
731
754
|
|
|
732
755
|
**Usage**:
|
|
733
756
|
|
|
734
757
|
```console
|
|
735
|
-
$ bigeye catalog
|
|
758
|
+
$ bigeye catalog delete-metrics [OPTIONS]
|
|
736
759
|
```
|
|
737
760
|
|
|
738
761
|
**Options**:
|
|
@@ -743,16 +766,36 @@ $ bigeye catalog backfill-autothresholds [OPTIONS]
|
|
|
743
766
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
744
767
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
745
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
|
|
746
770
|
* `--help`: Show this message and exit.
|
|
747
771
|
|
|
748
|
-
## `bigeye catalog
|
|
772
|
+
## `bigeye catalog rebuild`
|
|
749
773
|
|
|
750
|
-
|
|
774
|
+
Rebuilds/Reprofiles a source by warehouse id or a schema by warehouse id and schema name.
|
|
751
775
|
|
|
752
776
|
**Usage**:
|
|
753
777
|
|
|
754
778
|
```console
|
|
755
|
-
$ bigeye catalog
|
|
779
|
+
$ bigeye catalog rebuild [OPTIONS]
|
|
780
|
+
```
|
|
781
|
+
|
|
782
|
+
**Options**:
|
|
783
|
+
|
|
784
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
785
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
786
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
787
|
+
* `-wid, --warehouse_id INTEGER`: Warehouse ID [required]
|
|
788
|
+
* `-sn, --schema_name TEXT`: Schema Name
|
|
789
|
+
* `--help`: Show this message and exit.
|
|
790
|
+
|
|
791
|
+
## `bigeye catalog get-table-info`
|
|
792
|
+
|
|
793
|
+
Outputs table info to a file for an entire warehouse, certain schemas, or certain tables.
|
|
794
|
+
|
|
795
|
+
**Usage**:
|
|
796
|
+
|
|
797
|
+
```console
|
|
798
|
+
$ bigeye catalog get-table-info [OPTIONS]
|
|
756
799
|
```
|
|
757
800
|
|
|
758
801
|
**Options**:
|
|
@@ -762,20 +805,19 @@ $ bigeye catalog backfill-metrics [OPTIONS]
|
|
|
762
805
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
763
806
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
764
807
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
765
|
-
* `-tid, --table_id INTEGER`: Table IDs.
|
|
766
|
-
*
|
|
767
|
-
* `-
|
|
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]
|
|
768
811
|
* `--help`: Show this message and exit.
|
|
769
812
|
|
|
770
|
-
## `bigeye catalog
|
|
813
|
+
## `bigeye catalog get-metric-info`
|
|
771
814
|
|
|
772
|
-
|
|
773
|
-
metric types.
|
|
815
|
+
Outputs metric info to a file. Includes metric configuration and details about recent runs.
|
|
774
816
|
|
|
775
817
|
**Usage**:
|
|
776
818
|
|
|
777
819
|
```console
|
|
778
|
-
$ bigeye catalog
|
|
820
|
+
$ bigeye catalog get-metric-info [OPTIONS]
|
|
779
821
|
```
|
|
780
822
|
|
|
781
823
|
**Options**:
|
|
@@ -785,18 +827,20 @@ $ bigeye catalog delete-metrics [OPTIONS]
|
|
|
785
827
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
786
828
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
787
829
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
788
|
-
* `-tid, --table_id INTEGER`: Table IDs.
|
|
789
|
-
* `-
|
|
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.
|
|
790
834
|
* `--help`: Show this message and exit.
|
|
791
835
|
|
|
792
|
-
## `bigeye catalog
|
|
836
|
+
## `bigeye catalog run-metrics`
|
|
793
837
|
|
|
794
|
-
|
|
838
|
+
Runs metrics by warehouse id, schema names, and/or table ids
|
|
795
839
|
|
|
796
840
|
**Usage**:
|
|
797
841
|
|
|
798
842
|
```console
|
|
799
|
-
$ bigeye catalog
|
|
843
|
+
$ bigeye catalog run-metrics [OPTIONS]
|
|
800
844
|
```
|
|
801
845
|
|
|
802
846
|
**Options**:
|
|
@@ -804,17 +848,21 @@ $ bigeye catalog delete-source [OPTIONS]
|
|
|
804
848
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
805
849
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
806
850
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
807
|
-
* `-wid, --warehouse_id INTEGER`:
|
|
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)
|
|
808
855
|
* `--help`: Show this message and exit.
|
|
809
856
|
|
|
810
|
-
## `bigeye catalog
|
|
857
|
+
## `bigeye catalog add-source`
|
|
811
858
|
|
|
812
|
-
|
|
859
|
+
Adds a source to specified Bigeye workspace. Supports either source configs stored in AWS Secrets manager OR
|
|
860
|
+
locally in file.
|
|
813
861
|
|
|
814
862
|
**Usage**:
|
|
815
863
|
|
|
816
864
|
```console
|
|
817
|
-
$ bigeye catalog
|
|
865
|
+
$ bigeye catalog add-source [OPTIONS]
|
|
818
866
|
```
|
|
819
867
|
|
|
820
868
|
**Options**:
|
|
@@ -822,17 +870,19 @@ $ bigeye catalog delete-template [OPTIONS]
|
|
|
822
870
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
823
871
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
824
872
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
825
|
-
* `-
|
|
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.
|
|
826
876
|
* `--help`: Show this message and exit.
|
|
827
877
|
|
|
828
|
-
## `bigeye catalog delete-
|
|
878
|
+
## `bigeye catalog delete-source`
|
|
829
879
|
|
|
830
|
-
Delete a
|
|
880
|
+
Delete a source from specified Bigeye workspace.
|
|
831
881
|
|
|
832
882
|
**Usage**:
|
|
833
883
|
|
|
834
884
|
```console
|
|
835
|
-
$ bigeye catalog delete-
|
|
885
|
+
$ bigeye catalog delete-source [OPTIONS]
|
|
836
886
|
```
|
|
837
887
|
|
|
838
888
|
**Options**:
|
|
@@ -840,18 +890,17 @@ $ bigeye catalog delete-virtual-table [OPTIONS]
|
|
|
840
890
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
841
891
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
842
892
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
843
|
-
* `-
|
|
844
|
-
* `-sn, --source_name TEXT`: The name of the source where the template will be defined [required]
|
|
893
|
+
* `-wid, --warehouse_id INTEGER`: The ID of the warehouse to delete.
|
|
845
894
|
* `--help`: Show this message and exit.
|
|
846
895
|
|
|
847
|
-
## `bigeye catalog
|
|
896
|
+
## `bigeye catalog backfill-autothresholds`
|
|
848
897
|
|
|
849
|
-
|
|
898
|
+
Backfills autothresholds by warehouse id, schema names, and/or table ids.
|
|
850
899
|
|
|
851
900
|
**Usage**:
|
|
852
901
|
|
|
853
902
|
```console
|
|
854
|
-
$ bigeye catalog
|
|
903
|
+
$ bigeye catalog backfill-autothresholds [OPTIONS]
|
|
855
904
|
```
|
|
856
905
|
|
|
857
906
|
**Options**:
|
|
@@ -859,20 +908,19 @@ $ bigeye catalog get-all-metric-templates [OPTIONS]
|
|
|
859
908
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
860
909
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
861
910
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
862
|
-
* `-
|
|
863
|
-
* `-
|
|
864
|
-
* `-
|
|
865
|
-
* `-fn, --file_name TEXT`: User defined file name
|
|
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
|
|
866
914
|
* `--help`: Show this message and exit.
|
|
867
915
|
|
|
868
|
-
## `bigeye catalog
|
|
916
|
+
## `bigeye catalog backfill-metrics`
|
|
869
917
|
|
|
870
|
-
|
|
918
|
+
Backfills metrics by warehouse id, schema names, and/or table ids.
|
|
871
919
|
|
|
872
920
|
**Usage**:
|
|
873
921
|
|
|
874
922
|
```console
|
|
875
|
-
$ bigeye catalog
|
|
923
|
+
$ bigeye catalog backfill-metrics [OPTIONS]
|
|
876
924
|
```
|
|
877
925
|
|
|
878
926
|
**Options**:
|
|
@@ -882,20 +930,19 @@ $ bigeye catalog get-metric-info [OPTIONS]
|
|
|
882
930
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
883
931
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
884
932
|
* `-sn, --schema_name TEXT`: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
|
|
885
|
-
* `-tid, --table_id INTEGER`: Table IDs.
|
|
886
|
-
*
|
|
887
|
-
* `-
|
|
888
|
-
* `--conf_only`: Output only the metric configuration.
|
|
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)
|
|
889
936
|
* `--help`: Show this message and exit.
|
|
890
937
|
|
|
891
|
-
## `bigeye catalog
|
|
938
|
+
## `bigeye catalog schedule-all-metrics`
|
|
892
939
|
|
|
893
|
-
|
|
940
|
+
Updates schedule for all metrics in a warehouse.
|
|
894
941
|
|
|
895
942
|
**Usage**:
|
|
896
943
|
|
|
897
944
|
```console
|
|
898
|
-
$ bigeye catalog
|
|
945
|
+
$ bigeye catalog schedule-all-metrics [OPTIONS]
|
|
899
946
|
```
|
|
900
947
|
|
|
901
948
|
**Options**:
|
|
@@ -904,19 +951,47 @@ $ bigeye catalog get-metric-queries [OPTIONS]
|
|
|
904
951
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
905
952
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
906
953
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
907
|
-
* `-
|
|
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]
|
|
964
|
+
* `--help`: Show this message and exit.
|
|
965
|
+
|
|
966
|
+
## `bigeye catalog unschedule-all-metrics`
|
|
967
|
+
|
|
968
|
+
Unschedule all metrics by warehouse, schema or tables.
|
|
969
|
+
|
|
970
|
+
**Usage**:
|
|
971
|
+
|
|
972
|
+
```console
|
|
973
|
+
$ bigeye catalog unschedule-all-metrics [OPTIONS]
|
|
974
|
+
```
|
|
975
|
+
|
|
976
|
+
**Options**:
|
|
977
|
+
|
|
978
|
+
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
979
|
+
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
980
|
+
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
981
|
+
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
982
|
+
* `-sn, --schema_name TEXT`: List of Schema Name. E.g. -sn schema_1.
|
|
908
983
|
* `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
|
|
909
|
-
* `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
|
|
910
984
|
* `--help`: Show this message and exit.
|
|
911
985
|
|
|
912
|
-
## `bigeye catalog
|
|
986
|
+
## `bigeye catalog set-metric-time`
|
|
913
987
|
|
|
914
|
-
|
|
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.
|
|
915
990
|
|
|
916
991
|
**Usage**:
|
|
917
992
|
|
|
918
993
|
```console
|
|
919
|
-
$ bigeye catalog
|
|
994
|
+
$ bigeye catalog set-metric-time [OPTIONS]
|
|
920
995
|
```
|
|
921
996
|
|
|
922
997
|
**Options**:
|
|
@@ -925,20 +1000,20 @@ $ bigeye catalog get-table-info [OPTIONS]
|
|
|
925
1000
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
926
1001
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
927
1002
|
* `-wid, --warehouse_id INTEGER`: Warehouse ID
|
|
928
|
-
* `-
|
|
929
|
-
* `-tid, --table_id INTEGER`:
|
|
930
|
-
* `-
|
|
931
|
-
* `-
|
|
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.
|
|
932
1007
|
* `--help`: Show this message and exit.
|
|
933
1008
|
|
|
934
|
-
## `bigeye catalog
|
|
1009
|
+
## `bigeye catalog unset-metric-time`
|
|
935
1010
|
|
|
936
|
-
|
|
1011
|
+
Unsets metric times for whole warehouse or for a list og table IDs.
|
|
937
1012
|
|
|
938
1013
|
**Usage**:
|
|
939
1014
|
|
|
940
1015
|
```console
|
|
941
|
-
$ bigeye catalog
|
|
1016
|
+
$ bigeye catalog unset-metric-time [OPTIONS]
|
|
942
1017
|
```
|
|
943
1018
|
|
|
944
1019
|
**Options**:
|
|
@@ -946,23 +1021,18 @@ $ bigeye catalog ingest-dbt-core-run-info [OPTIONS]
|
|
|
946
1021
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
947
1022
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
948
1023
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
949
|
-
* `-
|
|
950
|
-
* `-
|
|
951
|
-
* `-jn, --job_name TEXT`: The name of the dbt job.
|
|
952
|
-
* `-jid, --job_run_id TEXT`: The ID of the dbt job run.
|
|
953
|
-
* `-purl, --project_url TEXT`: The URL of the project.
|
|
954
|
-
* `-jurl, --job_url TEXT`: The URL of the job.
|
|
955
|
-
* `-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.
|
|
956
1026
|
* `--help`: Show this message and exit.
|
|
957
1027
|
|
|
958
|
-
## `bigeye catalog
|
|
1028
|
+
## `bigeye catalog get-metric-queries`
|
|
959
1029
|
|
|
960
|
-
|
|
1030
|
+
Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
|
|
961
1031
|
|
|
962
1032
|
**Usage**:
|
|
963
1033
|
|
|
964
1034
|
```console
|
|
965
|
-
$ bigeye catalog
|
|
1035
|
+
$ bigeye catalog get-metric-queries [OPTIONS]
|
|
966
1036
|
```
|
|
967
1037
|
|
|
968
1038
|
**Options**:
|
|
@@ -970,19 +1040,20 @@ $ bigeye catalog ingest-owners-from-dbt [OPTIONS]
|
|
|
970
1040
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
971
1041
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
972
1042
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
973
|
-
* `-
|
|
974
|
-
* `-sn, --
|
|
975
|
-
* `-
|
|
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]
|
|
976
1047
|
* `--help`: Show this message and exit.
|
|
977
1048
|
|
|
978
|
-
## `bigeye catalog
|
|
1049
|
+
## `bigeye catalog upsert-template`
|
|
979
1050
|
|
|
980
|
-
|
|
1051
|
+
Create or update a template for a source. Files have priority over arguments
|
|
981
1052
|
|
|
982
1053
|
**Usage**:
|
|
983
1054
|
|
|
984
1055
|
```console
|
|
985
|
-
$ bigeye catalog
|
|
1056
|
+
$ bigeye catalog upsert-template [OPTIONS]
|
|
986
1057
|
```
|
|
987
1058
|
|
|
988
1059
|
**Options**:
|
|
@@ -990,18 +1061,22 @@ $ bigeye catalog rebuild [OPTIONS]
|
|
|
990
1061
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
991
1062
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
992
1063
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
993
|
-
* `-
|
|
994
|
-
* `-
|
|
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.
|
|
995
1070
|
* `--help`: Show this message and exit.
|
|
996
1071
|
|
|
997
|
-
## `bigeye catalog
|
|
1072
|
+
## `bigeye catalog export-metric-template`
|
|
998
1073
|
|
|
999
|
-
|
|
1074
|
+
Export metric templates to yaml files
|
|
1000
1075
|
|
|
1001
1076
|
**Usage**:
|
|
1002
1077
|
|
|
1003
1078
|
```console
|
|
1004
|
-
$ bigeye catalog
|
|
1079
|
+
$ bigeye catalog export-metric-template [OPTIONS]
|
|
1005
1080
|
```
|
|
1006
1081
|
|
|
1007
1082
|
**Options**:
|
|
@@ -1009,19 +1084,18 @@ $ bigeye catalog regen-autometrics [OPTIONS]
|
|
|
1009
1084
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1010
1085
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1011
1086
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1012
|
-
* `-
|
|
1013
|
-
* `-
|
|
1014
|
-
* `-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
|
|
1015
1089
|
* `--help`: Show this message and exit.
|
|
1016
1090
|
|
|
1017
|
-
## `bigeye catalog
|
|
1091
|
+
## `bigeye catalog get-all-metric-templates`
|
|
1018
1092
|
|
|
1019
|
-
|
|
1093
|
+
Retrieve all metric templates and output to a file.
|
|
1020
1094
|
|
|
1021
1095
|
**Usage**:
|
|
1022
1096
|
|
|
1023
1097
|
```console
|
|
1024
|
-
$ bigeye catalog
|
|
1098
|
+
$ bigeye catalog get-all-metric-templates [OPTIONS]
|
|
1025
1099
|
```
|
|
1026
1100
|
|
|
1027
1101
|
**Options**:
|
|
@@ -1029,20 +1103,20 @@ $ bigeye catalog run-metrics [OPTIONS]
|
|
|
1029
1103
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1030
1104
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1031
1105
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1032
|
-
* `-
|
|
1033
|
-
* `-
|
|
1034
|
-
* `-
|
|
1035
|
-
* `-
|
|
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
|
|
1036
1110
|
* `--help`: Show this message and exit.
|
|
1037
1111
|
|
|
1038
|
-
## `bigeye catalog
|
|
1112
|
+
## `bigeye catalog delete-template`
|
|
1039
1113
|
|
|
1040
|
-
|
|
1114
|
+
Delete a template.
|
|
1041
1115
|
|
|
1042
1116
|
**Usage**:
|
|
1043
1117
|
|
|
1044
1118
|
```console
|
|
1045
|
-
$ bigeye catalog
|
|
1119
|
+
$ bigeye catalog delete-template [OPTIONS]
|
|
1046
1120
|
```
|
|
1047
1121
|
|
|
1048
1122
|
**Options**:
|
|
@@ -1050,28 +1124,18 @@ $ bigeye catalog schedule-all-metrics [OPTIONS]
|
|
|
1050
1124
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1051
1125
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1052
1126
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1053
|
-
* `-
|
|
1054
|
-
* `-
|
|
1055
|
-
UNDEFINED_TIME_INTERVAL_TYPE:0
|
|
1056
|
-
HOURS_TIME_INTERVAL_TYPE:1
|
|
1057
|
-
MINUTES_TIME_INTERVAL_TYPE:2
|
|
1058
|
-
SECONDS_TIME_INTERVAL_TYPE:3
|
|
1059
|
-
DAYS_TIME_INTERVAL_TYPE:4
|
|
1060
|
-
WEEKDAYS_TIME_INTERVAL_TYPE:5
|
|
1061
|
-
MARKET_DAYS_TIME_INTERVAL_TYPE:6
|
|
1062
|
-
MONTHS_TIME_INTERVAL_TYPE:7 [default: 1]
|
|
1063
|
-
* `-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
|
|
1064
1129
|
* `--help`: Show this message and exit.
|
|
1065
1130
|
|
|
1066
|
-
## `bigeye catalog
|
|
1131
|
+
## `bigeye catalog upsert-virtual-table`
|
|
1067
1132
|
|
|
1068
|
-
|
|
1069
|
-
table IDs.
|
|
1133
|
+
Create or update a virtual table. Files have priority over arguments
|
|
1070
1134
|
|
|
1071
1135
|
**Usage**:
|
|
1072
1136
|
|
|
1073
1137
|
```console
|
|
1074
|
-
$ bigeye catalog
|
|
1138
|
+
$ bigeye catalog upsert-virtual-table [OPTIONS]
|
|
1075
1139
|
```
|
|
1076
1140
|
|
|
1077
1141
|
**Options**:
|
|
@@ -1079,22 +1143,21 @@ $ bigeye catalog set-metric-time [OPTIONS]
|
|
|
1079
1143
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1080
1144
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1081
1145
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1082
|
-
* `-
|
|
1083
|
-
* `-
|
|
1084
|
-
* `-
|
|
1085
|
-
* `-
|
|
1086
|
-
* `-
|
|
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.
|
|
1087
1151
|
* `--help`: Show this message and exit.
|
|
1088
1152
|
|
|
1089
|
-
## `bigeye catalog
|
|
1153
|
+
## `bigeye catalog delete-virtual-table`
|
|
1090
1154
|
|
|
1091
|
-
|
|
1092
|
-
Environment variables SMTP_USER and SMTP_PASSWORD MUST be set if using email notification.
|
|
1155
|
+
Delete a virtual table.
|
|
1093
1156
|
|
|
1094
1157
|
**Usage**:
|
|
1095
1158
|
|
|
1096
1159
|
```console
|
|
1097
|
-
$ bigeye catalog
|
|
1160
|
+
$ bigeye catalog delete-virtual-table [OPTIONS]
|
|
1098
1161
|
```
|
|
1099
1162
|
|
|
1100
1163
|
**Options**:
|
|
@@ -1102,24 +1165,18 @@ $ bigeye catalog track-schema-changes [OPTIONS]
|
|
|
1102
1165
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1103
1166
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1104
1167
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1105
|
-
* `-
|
|
1106
|
-
* `-
|
|
1107
|
-
* `-f, --frequency INTEGER`: Every n hours to check for schema changes. (None will only run the check once) [default: 0]
|
|
1108
|
-
* `-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]
|
|
1109
|
-
* `-nc, --channel TEXT`: A list of notification channels; e.g. -nc email@mydomain.com -nc #slack_channel -nc https://www.webhook.com
|
|
1110
|
-
* `-smtp, --server TEXT`: The server to send emails.
|
|
1111
|
-
* `-p, --port INTEGER`: The server port to send emails. [default: 587]
|
|
1112
|
-
* `-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]
|
|
1113
1170
|
* `--help`: Show this message and exit.
|
|
1114
1171
|
|
|
1115
|
-
## `bigeye catalog
|
|
1172
|
+
## `bigeye catalog export-virtual-table`
|
|
1116
1173
|
|
|
1117
|
-
|
|
1174
|
+
Export virtual table to yaml file
|
|
1118
1175
|
|
|
1119
1176
|
**Usage**:
|
|
1120
1177
|
|
|
1121
1178
|
```console
|
|
1122
|
-
$ bigeye catalog
|
|
1179
|
+
$ bigeye catalog export-virtual-table [OPTIONS]
|
|
1123
1180
|
```
|
|
1124
1181
|
|
|
1125
1182
|
**Options**:
|
|
@@ -1127,19 +1184,18 @@ $ bigeye catalog unschedule-all-metrics [OPTIONS]
|
|
|
1127
1184
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1128
1185
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1129
1186
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1130
|
-
* `-
|
|
1131
|
-
* `-
|
|
1132
|
-
* `-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
|
|
1133
1189
|
* `--help`: Show this message and exit.
|
|
1134
1190
|
|
|
1135
|
-
## `bigeye catalog
|
|
1191
|
+
## `bigeye catalog ingest-owners-from-dbt`
|
|
1136
1192
|
|
|
1137
|
-
|
|
1193
|
+
Ingest table owners from dbt manifest.json file.
|
|
1138
1194
|
|
|
1139
1195
|
**Usage**:
|
|
1140
1196
|
|
|
1141
1197
|
```console
|
|
1142
|
-
$ bigeye catalog
|
|
1198
|
+
$ bigeye catalog ingest-owners-from-dbt [OPTIONS]
|
|
1143
1199
|
```
|
|
1144
1200
|
|
|
1145
1201
|
**Options**:
|
|
@@ -1147,18 +1203,19 @@ $ bigeye catalog unset-metric-time [OPTIONS]
|
|
|
1147
1203
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1148
1204
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1149
1205
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1150
|
-
* `-
|
|
1151
|
-
* `-
|
|
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.
|
|
1152
1209
|
* `--help`: Show this message and exit.
|
|
1153
1210
|
|
|
1154
|
-
## `bigeye catalog
|
|
1211
|
+
## `bigeye catalog ingest-dbt-core-run-info`
|
|
1155
1212
|
|
|
1156
|
-
|
|
1213
|
+
Ingest manifest.json and run_results.json from different dbt commands.
|
|
1157
1214
|
|
|
1158
1215
|
**Usage**:
|
|
1159
1216
|
|
|
1160
1217
|
```console
|
|
1161
|
-
$ bigeye catalog
|
|
1218
|
+
$ bigeye catalog ingest-dbt-core-run-info [OPTIONS]
|
|
1162
1219
|
```
|
|
1163
1220
|
|
|
1164
1221
|
**Options**:
|
|
@@ -1166,23 +1223,24 @@ $ bigeye catalog upsert-template [OPTIONS]
|
|
|
1166
1223
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1167
1224
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1168
1225
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1169
|
-
* `-
|
|
1170
|
-
* `-
|
|
1171
|
-
* `-
|
|
1172
|
-
* `-
|
|
1173
|
-
* `-
|
|
1174
|
-
* `-
|
|
1175
|
-
* `-
|
|
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.
|
|
1176
1233
|
* `--help`: Show this message and exit.
|
|
1177
1234
|
|
|
1178
|
-
## `bigeye catalog
|
|
1235
|
+
## `bigeye catalog track-schema-changes`
|
|
1179
1236
|
|
|
1180
|
-
|
|
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.
|
|
1181
1239
|
|
|
1182
1240
|
**Usage**:
|
|
1183
1241
|
|
|
1184
1242
|
```console
|
|
1185
|
-
$ bigeye catalog
|
|
1243
|
+
$ bigeye catalog track-schema-changes [OPTIONS]
|
|
1186
1244
|
```
|
|
1187
1245
|
|
|
1188
1246
|
**Options**:
|
|
@@ -1190,10 +1248,14 @@ $ bigeye catalog upsert-virtual-table [OPTIONS]
|
|
|
1190
1248
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1191
1249
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1192
1250
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1193
|
-
* `-
|
|
1194
|
-
* `-s, --
|
|
1195
|
-
* `-
|
|
1196
|
-
* `-
|
|
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)
|
|
1197
1259
|
* `--help`: Show this message and exit.
|
|
1198
1260
|
|
|
1199
1261
|
# `bigeye metric`
|
|
@@ -1214,21 +1276,21 @@ $ bigeye metric [OPTIONS] COMMAND [ARGS]...
|
|
|
1214
1276
|
|
|
1215
1277
|
**Commands**:
|
|
1216
1278
|
|
|
1217
|
-
* `dbt-tests-to-metrics`: Convert tests in a dbt schema.yml to...
|
|
1218
|
-
* `get-info`: Outputs metric info to a file.
|
|
1219
|
-
* `get-metric-queries`: Gets the debug queries for all metrics by...
|
|
1220
1279
|
* `run`: Run metric by id(s)
|
|
1221
|
-
* `
|
|
1280
|
+
* `get-info`: Outputs metric info to a file.
|
|
1222
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...
|
|
1223
1285
|
|
|
1224
|
-
## `bigeye metric
|
|
1286
|
+
## `bigeye metric run`
|
|
1225
1287
|
|
|
1226
|
-
|
|
1288
|
+
Run metric by id(s)
|
|
1227
1289
|
|
|
1228
1290
|
**Usage**:
|
|
1229
1291
|
|
|
1230
1292
|
```console
|
|
1231
|
-
$ bigeye metric
|
|
1293
|
+
$ bigeye metric run [OPTIONS]
|
|
1232
1294
|
```
|
|
1233
1295
|
|
|
1234
1296
|
**Options**:
|
|
@@ -1236,12 +1298,8 @@ $ bigeye metric dbt-tests-to-metrics [OPTIONS]
|
|
|
1236
1298
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1237
1299
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1238
1300
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1239
|
-
* `-
|
|
1240
|
-
* `-
|
|
1241
|
-
* `-sf, --schema_file TEXT`: The path to the dbt schema file [required]
|
|
1242
|
-
* `-auto, --use_auto`: Use autothresholds over default constant
|
|
1243
|
-
* `-bigconfig, --to_bigconfig`: Convert the dbt tests to bigconfig.
|
|
1244
|
-
* `-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)
|
|
1245
1303
|
* `--help`: Show this message and exit.
|
|
1246
1304
|
|
|
1247
1305
|
## `bigeye metric get-info`
|
|
@@ -1265,14 +1323,14 @@ $ bigeye metric get-info [OPTIONS]
|
|
|
1265
1323
|
* `--conf_only`: Output only the metric configuration.
|
|
1266
1324
|
* `--help`: Show this message and exit.
|
|
1267
1325
|
|
|
1268
|
-
## `bigeye metric
|
|
1326
|
+
## `bigeye metric upsert-from-path`
|
|
1269
1327
|
|
|
1270
|
-
|
|
1328
|
+
Upsert multiple metrics from files stored in path.
|
|
1271
1329
|
|
|
1272
1330
|
**Usage**:
|
|
1273
1331
|
|
|
1274
1332
|
```console
|
|
1275
|
-
$ bigeye metric
|
|
1333
|
+
$ bigeye metric upsert-from-path [OPTIONS]
|
|
1276
1334
|
```
|
|
1277
1335
|
|
|
1278
1336
|
**Options**:
|
|
@@ -1280,18 +1338,20 @@ $ bigeye metric get-metric-queries [OPTIONS]
|
|
|
1280
1338
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1281
1339
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1282
1340
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1283
|
-
* `-
|
|
1284
|
-
* `-
|
|
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.
|
|
1285
1345
|
* `--help`: Show this message and exit.
|
|
1286
1346
|
|
|
1287
|
-
## `bigeye metric
|
|
1347
|
+
## `bigeye metric upsert`
|
|
1288
1348
|
|
|
1289
|
-
|
|
1349
|
+
Upsert single metric from file.
|
|
1290
1350
|
|
|
1291
1351
|
**Usage**:
|
|
1292
1352
|
|
|
1293
1353
|
```console
|
|
1294
|
-
$ bigeye metric
|
|
1354
|
+
$ bigeye metric upsert [OPTIONS]
|
|
1295
1355
|
```
|
|
1296
1356
|
|
|
1297
1357
|
**Options**:
|
|
@@ -1299,18 +1359,20 @@ $ bigeye metric run [OPTIONS]
|
|
|
1299
1359
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1300
1360
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1301
1361
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1302
|
-
* `-
|
|
1303
|
-
* `-
|
|
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.
|
|
1304
1366
|
* `--help`: Show this message and exit.
|
|
1305
1367
|
|
|
1306
|
-
## `bigeye metric
|
|
1368
|
+
## `bigeye metric get-metric-queries`
|
|
1307
1369
|
|
|
1308
|
-
|
|
1370
|
+
Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
|
|
1309
1371
|
|
|
1310
1372
|
**Usage**:
|
|
1311
1373
|
|
|
1312
1374
|
```console
|
|
1313
|
-
$ bigeye metric
|
|
1375
|
+
$ bigeye metric get-metric-queries [OPTIONS]
|
|
1314
1376
|
```
|
|
1315
1377
|
|
|
1316
1378
|
**Options**:
|
|
@@ -1318,20 +1380,18 @@ $ bigeye metric upsert [OPTIONS]
|
|
|
1318
1380
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1319
1381
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1320
1382
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1321
|
-
* `-
|
|
1322
|
-
* `-
|
|
1323
|
-
* `-wid, --warehouse_id INTEGER`: (Optional) Warehouse ID. If specified it will reduce the text based search for the table.warehouse
|
|
1324
|
-
* `-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]
|
|
1325
1385
|
* `--help`: Show this message and exit.
|
|
1326
1386
|
|
|
1327
|
-
## `bigeye metric
|
|
1387
|
+
## `bigeye metric dbt-tests-to-metrics`
|
|
1328
1388
|
|
|
1329
|
-
|
|
1389
|
+
Convert tests in a dbt schema.yml to metrics in Bigeye
|
|
1330
1390
|
|
|
1331
1391
|
**Usage**:
|
|
1332
1392
|
|
|
1333
1393
|
```console
|
|
1334
|
-
$ bigeye metric
|
|
1394
|
+
$ bigeye metric dbt-tests-to-metrics [OPTIONS]
|
|
1335
1395
|
```
|
|
1336
1396
|
|
|
1337
1397
|
**Options**:
|
|
@@ -1339,10 +1399,12 @@ $ bigeye metric upsert-from-path [OPTIONS]
|
|
|
1339
1399
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1340
1400
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1341
1401
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1342
|
-
* `-
|
|
1343
|
-
* `-
|
|
1344
|
-
* `-
|
|
1345
|
-
* `-
|
|
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]
|
|
1346
1408
|
* `--help`: Show this message and exit.
|
|
1347
1409
|
|
|
1348
1410
|
# `bigeye issues`
|
|
@@ -1429,20 +1491,20 @@ $ bigeye deltas [OPTIONS] COMMAND [ARGS]...
|
|
|
1429
1491
|
|
|
1430
1492
|
**Commands**:
|
|
1431
1493
|
|
|
1432
|
-
* `
|
|
1494
|
+
* `suggest-deltas`: Suggests and creates Deltas with default...
|
|
1433
1495
|
* `create-delta`: Creates deltas between tables from a...
|
|
1434
|
-
* `create-template`: Create a template delta configuration file...
|
|
1435
1496
|
* `run-delta`: Runs a delta by Delta ID.
|
|
1436
|
-
* `
|
|
1497
|
+
* `create-template`: Create a template delta configuration file...
|
|
1498
|
+
* `cicd`: Creates a delta based on...
|
|
1437
1499
|
|
|
1438
|
-
## `bigeye deltas
|
|
1500
|
+
## `bigeye deltas suggest-deltas`
|
|
1439
1501
|
|
|
1440
|
-
|
|
1502
|
+
Suggests and creates Deltas with default behavior and outputs all Simple Delta Configurations to a file.
|
|
1441
1503
|
|
|
1442
1504
|
**Usage**:
|
|
1443
1505
|
|
|
1444
1506
|
```console
|
|
1445
|
-
$ bigeye deltas
|
|
1507
|
+
$ bigeye deltas suggest-deltas [OPTIONS]
|
|
1446
1508
|
```
|
|
1447
1509
|
|
|
1448
1510
|
**Options**:
|
|
@@ -1450,7 +1512,10 @@ $ bigeye deltas cicd [OPTIONS]
|
|
|
1450
1512
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1451
1513
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1452
1514
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1453
|
-
* `-
|
|
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]
|
|
1454
1519
|
* `--help`: Show this message and exit.
|
|
1455
1520
|
|
|
1456
1521
|
## `bigeye deltas create-delta`
|
|
@@ -1474,14 +1539,14 @@ $ bigeye deltas create-delta [OPTIONS]
|
|
|
1474
1539
|
* `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn't exist.
|
|
1475
1540
|
* `--help`: Show this message and exit.
|
|
1476
1541
|
|
|
1477
|
-
## `bigeye deltas
|
|
1542
|
+
## `bigeye deltas run-delta`
|
|
1478
1543
|
|
|
1479
|
-
|
|
1544
|
+
Runs a delta by Delta ID.
|
|
1480
1545
|
|
|
1481
1546
|
**Usage**:
|
|
1482
1547
|
|
|
1483
1548
|
```console
|
|
1484
|
-
$ bigeye deltas
|
|
1549
|
+
$ bigeye deltas run-delta [OPTIONS]
|
|
1485
1550
|
```
|
|
1486
1551
|
|
|
1487
1552
|
**Options**:
|
|
@@ -1489,19 +1554,18 @@ $ bigeye deltas create-template [OPTIONS]
|
|
|
1489
1554
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1490
1555
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1491
1556
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1492
|
-
* `-
|
|
1493
|
-
* `-
|
|
1494
|
-
* `-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.
|
|
1495
1559
|
* `--help`: Show this message and exit.
|
|
1496
1560
|
|
|
1497
|
-
## `bigeye deltas
|
|
1561
|
+
## `bigeye deltas create-template`
|
|
1498
1562
|
|
|
1499
|
-
|
|
1563
|
+
Create a template delta configuration file based on table names.
|
|
1500
1564
|
|
|
1501
1565
|
**Usage**:
|
|
1502
1566
|
|
|
1503
1567
|
```console
|
|
1504
|
-
$ bigeye deltas
|
|
1568
|
+
$ bigeye deltas create-template [OPTIONS]
|
|
1505
1569
|
```
|
|
1506
1570
|
|
|
1507
1571
|
**Options**:
|
|
@@ -1509,18 +1573,19 @@ $ bigeye deltas run-delta [OPTIONS]
|
|
|
1509
1573
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1510
1574
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1511
1575
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1512
|
-
* `-
|
|
1513
|
-
* `-
|
|
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]
|
|
1514
1579
|
* `--help`: Show this message and exit.
|
|
1515
1580
|
|
|
1516
|
-
## `bigeye deltas
|
|
1581
|
+
## `bigeye deltas cicd`
|
|
1517
1582
|
|
|
1518
|
-
|
|
1583
|
+
Creates a delta based on SimpleDeltaConfiguration and integrates the results with the provided VCS vendor.
|
|
1519
1584
|
|
|
1520
1585
|
**Usage**:
|
|
1521
1586
|
|
|
1522
1587
|
```console
|
|
1523
|
-
$ bigeye deltas
|
|
1588
|
+
$ bigeye deltas cicd [OPTIONS]
|
|
1524
1589
|
```
|
|
1525
1590
|
|
|
1526
1591
|
**Options**:
|
|
@@ -1528,10 +1593,7 @@ $ bigeye deltas suggest-deltas [OPTIONS]
|
|
|
1528
1593
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1529
1594
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1530
1595
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1531
|
-
* `-
|
|
1532
|
-
* `-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]
|
|
1533
|
-
* `-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]
|
|
1534
|
-
* `-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]
|
|
1535
1597
|
* `--help`: Show this message and exit.
|
|
1536
1598
|
|
|
1537
1599
|
# `bigeye collections`
|
|
@@ -1553,11 +1615,11 @@ $ bigeye collections [OPTIONS] COMMAND [ARGS]...
|
|
|
1553
1615
|
**Commands**:
|
|
1554
1616
|
|
|
1555
1617
|
* `add-metric`: Add metric to a Collection.
|
|
1556
|
-
* `backfill-metrics`: Backfill all metrics in a Collection.
|
|
1557
1618
|
* `get-metric-info`: Get metric info for all metrics in...
|
|
1558
|
-
* `get-metric-queries`: Gets the debug queries for all metrics by...
|
|
1559
1619
|
* `migrate-from-json`: Loads metrics from Collection oriented...
|
|
1620
|
+
* `backfill-metrics`: Backfill all metrics in a Collection.
|
|
1560
1621
|
* `run-metrics`: Run all metrics in a Collection.
|
|
1622
|
+
* `get-metric-queries`: Gets the debug queries for all metrics by...
|
|
1561
1623
|
|
|
1562
1624
|
## `bigeye collections add-metric`
|
|
1563
1625
|
|
|
@@ -1578,14 +1640,14 @@ $ bigeye collections add-metric [OPTIONS]
|
|
|
1578
1640
|
* `-cid, --collection_id INTEGER`: Collection ID [required]
|
|
1579
1641
|
* `--help`: Show this message and exit.
|
|
1580
1642
|
|
|
1581
|
-
## `bigeye collections
|
|
1643
|
+
## `bigeye collections get-metric-info`
|
|
1582
1644
|
|
|
1583
|
-
|
|
1645
|
+
Get metric info for all metrics in Collection.
|
|
1584
1646
|
|
|
1585
1647
|
**Usage**:
|
|
1586
1648
|
|
|
1587
1649
|
```console
|
|
1588
|
-
$ bigeye collections
|
|
1650
|
+
$ bigeye collections get-metric-info [OPTIONS]
|
|
1589
1651
|
```
|
|
1590
1652
|
|
|
1591
1653
|
**Options**:
|
|
@@ -1595,18 +1657,18 @@ $ bigeye collections backfill-metrics [OPTIONS]
|
|
|
1595
1657
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1596
1658
|
* `--from_collections`: Scrapes all Collections in customer workspace for Metric Info.
|
|
1597
1659
|
* `--collection_ids INTEGER`: Collection IDs. Scrape certain Collections for Metric Info.
|
|
1598
|
-
*
|
|
1599
|
-
* `-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]
|
|
1600
1661
|
* `--help`: Show this message and exit.
|
|
1601
1662
|
|
|
1602
|
-
## `bigeye collections
|
|
1663
|
+
## `bigeye collections migrate-from-json`
|
|
1603
1664
|
|
|
1604
|
-
|
|
1665
|
+
Loads metrics from Collection oriented metric info output. Used to migrate metrics from one warehouse to
|
|
1666
|
+
another, identical, warehouse
|
|
1605
1667
|
|
|
1606
1668
|
**Usage**:
|
|
1607
1669
|
|
|
1608
1670
|
```console
|
|
1609
|
-
$ bigeye collections
|
|
1671
|
+
$ bigeye collections migrate-from-json [OPTIONS]
|
|
1610
1672
|
```
|
|
1611
1673
|
|
|
1612
1674
|
**Options**:
|
|
@@ -1614,19 +1676,20 @@ $ bigeye collections get-metric-info [OPTIONS]
|
|
|
1614
1676
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1615
1677
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1616
1678
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1617
|
-
*
|
|
1618
|
-
*
|
|
1619
|
-
* `-
|
|
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.
|
|
1620
1683
|
* `--help`: Show this message and exit.
|
|
1621
1684
|
|
|
1622
|
-
## `bigeye collections
|
|
1685
|
+
## `bigeye collections backfill-metrics`
|
|
1623
1686
|
|
|
1624
|
-
|
|
1687
|
+
Backfill all metrics in a Collection.
|
|
1625
1688
|
|
|
1626
1689
|
**Usage**:
|
|
1627
1690
|
|
|
1628
1691
|
```console
|
|
1629
|
-
$ bigeye collections
|
|
1692
|
+
$ bigeye collections backfill-metrics [OPTIONS]
|
|
1630
1693
|
```
|
|
1631
1694
|
|
|
1632
1695
|
**Options**:
|
|
@@ -1634,19 +1697,20 @@ $ bigeye collections get-metric-queries [OPTIONS]
|
|
|
1634
1697
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1635
1698
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1636
1699
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1637
|
-
*
|
|
1638
|
-
*
|
|
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)
|
|
1639
1704
|
* `--help`: Show this message and exit.
|
|
1640
1705
|
|
|
1641
|
-
## `bigeye collections
|
|
1706
|
+
## `bigeye collections run-metrics`
|
|
1642
1707
|
|
|
1643
|
-
|
|
1644
|
-
another, identical, warehouse
|
|
1708
|
+
Run all metrics in a Collection.
|
|
1645
1709
|
|
|
1646
1710
|
**Usage**:
|
|
1647
1711
|
|
|
1648
1712
|
```console
|
|
1649
|
-
$ bigeye collections
|
|
1713
|
+
$ bigeye collections run-metrics [OPTIONS]
|
|
1650
1714
|
```
|
|
1651
1715
|
|
|
1652
1716
|
**Options**:
|
|
@@ -1654,20 +1718,18 @@ $ bigeye collections migrate-from-json [OPTIONS]
|
|
|
1654
1718
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1655
1719
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1656
1720
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1657
|
-
* `-
|
|
1658
|
-
* `-
|
|
1659
|
-
* `-kn, --keep_notifications`: Keep Notifications from versioned or templated metric configuration.
|
|
1660
|
-
* `-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)
|
|
1661
1723
|
* `--help`: Show this message and exit.
|
|
1662
1724
|
|
|
1663
|
-
## `bigeye collections
|
|
1725
|
+
## `bigeye collections get-metric-queries`
|
|
1664
1726
|
|
|
1665
|
-
|
|
1727
|
+
Gets the debug queries for all metrics by warehouse id, schema names, or table ids.
|
|
1666
1728
|
|
|
1667
1729
|
**Usage**:
|
|
1668
1730
|
|
|
1669
1731
|
```console
|
|
1670
|
-
$ bigeye collections
|
|
1732
|
+
$ bigeye collections get-metric-queries [OPTIONS]
|
|
1671
1733
|
```
|
|
1672
1734
|
|
|
1673
1735
|
**Options**:
|
|
@@ -1676,7 +1738,7 @@ $ bigeye collections run-metrics [OPTIONS]
|
|
|
1676
1738
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1677
1739
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1678
1740
|
* `-cid, --collection_id INTEGER`: Collection ID [required]
|
|
1679
|
-
* `-
|
|
1741
|
+
* `-op, --output_path TEXT`: File to write the failed metric configurations to. [required]
|
|
1680
1742
|
* `--help`: Show this message and exit.
|
|
1681
1743
|
|
|
1682
1744
|
# `bigeye lineage`
|
|
@@ -1698,8 +1760,8 @@ $ bigeye lineage [OPTIONS] COMMAND [ARGS]...
|
|
|
1698
1760
|
**Commands**:
|
|
1699
1761
|
|
|
1700
1762
|
* `create-node`: Create a lineage node for an entity
|
|
1701
|
-
* `create-relation`: Create a lineage relationship for 2 entities
|
|
1702
1763
|
* `delete-node`: Delete a lineage node for an entity
|
|
1764
|
+
* `create-relation`: Create a lineage relationship for 2 entities
|
|
1703
1765
|
* `delete-relation`: Deletes a single relationship based on...
|
|
1704
1766
|
* `infer-relations`: Given an upstream and downstream path,...
|
|
1705
1767
|
|
|
@@ -1722,14 +1784,14 @@ $ bigeye lineage create-node [OPTIONS]
|
|
|
1722
1784
|
* `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
|
|
1723
1785
|
* `--help`: Show this message and exit.
|
|
1724
1786
|
|
|
1725
|
-
## `bigeye lineage
|
|
1787
|
+
## `bigeye lineage delete-node`
|
|
1726
1788
|
|
|
1727
|
-
|
|
1789
|
+
Delete a lineage node for an entity
|
|
1728
1790
|
|
|
1729
1791
|
**Usage**:
|
|
1730
1792
|
|
|
1731
1793
|
```console
|
|
1732
|
-
$ bigeye lineage
|
|
1794
|
+
$ bigeye lineage delete-node [OPTIONS]
|
|
1733
1795
|
```
|
|
1734
1796
|
|
|
1735
1797
|
**Options**:
|
|
@@ -1737,19 +1799,18 @@ $ bigeye lineage create-relation [OPTIONS]
|
|
|
1737
1799
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1738
1800
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1739
1801
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1740
|
-
* `-
|
|
1741
|
-
* `-
|
|
1742
|
-
* `-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)
|
|
1743
1804
|
* `--help`: Show this message and exit.
|
|
1744
1805
|
|
|
1745
|
-
## `bigeye lineage
|
|
1806
|
+
## `bigeye lineage create-relation`
|
|
1746
1807
|
|
|
1747
|
-
|
|
1808
|
+
Create a lineage relationship for 2 entities
|
|
1748
1809
|
|
|
1749
1810
|
**Usage**:
|
|
1750
1811
|
|
|
1751
1812
|
```console
|
|
1752
|
-
$ bigeye lineage
|
|
1813
|
+
$ bigeye lineage create-relation [OPTIONS]
|
|
1753
1814
|
```
|
|
1754
1815
|
|
|
1755
1816
|
**Options**:
|
|
@@ -1757,8 +1818,9 @@ $ bigeye lineage delete-node [OPTIONS]
|
|
|
1757
1818
|
* `-b, --bigeye_conf TEXT`: Bigeye Credential File Path [env var: BIGEYE_API_CRED_FILE]
|
|
1758
1819
|
* `-c, --config_file TEXT`: Bigeye CLI Configuration File Path [env var: BIGEYE_API_CONFIG_FILE]
|
|
1759
1820
|
* `-w, --workspace TEXT`: Name of the workspace configuration. [env var: BIGEYE_WORKSPACE; default: DEFAULT]
|
|
1760
|
-
* `-
|
|
1761
|
-
* `-
|
|
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
|
|
1762
1824
|
* `--help`: Show this message and exit.
|
|
1763
1825
|
|
|
1764
1826
|
## `bigeye lineage delete-relation`
|