Spotfire® Server and Environment - Installation and Administration

list-datasources

Lists Information Services data sources in the Spotfire library.

list-datasources 
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value] 
<-u value | --user=value> 
[-c value | --connection-url=value] 
[-s value | --datasource-username=value] 
{-Pkey=value | --connection-propertieskey=value} 
[-q value | --library-search-expression=value] 
[-e value | --export-file=value] 
[-f | --force]

Overview

Use this command to generate a list of Information Services data sources in the Spotfire library. Creates a JSON file with a list of all data sources that match the given criteria. You can include filter criteria such as the connection URL, database username, or a library search expression.

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 operation. Should be a library administrator who has access to all data sources.
-c value
--connection-url=value
Optional none The connection URL specified in the data source.
-s value
--datasource-username=value
Optional none The username specified in the data source for logging in to the external database.
-Pkey=value
--connection-propertieskey=value
Optional none The connection properties specified in the data source. Connection properties are key-value pairs that specify settings for the connection to a database. Values must be in the format key=value. This argument is optional and can be specified multiple times with different keys.
-q value
--filter-string=value
Optional none A Spotfire library search query that limits which data sources to include in the list.
-e value
--export-file=value
Optional none The path to the JSON report file to create. This argument is optional.
-f
--force
Optional none Indicates that the tool should overwrite an existing destination file.

Examples

Listing all Information Services data sources from the library
list-datasources -u {{user-name}}
Listing all Information Services data sources from the library filtered by library search expression for the data source name
list-datasources -u {{user-name}} --library-search-expression="name:MyDataSourceName"
Listing all Information Services data sources from the library filtered by library search expression for the data source template type
list-datasources -u {{user-name}} --library-search-expression="Spotfire.DataSourceTemplate.TypeName:oracle"
Listing all Information Services data sources from the library filtered by library search expression for the data source driver class:
list-datasources -u {{user-name}} --library-search-expression="Spotfire.DataSourceTemplate.DriverClass:com.mysql.jdbc.Driver"
Listing all Information Services data sources from the library filtered by library search expression with multiple arguments
list-datasources -u {{user-name}} --library-search-expression="Spotfire.DataSourceTemplate.TypeName:MyTemplateType AND name:MyDataSourceName"
list-datasources -u {{user-name}} --library-search-expression="Spotfire.DataSourceTemplate.TypeName:MyTemplateType AND name:MyDataSourceName OR name:MyDataSourceName2"
Listing all Information Services data sources from the library filtered by library search expression for multiple data source names
list-datasources -u {{user-name}} --library-search-expression="name:MyDataSourceName1 OR name:MyDataSourceName2"
Listing all Information Services data sources from the library filtered by library search expression for driver or data source name
list-datasources -u {{user-name}} --library-search-expression="Spotfire.DataSourceTemplate.DriverClass:com.microsoft.sqlserver.jdbc.SQLServerDriver OR name:MyDataSourceName"
Listing all Information Services data sources from the library filtered by connection property and connection URL
list-datasources -u {{user-name}} --connection-propertiespropertyName=property --connection-url="jdbc:oracle:thin:@//localhost:1521/mydb"
Listing all Information Services data sources from the library filtered by data source username
list-datasources -u {{user-name}} --datasource-username=myusername