Spotfire® Server and Environment - Installation and Administration

update-datasource

Updates an Information Services data source with new settings.

update-datasource
[-b value | --bootstrap-config=value]
[-t value | --tool-password=value]
<-u value | --user=value> 
<-i value | --item-id=value> 
[--from-catalog=value] 
[--to-catalog=value] 
[--from-schema=value] 
[--to-schema=value] 
[--datasource-type=value] 
[--database-url=value] 
[--database-user=value] 
[--database-password=value] 
[--database-user-authentication=<true|false>] 
[--max-connection=value] 
[--min-connection=value] 
[--validate=<true|false>]

Overview

Use this command to update an Information Services data source. You can change the connection URL, the username, password, and edit the 'User authentication' setting.

Options

Option Optional or Required Default Value Description
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-t value
--tool-password=value
Optional none The configuration tool password used to decrypt the database password in the file bootstrap.xml. If the tool password is omitted, the command prompts the user for it in the console. See Bootstrap.xml file.
-u value
--user=value
Required none The user performing the update. The user should be an Information Modeler. The name of the user needs to include the user's domain name, for example 'DOMAIN\user' or 'user@domain', unless the user is part of the configured default domain.
-i value
--item-id=value
Required none The library ID of the Information Services data source to update.
--from-catalog=value
Optional none To redirect dependent elements, provide the name of the current catalog in the database.
--to-catalog=value
Optional none To redirect dependent elements, provide the name of the catalog in the database to change to.
--from-schema=value
Optional none To redirect dependent elements and change the schema, provide the name of the current schema in the database.
--to-schema=value
Optional none To redirect dependent elements and change the schema, provide the name of the schema in the database to change to.
--datasource-type=value
Optional none Change what data source template the data source is linked to. Enter the type-name of the data source template to switch to.
--database-url=value
Optional none The new connection URL to use in the data source. Required if you set the datasource-type.
--database-user=value
Optional none The new username to use for authentication with the database in the data source.
--database-password=value
Optional none The new password to use for authentication with the database in the data source.
--database-user-authentication=<true|false>
Optional none Specifies if the 'User authentication' setting should be enabled.
--max-connection=value
Optional -1 Set the value for the 'Maximum number of connections' setting in the data source.
--min-connection=value
Optional -1 Set the value for the 'Minimum number of connections' setting in the data source.
--validate=<true|false>
Optional false Specifies whether to validate the data source with the new settings before saving it.