Ad Hoc Index Batch Interface

You can use the jadclient executable RootSchema application AdHocIndexBatchApp to create indexes suitable for optimizing ad hoc queries without requiring database reorganization. For details about ad hoc indexes, see "Maintaining Ad Hoc Indexes", in Chapter 9 of the JADE Development Environment User's Guide.

The JADE initialization file can contain the [JadeAdHocIndex] section, which enables you to specify options for the worker applications that build, drop, and delete an ad hoc index, and for the controller application that starts worker applications when there is an ad hoc index maintenance operation to be performed. For details about the BuildCommitPeriod and MaxBuildWorkers parameters, see "JADE Ad Hoc Index Section [JadeAdHocIndex]", in the JADE Initialization File Reference.

To execute the AdHocIndexBatchApp application from the non‑GUI client program (for example, from a command script), specify the following.

jadclient schema=RootSchema
          app=AdHocIndexBatchApp
          server=multiUser
          path=database-path
          ini=JADE-initialization-file-path
          startAppParameters
          [command-line-arguments]

The list of command line arguments that you can define after the startAppParameters argument in command=value; format are as follows.

• load=file‑name

  Loads ad hoc index definitions from an Extensible Markup Language (XML) file. Ad hoc definitions cannot be changed if the collection has been built or it is being built. If the loaded definition is unchanged from an existing definition, the load is ignored.

• save=file‑name

  Saves all ad hoc index definitions in all schemas in XML format to the specified file.

• build=ad-hoc-index-name|all

  Initiates the build of a specific ad hoc index or all definitions if all is specified. If the ad hoc index is already built, the request is ignored.

• cancel=ad-hoc-index-name|all

  Initiates the cancellation of a specific ad hoc index build or all builds that are in progress if all is specified. If the ad hoc index is not being built, the request is ignored.

• drop=ad-hoc-index-name|all

  Initiates the drop of a specific ad hoc index or all definitions if all is specified. If the ad hoc index is already dropped, the request is ignored.

• delete=ad-hoc-index-name|all

  Initiates the deletion of a specific ad hoc index or all definitions if all is specified.

• status=schema-name|all

  Checks the available status of all ad hoc indexes for a specific schema or all schemas if all is specified. If all such ad hoc indexes are not available for use by ODBC, jadclient exits with an exit code of 1202. The request also fails if there are no defined ad hoc indexes for the specified schema.

Separate each command action with a semicolon followed by a space, as shown in the following example.

jadclient.exe schema=RootSchema app=AdHocIndexBatchApp server=multiUser path=g:\jade\database\system ini=g:\jade\database\system\jade.ini startAppParameters load=C:\adHoc Files\defn.xml; build=all;

The jadclient executable exits with exit code 1201 if the processing fails or is rejected or exit code 1202 if the status command is performed and the index or indexes are not active.