Skip to content

Table

add

Synopsis

table add [-h] [-hl] [-c=<connetionName>] [-of=<outputFormat>] [-t=<fullTableName>]


Description Add table with specified name


Options

Command Description
-h --help Show the help for the command and parameters
-hl --headless Run the command in an headless (no user input allowed) mode
-c --connection
=<connetion>
Connection Name
-t --table
=<table>
Table name

edit

Synopsis

table edit [-h] [-hl] [-c=<connetion>] [-of=<outputFormat>] [-t=<table>]

Description Edit table which match filters


Options

Command Description
-h --help Show the help for the command and parameters
-hl --headless Run the command in an headless (no user input allowed) mode
-c --connection
=<connetion>
Connection Name
-t --table
=<table>
Full table name (schema.table)

Editing tables

To access table configuration, where we define and edit data quality checks using terminal, user has to run the following command

table edit
and the app will ask to specify the connection name along with schema and table name. After that a table configuration file opens in the default editor.

Info

By default, DQO opens Visual Studio Code, which we recommend to use with installed plugins: Better Jinja and YAML. This way we have a fully supported code completion (in some editors it is not possible to use code completion that is why we recommend VS-Code).

Specifying the table to edit

It is possible to a open table configuration in an editor by specifying a connection and table in the command

table edit -c=<connection_name> -t=<table_name>

For example

import

Synopsis

table import [-h] [-hl] [-c=<connetion>] [-of=<outputFormat>] [-s=<schema>] [-t=<fullTableName>]


Description Import tables from a specified database


Options

Command Description
-h --help Show the help for the command and parameters
-hl --headless Run the command in an headless (no user input allowed) mode
-c --connection
=<connetion>
Connection Name'
-s --schema
=<schema>
Schema Name
-t --table
=<table>
Table Name

Importing tables from the connection

To edit table configuration, it has to be imported in the first place.

Once a connection is added (see how to add connection) we can import tables to access the configuration with the following command

table import
and user will be asked to provide connection name and select the schema (dataset), or the connection can be specified in the command

table import -c=<connection_name>

list

Synopsis

table list [-h] [-hl] [-c=<connetionName>] [-of=<outputFormat>] [-t=<tableName>]


Description List tables which match filters


Options

Command Description
-h --help Show the help for the command and parameters
-hl --headless Run the command in an headless (no user input allowed) mode
-c --connection
=<connetion>
Connection Name
-t --table
=<table>
Table name filter

remove

Synopsis

table remove [-h] [-hl] [-c=<connetionName>] [-of=<outputFormat>] [-t=<fullTableName>]


Description Remove tables which match filters


Options

Command Description
-h --help Show the help for the command and parameters
-hl --headless Run the command in an headless (no user input allowed) mode
-c --connection
=<connetion>
Connection Name
-t --table
=<table>
Table

update

Synopsis

table update [-h] [-hl] [-c=<connetionName>] [-of=<outputFormat>] [-n=<newTableName>] [-t=<fullTableName>]


Description Update tables which match filters


Options

Command Description
-h --help Show the help for the command and parameters
-hl --headless Run the command in an headless (no user input allowed) mode
-c --connection
=<connetion>
Connection Name
-n --newTable
=<newTable>
New table name
-t --table
=<table>
Table