Last updated: July 02, 2024

dqo column command-line command

The reference of the column command in DQOps. Modify and list columns

dqo column add

Add a column with specified details

Description

Add a new column to a table with specific details. The new column is added to the YAML configuration file.

Command-line synopsis

$ dqo [dqo options...] column add [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
            [-d=<dataType>] [-e=<sqlExpression>] [-of=<outputFormat>]
            [-t=<fullTableName>]

DQOps shell synopsis

dqo> column add [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
            [-d=<dataType>] [-e=<sqlExpression>] [-of=<outputFormat>]
            [-t=<fullTableName>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	Accepted values
`-C` `--column`	Column name
`-c` `--connection`	Connection name
`-d` `--dataType`	Data type
`-fw` `--file-write`	Write command response to a file
`-t` `--table` `--full-table-name`	Full table name in the form "schema.table".
`--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
`-e` `--sql-expression`	SQL expression for a calculated column

dqo column remove

Remove the column(s) that match a given condition

Description

Remove one or more columns from a table that match a specified condition. Users can filter the column.

Command-line synopsis

$ dqo [dqo options...] column remove [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
               [-of=<outputFormat>] [-t=<fullTableName>]

DQOps shell synopsis

dqo> column remove [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
               [-of=<outputFormat>] [-t=<fullTableName>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	Accepted values
`-C` `--column`	Column name, supports patterns: c_, _id, prefix*suffix.
`-c` `--connection`	Connection name
`-fw` `--file-write`	Write command response to a file
`-t` `--table` `--full-table-name`	Full table name filter in the form "schema.table", but also supporting patterns: public., .customers, landing.customer.
`--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 column update

Update the column(s) that match a given condition

Description

Update one or more columns in a table that match a specified condition.

Command-line synopsis

$ dqo [dqo options...] column update [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
               [-d=<dataType>] [-e=<sqlExpression>] [-of=<outputFormat>]
               [-t=<fullTableName>]

DQOps shell synopsis

dqo> column update [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
               [-d=<dataType>] [-e=<sqlExpression>] [-of=<outputFormat>]
               [-t=<fullTableName>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	Accepted values
`-C` `--column`	Column name
`-c` `--connection`	Connection name
`-d` `--dataType`	Data type
`-fw` `--file-write`	Write command response to a file
`-t` `--table` `--full-table-name`	Full table name in the form "schema.table".
`--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
`-e` `--sql-expression`	SQL expression for a calculated column

dqo column list

List the columns that match a given condition

Description

List all the columns in a table or filter them based on a specified condition.

Command-line synopsis

$ dqo [dqo options...] column list [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
             [-of=<outputFormat>] [-t=<fullTableName>] [-l=<labels>]...
             [-tg=<tags>]...

DQOps shell synopsis

dqo> column list [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
             [-of=<outputFormat>] [-t=<fullTableName>] [-l=<labels>]...
             [-tg=<tags>]...

Command options

All parameters supported by the command are listed below.

Command argument	Description	Accepted values
`-C` `--column`	Connection name filter
`-c` `--connection`	Connection name filter
`-fw` `--file-write`	Write command response to a file
`-t` `--table` `--full-table-name`	Full table name filter in the form "schema.table", but also supporting patterns: public., .customers, landing.customer.
`--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
`-l` `--label`	Label filter
`-of` `--output-format`	Output format for tabular responses	TABLE CSV JSON
`-tg` `--tags`	Data grouping static tag filter

dqo column enable

Enable the column(s) filtered by the given conditions

Description

Enable one or more columns in a table based on a specified condition. This command will restore the data in the previously disabled columns.

Command-line synopsis

$ dqo [dqo options...] column enable [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
               [-of=<outputFormat>] [-t=<fullTableName>]

DQOps shell synopsis

dqo> column enable [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
               [-of=<outputFormat>] [-t=<fullTableName>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	Accepted values
`-C` `--column`	Column name
`-c` `--connection`	Connection name
`-fw` `--file-write`	Write command response to a file
`-t` `--table` `--full-table-name`	Full table name in the form "schema.table".
`--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 column disable

Disable the column(s)filtered by the given conditions

Description

Disable one or more columns in a table based on a specified condition. Disabling a column will prevent it from being queried or updated until it is enabled again.

Command-line synopsis

$ dqo [dqo options...] column disable [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
                [-of=<outputFormat>] [-t=<fullTableName>]

DQOps shell synopsis

dqo> column disable [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
                [-of=<outputFormat>] [-t=<fullTableName>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	Accepted values
`-C` `--column`	Column name
`-c` `--connection`	Connection name
`-fw` `--file-write`	Write command response to a file
`-t` `--table` `--full-table-name`	Full table name in the form "schema.table".
`--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 column rename

Rename the column filtered by the given conditions

Description

Rename one or more columns in a table based on a specified condition.

Command-line synopsis

$ dqo [dqo options...] column rename [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
               [-n=<newColumnName>] [-of=<outputFormat>] [-t=<fullTableName>]

DQOps shell synopsis

dqo> column rename [-h] [-fw] [-hl] [-c=<connectionName>] [-C=<columnName>]
               [-n=<newColumnName>] [-of=<outputFormat>] [-t=<fullTableName>]

Command options

All parameters supported by the command are listed below.

Command argument	Description	Accepted values
`-C` `--column`	Column name
`-c` `--connection`	Connection name
`-fw` `--file-write`	Write command response to a file
`-t` `--table` `--full-table-name`	Full table name in the form "schema.table".
`--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` `--newColumn`	New column name
`-of` `--output-format`	Output format for tabular responses	TABLE CSV JSON