Read Time: 2 minute(s)

Tags: file indexing

# Description

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

list-index -Options filename {Same as jQL options}

where options may be:

Option Description
-ffile Use the filename "file" instead of a temporary file
-m Output is in Machine readable format (see table below)
-v Verbose mode - all fields will be displayed
  • 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 produce "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.
  • Option -v is for verbose mode -- all details will be printed instead of a smaller selection.

For instance to display all the index definitions, in full, for file CUSTOMERS, and send the output to the printer, one would proceed as follows:


# Breakdown of Machine Readable format

Tab Number Description INDICES() Attribute reference
1 Index Name <0>
2 Not used na
3 Sort criteria <1>
4 Base FID of Index na
5 Always '1' na
6 Index Type <2>
7 Create time <5>
8 Modify time <6>
9 Index number (zero based) na
10 DEBUG flag <7>
11 NULL flag <8>
12 CASE flag <9>
13 MULTI-VALUE flag <10>
14 SYNC flag <11>
15 VALUE MAX count <12>
16 thru 19 Not used na
20 INDEX definition <3>
21 Lookup definition <4>

Back to Indexes