Difference between revisions of "DISPLAY INDEXES"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Display index information about the current table
 
Display index information about the current table
 
  
 
==Syntax==
 
==Syntax==
DISPLAY INDEXES [TO FILE <.txt filename> | (<expC>)] | [TO PRINT]
+
DISPLAY INDEXES [TO FILE <.txt filename> | (<expC>)]
 
+
  
 
==See Also==
 
==See Also==
[[CDX()]], [[CLOSE INDEX]], [[COPY INDEXES]], [[COPY TAG]], [[CREATE VIEW]], [[DB_PRINT]], [[DELETE TAG]], [[DBXDESCEND()]], [[DESCEND()]], [[DTOS()]], [[FIND]], [[Function Keys]], [[LIST INDEXES]], [[LOOKUP()]], [[LTOS()]], [[MDX()]], [[REINDEX]], [[RLOOKUP()]], [[SEEK]], [[SEEK()]], [[SET INDEX]], [[SET ORDER]], [[SET PAGELENGTH]], [[SET PAGEWIDTH]], [[SET PRINTER]], [[STR()]], [[STRZERO()]], [[SYS()]], [[TAG()]], [[TAGCOUNT()]], [[TAGNO()]], [[USE]]
+
[[CDX()]], [[CLOSE INDEX]], [[COPY INDEXES]], [[COPY TAG]], [[CREATE VIEW]], [[DB_PRINT]], [[DELETE TAG]], [[DBXDESCEND()]], [[DESCEND()]], [[DTOS()]], [[LIST INDEXES]], [[LOOKUP()]], [[LTOS()]], [[MDX()]], [[REINDEX]], [[RLOOKUP()]], [[SEEK]], [[SEEK()]], [[SET INDEX]], [[SET ORDER]], [[STR()]], [[STRZERO()]], [[SYS()]], [[TAG()]], [[TAGCOUNT()]], [[TAGNO()]], [[USE]]
 
+
  
 
==Description==
 
==Description==
Line 33: Line 30:
 
The master index tag is flagged as such.
 
The master index tag is flagged as such.
  
DISPLAY commands differ from LIST commands in that they pause every 17 lines until a key is pressed.  You can cancel any further output at this point by pressing the [ABANDON] key.  Where the output is sent to a file or printer, the pause is disabled.
+
===TO <file>===
 
+
The display output will be sent to the specified file.  The filename can be substituted with a <expC>, enclosed in round brackets, which returns a valid filename.  If no file extension is specified, then ".txt" will be used.  The command SET PAGELENGTH governs the output file pagination and SET PAGEWIDTH defines the width of each page.  Page numbers are centered on the bottom of the page according to width.
 
+
{| class="wikitable"
+
!Keyword||Description
+
|-
+
|TO <file>||The display output will be sent to the specified file.  The filename can be substituted with a <expC>, enclosed in round brackets, which returns a valid filename.  If no file extension is specified, then ".txt" will be used.  The command SET PAGELENGTH governs the output file pagination and SET PAGEWIDTH defines the width of each page.  Page numbers are centered on the bottom of the page according to width.
+
|-
+
|TO PRINT||The display output will be sent to a printer.  The TO PRINT option will default to a local printer unless the command SET PRINTER TO \\SPOOLER is issued.  The print request will then be spooled to the system printer, which is defined by the environment variable DB_PRINT.
+
|-
+
|}
+
 
+
  
 
==Example==
 
==Example==
Line 53: Line 40:
 
</code>
 
</code>
  
 
==Products==
 
Recital Server, Recital
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Commands]]
 
[[Category:Commands]]
 
[[Category:Indexing]]
 
[[Category:Indexing]]
 
[[Category:Indexing Commands]]
 
[[Category:Indexing Commands]]

Revision as of 12:48, 9 February 2012

Purpose

Display index information about the current table

Syntax

DISPLAY INDEXES [TO FILE <.txt filename> | (<expC>)]

See Also

CDX(), CLOSE INDEX, COPY INDEXES, COPY TAG, CREATE VIEW, DB_PRINT, DELETE TAG, DBXDESCEND(), DESCEND(), DTOS(), LIST INDEXES, LOOKUP(), LTOS(), MDX(), REINDEX, RLOOKUP(), SEEK, SEEK(), SET INDEX, SET ORDER, STR(), STRZERO(), SYS(), TAG(), TAGCOUNT(), TAGNO(), USE

Description

The DISPLAY INDEXES command is used to display index information about the currently active table. Information is displayed for both production and single index files.

The DISPLAY INDEXES command displays the following information:

  • Production DBX file name

and for each tag:

  • Tag name
  • Key
  • Type
  • Length

and for each open single index:

  • Index file name
  • Key
  • Index cache size

The master index tag is flagged as such.

TO <file>

The display output will be sent to the specified file. The filename can be substituted with a <expC>, enclosed in round brackets, which returns a valid filename. If no file extension is specified, then ".txt" will be used. The command SET PAGELENGTH governs the output file pagination and SET PAGEWIDTH defines the width of each page. Page numbers are centered on the bottom of the page according to width.

Example

// Recital/4GL
use example
display indexes to file ind_info