list-index

List details of current index definition.

  Return to Contents Page   Return to Knowledge Base   Return to JAC Home Page

Called as:

list-index {-am} {-ffile} filename {Same as jQL options}

Supported options are:

-a Display all available information about the index
-ffile Use the filename 'file' instead of a temporary file
-m Output is in Machine readable format

This command is used to display to the screen details of all the current definitions. A format similar to jQL is produced.

Option -a all details will be printed instead of a smaller selection.

Example: Display all the index definitions, in full, for file CUSTOMERS, and send the output to the printer.

jsh--> LIST-INDEX -a CUSTOMERS (P

Option -f allows you to specify your own file name instead of list-index creating a temporary file. This way you can find out what DICTionary items are created by list-index, and if you want to you can modify them and pass them on the command line. Using this option therefore allows you to define your own output format for the command.

Option -m produces "machine readable" displays. In other words the detail is displayed simply as a series of lines, one line per index definition, with a tab character (CHAR(9)) to delimit the fields. This makes it easily parsed by another program or UNIX script.

http://807199.827977/r5/knowledgebase/manuals/3.0/SecondaryIndexes/html/list-index.htm last modified on 06/19/09 05:29 AM