Last updated: April 03, 2024
DQOps command-line interface reference
All command-line commands supported from the DQOps shell or directly from the system command prompt are listed below.
dqo
| Command name |
Description |
dqo |
dqo is an executable script installed in the Python scripts local folder when DQOps is installed locally by installing the dqops package from PyPi. When the python environment Scripts folder is in the path, running dqo from the command line (bash, etc.) will start a DQOps local instance. |
cls
| Command name |
Description |
dqo cls |
Clear the terminal screen or console, removing all the previous commands and outputs of the commands that were executed on the console. It allows the user to start with a clean slate for the next set of commands or outputs. |
connection
| Command name |
Description |
dqo connection list |
Lists all the created connections for the logged-in user that match the conditions specified in the options. It allows the user to filter connections based on various parameters. |
dqo connection add |
Creates a new connection to the database with the specified details such as connection name, database type, hostname, username, and password. It allows the user to connect to the database from the application to perform various operations on the database. |
dqo connection remove |
Removes the connection or connections that match the conditions specified in the options. It allows the user to remove any unwanted connections that are no longer needed. |
dqo connection update |
Update the connection or connections that match the conditions specified in the options with new details. It allows the user to modify existing connections in the application. |
dqo connection schema list |
It allows the user to view the summary of all schemas in a selected connection. |
dqo connection table list |
List all the tables available in the database for the specified connection and schema. It allows the user to view all the tables in the database. |
dqo connection table show |
Show the details of the specified table in the database for the specified connection. It allows the user to view the details of a specific table in the database. |
dqo connection edit |
Edit the connection or connections that match the filter conditions specified in the options. It allows the user to modify the details of an existing connection in the application. |
table
| Command name |
Description |
dqo table import |
Import the tables from the specified database into the application. It allows the user to import the tables from the database into the application for performing various database operations. |
dqo table edit |
Edit the table or tables that match the filter conditions specified in the options. It allows the user to modify the details of an existing table in the application. |
dqo table add |
Add a new table with the specified name to the database. It allows the user to create a new table in the application for performing various operations. |
dqo table remove |
Remove one or more tables that match a given condition. It allows user to use various filters, such as table names to narrow down the set of tables to remove. |
dqo table update |
Update the structure of one or more tables that match a given condition. It allows user to use various filters, such as table names to narrow down the set of tables to update. |
dqo table list |
List all the tables that match a given condition. It allows the user to use various filters, such as table name or schema names to list filtered tables. |
check
| Command name |
Description |
dqo check run |
Run data quality checks on your dataset that match a given condition. The command output is a table with the results that provides insight into the data quality. |
dqo check activate |
Activates data quality checks matching specified filters |
dqo check deactivate |
Deactivates data quality checks matching specified filters |
column
| Command name |
Description |
dqo column add |
Add a new column to a table with specific details. The new column is added to the YAML configuration file. |
dqo column remove |
Remove one or more columns from a table that match a specified condition. Users can filter the column. |
dqo column update |
Update one or more columns in a table that match a specified condition. |
dqo column list |
List all the columns in a table or filter them based on a specified condition. |
dqo column enable |
Enable one or more columns in a table based on a specified condition. This command will restore the data in the previously disabled columns. |
dqo column disable |
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. |
dqo column rename |
Rename one or more columns in a table based on a specified condition. |
settings
cloud
| Command name |
Description |
dqo cloud login |
Allow user to provide login credentials if the user already has an account. |
dqo cloud password |
Allows the user to change the password that is used to log in to DQOps Cloud account using the email and password. |
dqo cloud sync enable |
For this command description is not added yet. |
dqo cloud sync disable |
For this command description is not added yet. |
dqo cloud sync data |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "data" folder. |
dqo cloud sync sources |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "sources" folder. |
dqo cloud sync sensors |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "sensors" folder. |
dqo cloud sync rules |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "rules" folder. |
dqo cloud sync checks |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "checks" folder. |
dqo cloud sync settings |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "settings" folder. |
dqo cloud sync credentials |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the ".credentials" folder. |
dqo cloud sync dictionaries |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "dictionaries" folder. |
dqo cloud sync patterns |
Uploads any local changes to the cloud and downloads any changes made to the cloud version of the "patterns" folder. |
dqo cloud sync all |
Uploads any local changes to the cloud and downloads any changes made to the cloud versions of the folders. |
sensor
| Command name |
Description |
dqo sensor edit |
Allows you to modify the properties of a custom sensor that matches certain condition. |
scheduler
| Command name |
Description |
dqo scheduler start |
This operation should be called only from the shell mode. When the DQOps is started as 'dqo scheduler start' from the operating system, it will stop immediately. |
dqo scheduler stop |
This operation should be called only from the shell mode after the scheduler was started. |
data
| Command name |
Description |
dqo data delete |
Deletes stored data that matches specified conditions. Be careful when using this command, as it permanently deletes the selected data and cannot be undone. |
dqo data repair |
Verify integrity of parquet files used to store data and removes corrupted files. Be careful when using this command, as it permanently deletes the selected data and cannot be undone. |
run
| Command name |
Description |
dqo run |
This command is useful when you want to continuously monitor the quality of your data in real-time. The job scheduler runs in the background, allowing you to perform other tasks while the DQOps is running. |
rule
| Command name |
Description |
dqo rule edit |
This command can be used to update the rule. It is important to use caution when using this command, as it can impact the execution of data quality checks. |