Skip to main content
The dq command manages a DataHub data quality rule.

accept

The accept subcommand accepts a data quality rule.
string
required
Unique ID of the data quality rule to accept.
string
API key or the NX1_API_KEY variable.
string
YAML config file.
Shows help messages and exit.
string
API host.
Disables SSL verification.
string
Output format. Allowed values: json, yaml, or table.
string
Profile name from ~/.nx1/profiles.
integer
Requests when to timeout. Default is 30.
Verbose output.

delete

The delete subcommand deletes a data quality rule by its unique ID.
string
required
Unique ID of the data quality rule to delete.
string
API key or the NX1_API_KEY variable.
string
YAML config file.
Shows help messages and exit.
string
API host.
Disables SSL verification.
string
Output format. Allowed values: json, yaml, or table.
string
Profile name from ~/.nx1/profiles.
integer
Requests when to timeout. Default is 30.
Verbose output.

rules

The rules subcommand retrieves all data quality rules for a table based on whether you have accepted the rule.
If true, returns only accepted rules.
string
required
Name of the table to retrieve the data quality rules for.
string
API key or the NX1_API_KEY variable.
string
YAML config file.
Shows help messages and exit.
string
API host.
Disables SSL verification.
string
Output format. Allowed values: json, yaml, or table.
string
Profile name from ~/.nx1/profiles.
integer
Requests when to timeout. Default is 30.
Verbose output.

run

The rules subcommand runs the data quality rules of a table and report back to DataHub assertions.
string
required
Name of the table to run the data quality report on.
string
API key or the NX1_API_KEY variable.
string
YAML config file.
Shows help messages and exit.
string
API host.
Disables SSL verification.
string
Output format. Allowed values: json, yaml, or table.
string
Profile name from ~/.nx1/profiles.
integer
Requests when to timeout. Default is 30.
Verbose output.

suggest

The suggest subcommand gets a data quality suggestion for a specific table.
string
required
Instruction in human language about the data quality suggestion you want.
string
required
Name of the table to analyze for data quality suggestions.
string
API key or the NX1_API_KEY variable.
string
YAML config file.
Shows help messages and exit.
string
API host.
Disables SSL verification.
string
Output format. Allowed values: json, yaml, or table.
string
Profile name from ~/.nx1/profiles.
integer
Requests when to timeout. Default is 30.
Verbose output.