datasource update

Table of contents

• Synopsis
• Description
• Required argument
• Connection options
• Options
  • --project
  • --network-handler-delete

Synopsis

dbvr datasource update [-hV] [--auth-model=<authModel>]
                             [--database=<dbName>]
                             [--folder=<folder>]
                             [--host=<host>]
                             [--name=<dataSourceName>]
                             [-p=<dbPassword> | --password=<dbPassword>]
                             [--port=<port>]
                             [--project=<projectIdOrName>]
                             [--save-password=<savePassword>]
                             [-secret=<secretName>] [-sm=<secretManagerId>]
                             [--server=<server>]
                             [-u=<dbUser> | --user=<dbUser>]
                             [--url=<url>]
                             [-auth=<authParams> | --auth-property=<authParams>]...
                             [-ext=<providerParams> | --extended-property=<providerParams>]...
                             [-prop=<connectionParams> | --property=<connectionParams>]...
                             [-net-delete=<handlersToDelete> | --network-handler-delete=<handlersToDelete>]...
                             [[-net=<handlerParams> | --network-handler-param=<handlerParams>]...
                              [-net-save-pwd=<savePassword> | --network-handler-save-password=<savePassword>]]
                             <datasourceIdOrName>

Tip: You can also use global options with this command.

Description

Update an existing datasource.

Use this command to change connection settings, authentication details, network handlers, project placement, or the datasource name.

Only the parameters you specify are modified. All other configuration values remain unchanged.

The command doesn’t validate connectivity by default. If you change connection properties such as --host, --port, --database, or --url, test the connection separately using sql.

Tip: Run datasource view <id> before and after the update to verify what changed.

Required argument

<datasourceIdOrName>

Specify the datasource ID or name. The value must match an existing datasource in the active workspace.

Tip: Run datasource list to see available datasources. You can use either the value from the ID column or the NAME column.

Connection options

Use connection settings to specify which database this command runs against.

Connect in one of these ways:

• use an existing datasource with -ds or --datasource
• provide a full connection specification with -con, -ds-spec, -connect, or --datasource-specification
• define a connection inline with --driver and connection parameters

Include credentials, network handlers, and driver-specific properties if required.

For details on all connection settings, see Connection options.

Options

--project

--project=<projectIdOrName>

Move the datasource to the specified project.

Tip: Run project list to see available projects.

--network-handler-delete

-net-delete, --network-handler-delete=<handlersToDelete>

Remove one or more configured network handlers from the datasource.

Example:

dbvr datasource update <datasourceIdOrName> \
  --network-handler-delete=ssh

This removes the configured SSH network handler from the datasource.