Running the SubStringIndexTool
The SubStringIndexTool is used to create the schema objects associated with a substring index, and populate them with data from the source attribute. If the source attribute exists in a class that has subclasses, then the substring index contains information for all subclasses. The tool is run from a Windchill shell, using the following syntax:
windchill wt.pds.subStringIndex.SubStringIndexTool <operation> <user> <password> [<class name>] [<attribute name>]
where
• <operation> specifies the type of action to be performed on the substring index. For a complete list of available operations, see the following table.
• <user> and <password> are the credentials for a database installation user.
• <class name> and <attribute name> identify the object attribute for a substring index specified in the configuration file. If <class name> and <attribute name> are not specified, then the <operation> is applied to all substring index entries configured in the configuration file. The <class name> and <attribute name> arguments are optional.
The tool may take some time to complete, depending on the size of your database.
The SubStringIndexTool supports the following operations:
|
Operation
|
Description
|
||
|---|---|---|---|
|
create
|
Performs all operations necessary to make the substring index usable by the system, in the following order: config, table, build, and index.
|
||
|
config
|
Reloads configuration information in the method server.
|
||
|
build
|
Populates the substring index schema objects with data from the source attribute.
|
||
|
table
|
Creates the table schema object for the substring index.
|
||
|
index
|
Creates the index schema objects for the substring index.
|
||
|
sync
|
Manually synchronizes the substring index data with the associated source attribute values.
|
||
|
drop
|
Drops all schema objects for the substring index.
|
