connection
dqo connection list
List connections that match a given condition
Description
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.
Command-line synopsis
$ dqo [dqo options...] connection list [-h] [-fw] [-hl] [-n=<name>] [-of=<outputFormat>]
[-d=<dimensions>]... [-l=<labels>]...
dqo> connection list [-h] [-fw] [-hl] [-n=<name>] [-of=<outputFormat>]
[-d=<dimensions>]... [-l=<labels>]...
Options
Command argument | Description | Required | Accepted values |
---|---|---|---|
-d --dimension |
Dimension filter | ||
-fw --file-write |
Write command response to a file | ||
-hl --headless |
Run the command in an headless (no user input allowed) mode | ||
-h --help |
Show the help for the command and parameters | ||
-l --label |
Label filter | ||
-n --name |
Connection name filter | ||
-of --output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo connection add
Add a connection with specified details
Description
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.
Command-line synopsis
$ dqo [dqo options...] connection add [-h] [-fw] [-hl] [--sqlserver-disable-encryption]
[--bigquery-authentication-mode=<authenticationMode>]
[--bigquery-billing-project-id=<billingProjectId>]
[--bigquery-json-key-content=<jsonKeyContent>]
[--bigquery-json-key-path=<jsonKeyPath>]
[--bigquery-quota-project-id=<quotaProjectId>]
[--bigquery-source-project-id=<sourceProjectId>]
[--mysql-database=<database>] [--mysql-host=<host>]
[--mysql-options=<options>] [--mysql-password=<password>]
[--mysql-port=<port>] [--mysql-sslmode=<sslmode>]
[--mysql-user=<user>] [-n=<name>] [-of=<outputFormat>]
[--oracle-database=<database>] [--oracle-host=<host>]
[--oracle-initialization-sql=<initializationSql>]
[--oracle-options=<options>] [--oracle-password=<password>]
[--oracle-port=<port>] [--oracle-user=<user>]
[--postgresql-database=<database>] [--postgresql-host=<host>]
[--postgresql-options=<options>]
[--postgresql-password=<password>] [--postgresql-port=<port>]
[--postgresql-sslmode=<sslmode>] [--postgresql-user=<user>]
[--redshift-database=<database>] [--redshift-host=<host>]
[--redshift-options=<options>] [--redshift-password=<password>]
[--redshift-port=<port>] [--redshift-user=<user>]
[--snowflake-account=<account>]
[--snowflake-database=<database>]
[--snowflake-password=<password>] [--snowflake-role=<role>]
[--snowflake-user=<user>] [--snowflake-warehouse=<warehouse>]
[--sqlserver-database=<database>] [--sqlserver-host=<host>]
[--sqlserver-options=<options>]
[--sqlserver-password=<password>] [--sqlserver-port=<port>]
[--sqlserver-user=<user>] [-t=<providerType>]
[-F=<String=String>]... [-M=<String=String>]...
[-O=<String=String>]... [-P=<String=String>]...
[-R=<String=String>]... [-S=<String=String>]...
dqo> connection add [-h] [-fw] [-hl] [--sqlserver-disable-encryption]
[--bigquery-authentication-mode=<authenticationMode>]
[--bigquery-billing-project-id=<billingProjectId>]
[--bigquery-json-key-content=<jsonKeyContent>]
[--bigquery-json-key-path=<jsonKeyPath>]
[--bigquery-quota-project-id=<quotaProjectId>]
[--bigquery-source-project-id=<sourceProjectId>]
[--mysql-database=<database>] [--mysql-host=<host>]
[--mysql-options=<options>] [--mysql-password=<password>]
[--mysql-port=<port>] [--mysql-sslmode=<sslmode>]
[--mysql-user=<user>] [-n=<name>] [-of=<outputFormat>]
[--oracle-database=<database>] [--oracle-host=<host>]
[--oracle-initialization-sql=<initializationSql>]
[--oracle-options=<options>] [--oracle-password=<password>]
[--oracle-port=<port>] [--oracle-user=<user>]
[--postgresql-database=<database>] [--postgresql-host=<host>]
[--postgresql-options=<options>]
[--postgresql-password=<password>] [--postgresql-port=<port>]
[--postgresql-sslmode=<sslmode>] [--postgresql-user=<user>]
[--redshift-database=<database>] [--redshift-host=<host>]
[--redshift-options=<options>] [--redshift-password=<password>]
[--redshift-port=<port>] [--redshift-user=<user>]
[--snowflake-account=<account>]
[--snowflake-database=<database>]
[--snowflake-password=<password>] [--snowflake-role=<role>]
[--snowflake-user=<user>] [--snowflake-warehouse=<warehouse>]
[--sqlserver-database=<database>] [--sqlserver-host=<host>]
[--sqlserver-options=<options>]
[--sqlserver-password=<password>] [--sqlserver-port=<port>]
[--sqlserver-user=<user>] [-t=<providerType>]
[-F=<String=String>]... [-M=<String=String>]...
[-O=<String=String>]... [-P=<String=String>]...
[-R=<String=String>]... [-S=<String=String>]...
Options
Command argument | Description | Required | Accepted values |
---|---|---|---|
--bigquery-authentication-mode |
Bigquery authentication mode. The default value uses the current GCP application default credentials. The default GCP credentials is the Service Account of a VM in GCP cloud, a GCP JSON key file whose path is in the GOOGLE_APPLICATION_CREDENTIALS environment variable, or it is the default GCP credentials obtained on a user's computer by running 'gcloud auth application-default login' from the command line. | google_application_credentials json_key_content json_key_path |
|
--bigquery-billing-project-id |
Bigquery billing GCP project id. This is the project used as the default GCP project. The calling user must have a bigquery.jobs.create permission in this project. | ||
--bigquery-json-key-content |
Bigquery service account key content as JSON. | ||
--bigquery-json-key-path |
Path to a GCP service account key JSON file used to authenticate to Bigquery. | ||
--bigquery-quota-project-id |
Bigquery quota GCP project id. | ||
--bigquery-source-project-id |
Bigquery source GCP project id. This is the project that has datasets that will be imported. | ||
-fw --file-write |
Write command response to a file | ||
-hl --headless |
Run the command in an headless (no user input allowed) mode | ||
-h --help |
Show the help for the command and parameters | ||
--mysql-database |
MySQL database name. The value can be in the null format to use dynamic substitution. | ||
--mysql-host |
MySQL host name | ||
--mysql-options |
MySQL connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--mysql-password |
MySQL database password. The value can be in the null format to use dynamic substitution. | ||
--mysql-port |
MySQL port number | ||
--mysql-sslmode |
SslMode MySQL connection parameter | DISABLED PREFERRED REQUIRED VERIFY_CA VERIFY_IDENTITY |
|
--mysql-user |
MySQL user name. The value can be in the null format to use dynamic substitution. | ||
-n --name |
Connection name | ||
--oracle-database |
Oracle database name. The value can be in the null format to use dynamic substitution. | ||
--oracle-host |
Oracle host name | ||
--oracle-initialization-sql |
Custom SQL that is executed after connecting to Oracle. This SQL script can configure the default language, for example: alter session set NLS_DATE_FORMAT='YYYY-DD-MM HH24:MI:SS' | ||
--oracle-options |
Oracle connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--oracle-password |
Oracle database password. The value can be in the null format to use dynamic substitution. | ||
--oracle-port |
Oracle port number | ||
--oracle-user |
Oracle user name. The value can be in the null format to use dynamic substitution. | ||
-of --output-format |
Output format for tabular responses | TABLE CSV JSON |
|
--postgresql-database |
PostgreSQL database name. The value can be in the null format to use dynamic substitution. | ||
--postgresql-host |
PostgreSQL host name | ||
--postgresql-options |
PostgreSQL connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--postgresql-password |
PostgreSQL database password. The value can be in the null format to use dynamic substitution. | ||
--postgresql-port |
PostgreSQL port number | ||
--postgresql-sslmode |
Connect to PostgreSQL using sslmode connection parameter | disable allow prefer require verify_ca verify_full |
|
--postgresql-user |
PostgreSQL user name. The value can be in the null format to use dynamic substitution. | ||
-t --provider |
Connection provider type | bigquery snowflake postgresql redshift sqlserver mysql oracle |
|
--redshift-database |
Redshift database name. The value can be in the null format to use dynamic substitution. | ||
--redshift-host |
Redshift host name | ||
--redshift-options |
Redshift connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--redshift-password |
Redshift database password. The value can be in the null format to use dynamic substitution. | ||
--redshift-port |
Redshift port number | ||
--redshift-user |
Redshift user name. The value can be in the null format to use dynamic substitution. | ||
--snowflake-account |
Snowflake account name, e.q. <account>, <account>-<locator>, <account>.<region> or <account>.<region>.<platform>. | ||
--snowflake-database |
Snowflake database name. The value can be in the null format to use dynamic substitution. | ||
--snowflake-password |
Snowflake database password. The value can be in the null format to use dynamic substitution. | ||
--snowflake-role |
Snowflake role name. | ||
--snowflake-user |
Snowflake user name. The value can be in the null format to use dynamic substitution. | ||
--snowflake-warehouse |
Snowflake warehouse name. | ||
--sqlserver-database |
SQL Server database name. The value can be in the null format to use dynamic substitution. | ||
--sqlserver-disable-encryption |
Disable SSL encryption parameter. The default value is false. You may need to disable encryption when SQL Server is started in Docker. | ||
--sqlserver-host |
SQL Server host name | ||
--sqlserver-options |
SQL Server connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--sqlserver-password |
SQL Server database password. The value can be in the null format to use dynamic substitution. | ||
--sqlserver-port |
SQL Server port number | ||
--sqlserver-user |
SQL Server user name. The value can be in the null format to use dynamic substitution. | ||
-F |
Snowflake additional properties that are added to the JDBC connection string | ||
-M |
MySQL additional properties that are added to the JDBC connection string | ||
-O |
Oracle's additional properties that are added to the JDBC connection string | ||
-P |
PostgreSQL additional properties that are added to the JDBC connection string | ||
-R |
Redshift additional properties that are added to the JDBC connection string | ||
-S |
SQL Server additional properties that are added to the JDBC connection string |
dqo connection remove
Remove the connection(s) that match a given condition
Description
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.
Command-line synopsis
DQO Shell synopsisOptions
Command argument | Description | Required | Accepted values |
---|---|---|---|
-fw --file-write |
Write command response to a file | ||
-hl --headless |
Run the command in an headless (no user input allowed) mode | ||
-h --help |
Show the help for the command and parameters | ||
-n --name |
Connection name | ||
-of --output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo connection update
Update the connection(s) that match a given condition
Description
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.
Command-line synopsis
$ dqo [dqo options...] connection update [-h] [-fw] [-hl] [--sqlserver-disable-encryption]
[--bigquery-authentication-mode=<authenticationMode>]
[--bigquery-billing-project-id=<billingProjectId>]
[--bigquery-json-key-content=<jsonKeyContent>]
[--bigquery-json-key-path=<jsonKeyPath>]
[--bigquery-quota-project-id=<quotaProjectId>]
[--bigquery-source-project-id=<sourceProjectId>]
[--mysql-database=<database>] [--mysql-host=<host>]
[--mysql-options=<options>] [--mysql-password=<password>]
[--mysql-port=<port>] [--mysql-sslmode=<sslmode>]
[--mysql-user=<user>] [-n=<name>] [-of=<outputFormat>]
[--oracle-database=<database>] [--oracle-host=<host>]
[--oracle-initialization-sql=<initializationSql>]
[--oracle-options=<options>] [--oracle-password=<password>]
[--oracle-port=<port>] [--oracle-user=<user>]
[--postgresql-database=<database>]
[--postgresql-host=<host>] [--postgresql-options=<options>]
[--postgresql-password=<password>]
[--postgresql-port=<port>] [--postgresql-sslmode=<sslmode>]
[--postgresql-user=<user>] [--redshift-database=<database>]
[--redshift-host=<host>] [--redshift-options=<options>]
[--redshift-password=<password>] [--redshift-port=<port>]
[--redshift-user=<user>] [--snowflake-account=<account>]
[--snowflake-database=<database>]
[--snowflake-password=<password>] [--snowflake-role=<role>]
[--snowflake-user=<user>]
[--snowflake-warehouse=<warehouse>]
[--sqlserver-database=<database>] [--sqlserver-host=<host>]
[--sqlserver-options=<options>]
[--sqlserver-password=<password>] [--sqlserver-port=<port>]
[--sqlserver-user=<user>] [-F=<String=String>]...
[-M=<String=String>]... [-O=<String=String>]...
[-P=<String=String>]... [-R=<String=String>]...
[-S=<String=String>]...
dqo> connection update [-h] [-fw] [-hl] [--sqlserver-disable-encryption]
[--bigquery-authentication-mode=<authenticationMode>]
[--bigquery-billing-project-id=<billingProjectId>]
[--bigquery-json-key-content=<jsonKeyContent>]
[--bigquery-json-key-path=<jsonKeyPath>]
[--bigquery-quota-project-id=<quotaProjectId>]
[--bigquery-source-project-id=<sourceProjectId>]
[--mysql-database=<database>] [--mysql-host=<host>]
[--mysql-options=<options>] [--mysql-password=<password>]
[--mysql-port=<port>] [--mysql-sslmode=<sslmode>]
[--mysql-user=<user>] [-n=<name>] [-of=<outputFormat>]
[--oracle-database=<database>] [--oracle-host=<host>]
[--oracle-initialization-sql=<initializationSql>]
[--oracle-options=<options>] [--oracle-password=<password>]
[--oracle-port=<port>] [--oracle-user=<user>]
[--postgresql-database=<database>]
[--postgresql-host=<host>] [--postgresql-options=<options>]
[--postgresql-password=<password>]
[--postgresql-port=<port>] [--postgresql-sslmode=<sslmode>]
[--postgresql-user=<user>] [--redshift-database=<database>]
[--redshift-host=<host>] [--redshift-options=<options>]
[--redshift-password=<password>] [--redshift-port=<port>]
[--redshift-user=<user>] [--snowflake-account=<account>]
[--snowflake-database=<database>]
[--snowflake-password=<password>] [--snowflake-role=<role>]
[--snowflake-user=<user>]
[--snowflake-warehouse=<warehouse>]
[--sqlserver-database=<database>] [--sqlserver-host=<host>]
[--sqlserver-options=<options>]
[--sqlserver-password=<password>] [--sqlserver-port=<port>]
[--sqlserver-user=<user>] [-F=<String=String>]...
[-M=<String=String>]... [-O=<String=String>]...
[-P=<String=String>]... [-R=<String=String>]...
[-S=<String=String>]...
Options
Command argument | Description | Required | Accepted values |
---|---|---|---|
--bigquery-authentication-mode |
Bigquery authentication mode. The default value uses the current GCP application default credentials. The default GCP credentials is the Service Account of a VM in GCP cloud, a GCP JSON key file whose path is in the GOOGLE_APPLICATION_CREDENTIALS environment variable, or it is the default GCP credentials obtained on a user's computer by running 'gcloud auth application-default login' from the command line. | google_application_credentials json_key_content json_key_path |
|
--bigquery-billing-project-id |
Bigquery billing GCP project id. This is the project used as the default GCP project. The calling user must have a bigquery.jobs.create permission in this project. | ||
--bigquery-json-key-content |
Bigquery service account key content as JSON. | ||
--bigquery-json-key-path |
Path to a GCP service account key JSON file used to authenticate to Bigquery. | ||
--bigquery-quota-project-id |
Bigquery quota GCP project id. | ||
--bigquery-source-project-id |
Bigquery source GCP project id. This is the project that has datasets that will be imported. | ||
-fw --file-write |
Write command response to a file | ||
-hl --headless |
Run the command in an headless (no user input allowed) mode | ||
-h --help |
Show the help for the command and parameters | ||
--mysql-database |
MySQL database name. The value can be in the null format to use dynamic substitution. | ||
--mysql-host |
MySQL host name | ||
--mysql-options |
MySQL connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--mysql-password |
MySQL database password. The value can be in the null format to use dynamic substitution. | ||
--mysql-port |
MySQL port number | ||
--mysql-sslmode |
SslMode MySQL connection parameter | DISABLED PREFERRED REQUIRED VERIFY_CA VERIFY_IDENTITY |
|
--mysql-user |
MySQL user name. The value can be in the null format to use dynamic substitution. | ||
-n --name |
Connection name, supports wildcards for changing multiple connections at once, i.e. "conn*" | ||
--oracle-database |
Oracle database name. The value can be in the null format to use dynamic substitution. | ||
--oracle-host |
Oracle host name | ||
--oracle-initialization-sql |
Custom SQL that is executed after connecting to Oracle. This SQL script can configure the default language, for example: alter session set NLS_DATE_FORMAT='YYYY-DD-MM HH24:MI:SS' | ||
--oracle-options |
Oracle connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--oracle-password |
Oracle database password. The value can be in the null format to use dynamic substitution. | ||
--oracle-port |
Oracle port number | ||
--oracle-user |
Oracle user name. The value can be in the null format to use dynamic substitution. | ||
-of --output-format |
Output format for tabular responses | TABLE CSV JSON |
|
--postgresql-database |
PostgreSQL database name. The value can be in the null format to use dynamic substitution. | ||
--postgresql-host |
PostgreSQL host name | ||
--postgresql-options |
PostgreSQL connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--postgresql-password |
PostgreSQL database password. The value can be in the null format to use dynamic substitution. | ||
--postgresql-port |
PostgreSQL port number | ||
--postgresql-sslmode |
Connect to PostgreSQL using sslmode connection parameter | disable allow prefer require verify_ca verify_full |
|
--postgresql-user |
PostgreSQL user name. The value can be in the null format to use dynamic substitution. | ||
--redshift-database |
Redshift database name. The value can be in the null format to use dynamic substitution. | ||
--redshift-host |
Redshift host name | ||
--redshift-options |
Redshift connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--redshift-password |
Redshift database password. The value can be in the null format to use dynamic substitution. | ||
--redshift-port |
Redshift port number | ||
--redshift-user |
Redshift user name. The value can be in the null format to use dynamic substitution. | ||
--snowflake-account |
Snowflake account name, e.q. <account>, <account>-<locator>, <account>.<region> or <account>.<region>.<platform>. | ||
--snowflake-database |
Snowflake database name. The value can be in the null format to use dynamic substitution. | ||
--snowflake-password |
Snowflake database password. The value can be in the null format to use dynamic substitution. | ||
--snowflake-role |
Snowflake role name. | ||
--snowflake-user |
Snowflake user name. The value can be in the null format to use dynamic substitution. | ||
--snowflake-warehouse |
Snowflake warehouse name. | ||
--sqlserver-database |
SQL Server database name. The value can be in the null format to use dynamic substitution. | ||
--sqlserver-disable-encryption |
Disable SSL encryption parameter. The default value is false. You may need to disable encryption when SQL Server is started in Docker. | ||
--sqlserver-host |
SQL Server host name | ||
--sqlserver-options |
SQL Server connection 'options' initialization parameter. For example setting this to -c statement_timeout=5min would set the statement timeout parameter for this session to 5 minutes. | ||
--sqlserver-password |
SQL Server database password. The value can be in the null format to use dynamic substitution. | ||
--sqlserver-port |
SQL Server port number | ||
--sqlserver-user |
SQL Server user name. The value can be in the null format to use dynamic substitution. | ||
-F |
Snowflake additional properties that are added to the JDBC connection string | ||
-M |
MySQL additional properties that are added to the JDBC connection string | ||
-O |
Oracle's additional properties that are added to the JDBC connection string | ||
-P |
PostgreSQL additional properties that are added to the JDBC connection string | ||
-R |
Redshift additional properties that are added to the JDBC connection string | ||
-S |
SQL Server additional properties that are added to the JDBC connection string |
dqo connection schema list
List schemas in the specified connection
Description
It allows the user to view the summary of all schemas in a selected connection.
Command-line synopsis
$ dqo [dqo options...] connection schema list [-h] [-fw] [-hl] [-n=<name>] [-of=<outputFormat>]
[-d=<dimensions>]... [-l=<labels>]...
dqo> connection schema list [-h] [-fw] [-hl] [-n=<name>] [-of=<outputFormat>]
[-d=<dimensions>]... [-l=<labels>]...
Options
Command argument | Description | Required | Accepted values |
---|---|---|---|
-d --dimension |
Dimension filter | ||
-fw --file-write |
Write command response to a file | ||
-hl --headless |
Run the command in an headless (no user input allowed) mode | ||
-h --help |
Show the help for the command and parameters | ||
-l --label |
Label filter | ||
-n --name |
Connection name filter | ||
-of --output-format |
Output format for tabular responses | TABLE CSV JSON |
dqo connection table list
List tables for the specified connection and schema name.
Description
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.
Command-line synopsis
$ dqo [dqo options...] connection table list [-h] [-fw] [-hl] [-c=<connection>] [-of=<outputFormat>]
[-s=<schema>] [-t=<table>] [-d=<dimensions>]...
[-l=<labels>]...
dqo> connection table list [-h] [-fw] [-hl] [-c=<connection>] [-of=<outputFormat>]
[-s=<schema>] [-t=<table>] [-d=<dimensions>]...
[-l=<labels>]...
Options
Command argument | Description | Required | Accepted values |
---|---|---|---|
-c --connection |
Connection name | ||
-d --dimension |
Dimension filter | ||
-fw --file-write |
Write command response to a file | ||
-hl --headless |
Run the command in an headless (no user input allowed) mode | ||
-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 |
|
-s --schema |
Schema name | ||
-t --table |
Table name |
dqo connection table show
Show table for connection
Description
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.
Command-line synopsis
$ dqo [dqo options...] connection table show [-h] [-fw] [-hl] [-c=<connection>] [-of=<outputFormat>]
[-t=<table>]
Options
Command argument | Description | Required | Accepted values |
---|---|---|---|
-c --connection |
Connection name | ||
-fw --file-write |
Write command response to a file | ||
-hl --headless |
Run the command in an headless (no user input allowed) mode | ||
-h --help |
Show the help for the command and parameters | ||
-of --output-format |
Output format for tabular responses | TABLE CSV JSON |
|
-t --table |
Full table name (schema.table), supports wildcard patterns 'sch.tab' |
dqo connection edit
Edit connection that matches a given condition
Description
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.
Command-line synopsis
DQO Shell synopsisOptions
Command argument | Description | Required | Accepted values |
---|---|---|---|
-c --connection |
Connection Name | ||
-fw --file-write |
Write command response to a file | ||
-hl --headless |
Run the command in an headless (no user input allowed) mode | ||
-h --help |
Show the help for the command and parameters | ||
-of --output-format |
Output format for tabular responses | TABLE CSV JSON |