Skip to content

Connection

The connection command orchestrates connections to datasets. You can add, list, remove or update connections.

add

Synopsis

connection add [-h] [-hl] [-of=<outputFormat>] [-P=<String=String>] [-d=<database>] [-j=<url>] [-n=<name>] [-p=<password>] [-t=<providerType>] [-u=<user>]


Description Add connection with specified details


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
-of --output-format
=<outputFormat>
Output format for tabular responses
-P --properties
=<String=String>
Provider specific parameters
-d --database
=<database>
Database name
-j --jdbc
=<url>
JDBC connection url
-n --name
=<name>
Connection name
-p --password
=<password>
Password
-t --provider
=<providerType>
Connection provider type
-u --user
=<user>
Username


list

Synopsis

connection list [-h] [-hl] [-of=<outputFormat>] [-n=<name>]


Description List connections 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
-n --name
=<name>
Connection name

remove

Synopsis

connection remove [-h] [-hl] [-of=<outputFormat>] [-n=<name>]


Description Remove connection or connections 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
-n --name
=<name>
Connection name

update

Synopsis

connection update [-h] [-hl] [-of=<outputFormat>] [-d=<database>] [-j=<url>] [-n=<name>] [-p=<password>] [-t=<providerType>] [-u=<user>]


Description Update connection or connections 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
-d --database
=<database>
Database name
-j --jdbc
=<url>
JDBC connection url
-n --name
=<name>
Connection name
-p --password
=<password>
Password
-t --provider
=<providerType>
Connection provider type
-u --user
=<user>
Username