config-library-external-data-storage
Configures the external library data storage.
config-library-external-data-storage
[-c value | --configuration=value]
[-b value | --bootstrap-config=value]
[-t value | --tool-password=value]
<-e <true|false> | --enabled=<true|false>>
[-s value | --external-storage=value]
[-f | --force]
Overview
Use this command for general configuration of the external library data storage.
When this feature is enabled, the structure of the library is stored in the Spotfire database, while the actual data of library items is stored elsewhere.
The library must be empty when you switch to or from an external data storage. The prescribed procedure for switching is to export the entire library, empty the library, change the configuration, and then import the library. Switching storage modes with items in the library causes data to be lost.
When you change the external library data storage configuration with this command, a query is made to the
Spotfire database to make sure that the library is empty. This check can be overridden by using the
--force
argument.
Currently, Spotfire supports two options for external data storage: storing on the server's file system, or storing on Amazon S3. After enabling this feature, you must configure the storage using the config-library-external-file-storage command or config-library-external-s3-storage command.
Options
Option | Optional or Required | Default Value | Description |
---|---|---|---|
|
Optional | configuration.xml | The path to the server configuration file. |
|
Optional | none | The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file. |
|
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. Refer to Bootstrap.xml file. |
|
Required | none | Specifies whether external library data storage should be enabled. |
|
Optional | none | The external storage to use. The following names are valid: FILE_SYSTEM and AMAZON_S3. |
|
Optional | none | Indicates that the tool should change the library configuration even if the library is not empty. |