Changing the configuration for library compression

By default, library items created by users of the installed Spotfire client or the web client, or items that are imported into the Spotfire library, are compressed using the gzip format. When upgrading from an older version without compression, items that are currently stored in the Spotfire library in an uncompressed format will be compressed in the background over time. This design provides an efficient use of library space, whether the library is stored in the Spotfire database or if you are using external storage. However, there might be some item types that you do not want to compress in the library, or you might want to switch off compression altogether.

Before you begin

You must have administrative credentials for Spotfire.

About this task

Tip: The command-line command export-library-content has the optional parameter compressed-content, with the default of true, which specifies whether library content should be compressed when exported. You can set this option to false to import content to an earlier release of Spotfire, where compressed content is not supported.

Procedure

Open a command-line interface and export the active configuration by using the export-config command. (For details on using the Spotfire command line, see Executing commands on the command line.)
On the command line, enter the command to change the library compression settings.
```
config set-config-prop --name=<config property name> --value=value
```
- For more information about the compression options, see Library compression configuration properties.
- For information about the CLI command options, see set-config-prop.
Import the configuration file back to the Spotfire database by using the import-config command.
Restart the Spotfire Server computers in the cluster.

Switching off library compression

The following example shows how to switch off library compression completely:

config export-config --force
config set-config-prop --name=library.compressed-content.enabled --value=false
config import-config --comment "Disable library compression"

Switching off library compression for some item types

Sometimes, you might want to switch off library item compression for just some item types. For example, columns can take up more space in the library when compressed.

About this task

Use the library.compressed-content.disabled-lib-types.type property to specify the library type to switch off compression for:

config set-config-prop --name="library.compressed-content.disabled-lib-types.type" --value="spotfire.column"

Alternatively, to specify multiple items at once, use the set-config-list-prop command:

config set-config-list-prop --name="library.compressed-content.disabled-lib-types" --item-name="type" -Vspotfire.datasource -Vspotfire.column

The following is an example of a server configuration where two library item types have been disabled:

<configuration>
  <library>
  <compressed-content>
      <enabled>true</enabled>
      <disabled-lib-types>
        <type>spotfire.datasource</type>
        <type>spotfire.column</type>
      </disabled-lib-types>
    </compressed-content>
  </library>
  ...
</configuration>

See Spotfire item types for more information about the available item types.

Switching off background compression

If the backend compression of library items seems to strain the database you can disable background compression (without disabling compression completely) and only compress new items.

About this task

Set the activities.compression.max-concurrent property to 0 to disable background compression:

config set-config-prop --name="activities.compression.max-concurrent" --value=0