Difference between revisions of "LIST INDEXES"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
List index information about the current table
 
List index information about the current table
 
  
 
==Syntax==
 
==Syntax==
 
LIST INDEXES
 
LIST INDEXES
  
[TO FILE <.txt filename> | (<expC>)] | [TO PRINT]
+
[TO FILE <.txt filename> | (<expC>)]
 
+
  
 
==See Also==
 
==See Also==
[[CDX()]], [[CLOSE INDEX]], [[COPY INDEXES]], [[COPY TAG]], [[CREATE VIEW]], [[DBXDESCEND()]], [[DELETE TAG]], [[DESCEND()]], [[DISPLAY INDEXES]], [[DTOS()]], [[FIND]], [[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]], [[DBXDESCEND()]], [[DELETE TAG]], [[DESCEND()]], [[DISPLAY INDEXES]], [[DTOS()]], [[LOOKUP()]], [[LTOS()]], [[MDX()]], [[REINDEX]], [[RLOOKUP()]], [[SEEK]], [[SEEK()]], [[SET INDEX]], [[SET ORDER]], [[STR()]], [[STRZERO()]], [[SYS()]], [[TAG()]], [[TAGCOUNT()]], [[TAGNO()]], [[USE]]
 
+
  
 
==Description==
 
==Description==
Line 35: Line 32:
 
The master index tag is flagged as such.
 
The master index tag is flagged as such.
  
 
+
===TO <file>===
{| class="wikitable"
+
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.
!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==
 
<code lang="recital">
 
<code lang="recital">
// Recital/4GL
 
 
use example
 
use example
 
list indexes to file ind_info
 
list indexes to file ind_info
 
</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 13:15, 9 February 2012

Purpose

List index information about the current table

Syntax

LIST INDEXES

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

See Also

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

Description

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

The LIST 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

use example
list indexes to file ind_info