Last updated: September 29, 2024

dqo settings command-line command

The reference of the settings command in DQOps. Show or set local instance settings

dqo settings editor set

Set editor settings

Description

Set the settings for the editor. It allows user to set the editor to use a specific output format.

Command-line synopsis

$ dqo [dqo options...] settings editor set [-h] [-fw] [-hl] [-n=<editorName>] [-of=<outputFormat>]
                     [-p=<editorPath>]

DQOps shell synopsis

dqo> settings editor set [-h] [-fw] [-hl] [-n=<editorName>] [-of=<outputFormat>]
                     [-p=<editorPath>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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
`-n` `--name`	Editor name	VSC IntelliJ Eclipse PyCharm
`-of` `--output-format`	Output format for tabular responses	TABLE CSV JSON
`-p` `--path`	Editor path

dqo settings editor remove

Remove editor settings

Description

Remove the editor settings from your configuration. This will revert the editor to its default settings.

Command-line synopsis

$ dqo [dqo options...] settings editor remove [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings editor remove [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings editor show

Show editor settings

Description

Display the current editor settings.

Command-line synopsis

$ dqo [dqo options...] settings editor show [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings editor show [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings init

Initialize settings file in UserHome directory

Description

Settings file in your UserHome directory. This file stores configuration options for the DQOps.

Command-line synopsis

$ dqo [dqo options...] settings init [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings init [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings remove

Remove settings file from UserHome directory

Description

Removes the settings file from your UserHome directory.

Command-line synopsis

$ dqo [dqo options...] settings remove [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings remove [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings apikey set

Set API key

Description

Set the API key used for accessing external services. This key is used to authenticate requests to the service.

Command-line synopsis

$ dqo [dqo options...] settings apikey set [-h] [-fw] [-hl] [-of=<outputFormat>] <key>

DQOps shell synopsis

dqo> settings apikey set [-h] [-fw] [-hl] [-of=<outputFormat>] <key>

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings apikey remove

Remove API key

Description

Remove the API key used for accessing external services.

Command-line synopsis

$ dqo [dqo options...] settings apikey remove [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings apikey remove [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings apikey show

Show API key

Description

Display the current API key used for accessing external services.

Command-line synopsis

$ dqo [dqo options...] settings apikey show [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings apikey show [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings timezone set

Set the default time zone

Description

Set the default time zone used by the DQOps.

Command-line synopsis

$ dqo [dqo options...] settings timezone set [-h] [-fw] [-hl] [-of=<outputFormat>] <timeZone>

DQOps shell synopsis

dqo> settings timezone set [-h] [-fw] [-hl] [-of=<outputFormat>] <timeZone>

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings timezone remove

Remove time zone

Description

Remove the custom time zone from your settings. Once removed, the time zone for your account will be set to the system default.

Command-line synopsis

$ dqo [dqo options...] settings timezone remove [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings timezone remove [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings timezone show

Show the default time zone

Description

Displays the default time zone that is currently set in your settings. This time zone will be used to display all date and time values in the application.

Command-line synopsis

$ dqo [dqo options...] settings timezone show [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings timezone show [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings smtp set

Set SMTP config

Description

Set SMTP server configuration for incident notifications.

Command-line synopsis

$ dqo [dqo options...] settings smtp set -s [-h] [-fw] [-hl] -ho=<host> [-of=<outputFormat>]
                   -p=<port> -ps=<password> -u=<username>

DQOps shell synopsis

dqo> settings smtp set -s [-h] [-fw] [-hl] -ho=<host> [-of=<outputFormat>]
                   -p=<port> -ps=<password> -u=<username>

Command options

All parameters supported by the command are listed below.

Command argument	Description	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
`-ho` `--host`	SMTP server host
`-of` `--output-format`	Output format for tabular responses	TABLE CSV JSON
`-ps` `--password`	SMTP server password
`-p` `--port`	SMTP server port
`-s` `--use-ssl`	SMTP server use SSL
`-u` `--username`	SMTP server user name

dqo settings smtp remove

Remove SMTP server config

Description

Remove the API key used for accessing external services.

Command-line synopsis

$ dqo [dqo options...] settings smtp remove [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings smtp remove [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings smtp show

Show SMTP server configuration

Description

Display the current SMTP server configuration for incident notifications.

Command-line synopsis

$ dqo [dqo options...] settings smtp show [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings smtp show [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings catalog list

List the URLs of data catalog forwarding services

Description

Shows a list of urls of REST API endpoints that receive updates of data quality health for tables having new results.

Command-line synopsis

$ dqo [dqo options...] settings catalog list [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings catalog list [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings catalog add

Add a url to a data catalog wrapper

Description

Adds a url to a data catalog wrapper that receives updates of the table's health.

Command-line synopsis

$ dqo [dqo options...] settings catalog add [-h] [-fw] [-hl] [-of=<outputFormat>] <url>

DQOps shell synopsis

dqo> settings catalog add [-h] [-fw] [-hl] [-of=<outputFormat>] <url>

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings catalog remove

Remove a url to a data catalog wrapper

Description

Removes a url to a data catalog wrapper that receives updates of the table's health.

Command-line synopsis

$ dqo [dqo options...] settings catalog remove [-h] [-fw] [-hl] [-of=<outputFormat>] <url>

DQOps shell synopsis

dqo> settings catalog remove [-h] [-fw] [-hl] [-of=<outputFormat>] <url>

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings instancename set

Set DQOps instance name

Description

Set the DQOps instance name of this instance.

Command-line synopsis

$ dqo [dqo options...] settings instancename set [-h] [-fw] [-hl] [-of=<outputFormat>] <name>

DQOps shell synopsis

dqo> settings instancename set [-h] [-fw] [-hl] [-of=<outputFormat>] <name>

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings instancename remove

Remove DQOps instance name

Description

Remove the DQOps instance name of this instance.

Command-line synopsis

$ dqo [dqo options...] settings instancename remove [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings instancename remove [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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 settings instancename show

Show DQOps instance name

Description

Display the DQOps instance name stored the local settings of this DQOps instance.

Command-line synopsis

$ dqo [dqo options...] settings instancename show [-h] [-fw] [-hl] [-of=<outputFormat>]

DQOps shell synopsis

dqo> settings instancename show [-h] [-fw] [-hl] [-of=<outputFormat>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	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