Documentation / Commands / ADD CONNECTION

ADD CONNECTION

Core command ADD CO ADDCO AD CO ADCO

Creates a new database connection

Arguments

<id> (mandatory) new connection ID

Examples

ADD CONNECTION MYDB01;

Notes

Creates a new database connection: ADD CONNECTION <id>.

id is mandatory and must not already exist in the Connections Definition File (CDF) - the command fails otherwise. The command then runs an interactive wizard, prompting in turn for Name, Type, URL, User Name, User Password, Database Group, Environment and Comment, followed by a [y/n/c] confirmation: y saves the connection and immediately test-connects to it (reporting success or failure without aborting the save), n restarts the wizard from the top, anything else aborts without saving.

Environment is mandatory and must reference an existing Environment. Database Group is optional - leaving the prompt blank creates a standalone connection (no Database Group); if specified, it must reference an existing Database Group, and the (Database Group, Environment) pair must not already be used by another connection (docs/CONNECTION_MODEL.md).

There is no non-interactive way to create a connection with this command; all fields must be entered through the prompts.

The Type prompt lists every recognized database type, marking (never excluding) any whose JDBC driver class isn't found in drivers/ or lib/; such a type can still be picked, but a connection using it will fail to CONNECT until the matching driver jar is added.

Last modified in release 5.1.6.