Last updated: July 02, 2024
dqo cloud command-line command
The reference of the cloud command in DQOps. Manage the DQOps Cloud account. This group of commands supports connecting this DQOps instance to a DQOps Cloud account, changing the password and synchronizing local data with the Data Quality Data Warehouse hosted by DQOps Cloud
dqo cloud login
Log in or register an account at the DQOps Cloud
Description
Allow user to provide login credentials if the user already has an account.
Command-line synopsis
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud password
Changes the user's password in DQOps Cloud
Description
Allows the user to change the password that is used to log in to DQOps Cloud account using the email and password.
Command-line synopsis
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync enable
Enables synchronization with DQOps Cloud if it was disabled before
Description
For this command description is not provided yet.
Command-line synopsis
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync disable
Disable synchronization with DQOps Cloud, allowing to work offline, but without access to the data quality dashboards
Description
For this command description is not provided yet.
Command-line synopsis
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync data
Synchronize local "data" folder with sensor readouts and rule results with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "data" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync data [-hr] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
|
-r--refresh-data-warehouse |
Force refresh a whole table in the data quality data warehouse |
dqo cloud sync sources
Synchronize local "sources" connection and table level quality definitions with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "sources" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync sources [-h] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync sensors
Synchronize local "sensors" folder with custom sensor definitions with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "sensors" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync sensors [-h] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync rules
Synchronize local "rules" folder with custom rule definitions with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "rules" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync rules [-h] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync checks
Synchronize local "checks" folder with custom check definitions with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "checks" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync checks [-h] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync settings
Synchronize local "settings" folder with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "settings" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync settings [-h] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync credentials
Synchronize local ".credentials" folder that stores shared credentials with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the ".credentials" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync credentials [-h] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync dictionaries
Synchronize local "dictionaries" folder that stores data dictionary CSV files with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "dictionaries" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync dictionaries [-h] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync patterns
Synchronize local "patterns" folder that stores default check patters files with DQOps Cloud
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "patterns" folder.
Command-line synopsis
$ dqo [dqo options...] cloud sync patterns [-h] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo cloud sync all
Synchronize local files with DQOps Cloud (sources, table rules, custom rules, custom sensors and data - sensor readouts and rule results)
Description
Uploads any local changes to the cloud and downloads any changes made to the cloud versions of the folders.
Command-line synopsis
$ dqo [dqo options...] cloud sync all [-hr] [-fw] [-hl] [-d=<direction>] [-m=<mode>]
[-of=<outputFormat>]
DQOps shell synopsis
Command options
All parameters supported by the command are listed below.
| Command argument | Description | Required | Accepted values |
|---|---|---|---|
-d--direction |
File synchronization direction | full download upload |
|
-fw--file-write |
Write command response to a file | ||
--headless-hl |
Starts DQOps in a headless mode. When DQOps runs in a headless mode and the application cannot start because the DQOps Cloud API key is missing or the DQOps user home folder is not configured, DQOps will stop silently instead of asking the user to approve the setup of the DQOps user home folder structure and/or log into DQOps Cloud. | ||
-h--help |
Show the help for the command and parameters | ||
-m--mode |
Reporting mode (silent, summary, debug) | silent summary debug |
|
-of--output-format |
Output format for tabular responses | TABLE CSV JSON |
|
-r--refresh-data-warehouse |
Force refresh a whole table in the data quality data warehouse |