Working with toolkits paths

The sc command searches for toolkits by using the SPL path. The SPL path can be specified by using the -t, --spl-path option with a colon ':' separated list of paths. Multiple appearances of the -t option are also supported.

Each path can be one of the following choices:

  • Toolkit directory
  • Directory of toolkit directories, which is equivalent to listing the toolkit directories individually
  • Toolkit list file
The toolkit list file is an XML document that specifies a list of toolkit paths, where a path can be one of the three items. An example toolkit list file is given as follows:
<toolkitList xmlns="http://www.teracloud.com/xmlns/prod/streams/spl/toolkitList"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.teracloud.com/xmlns/prod/streams/spl/toolkitList
        toolkitListModel.xsd">
  <toolkit directory="path/to/toolkitDir" />
  <toolkit listFile="path/to/toolkitList.xml" />
  <toolkit directory="/absolute/path/to/dirOfToolkitDirs" />
</toolkitList>

The sc compiler also recognizes the STREAMS_SPLPATH environment variable. When the -t option is missing, the STREAMS_SPLPATH environment variable is used to retrieve the SPL path.

The toolkits are resolved based on version numbers. When multiple versions of a toolkit exist in the SPL path, that is, toolkits with the same name but different versions, the one with the highest version number is picked. If a tie, the toolkit that appears earlier in the path is selected.

If the application uses multiple toolkits and there are inter-dependencies between the toolkits, then the highest toolkit version of each toolkit that satisfies all the inter-dependencies is picked. This version might not be the highest version of a toolkit.

In order for a toolkit to be recognized by the compiler, it must be already indexed, that is, it must have an up-to-date toolkit.xml file.