Difference between revisions of "DISPLAY STRUCTURE"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Display the structure of the active table
 
Display the structure of the active table
 
  
 
==Syntax==
 
==Syntax==
Line 10: Line 9:
 
[INDEX]
 
[INDEX]
  
[TO FILE <.txt filename> | (<expC>)] | [TO PRINT]
+
[TO FILE <.txt filename> | (<expC>)]
 
+
  
 
==See Also==
 
==See Also==
[[COPY STRUCTURE]], [[COPY STRUCTURE EXTENDED]], [[CREATE]], [[CREATE FROM]], [[DB_PRINT]], [[DISPLAY DICTIONARY]], [[DISPLAY MEMORY]], [[DISPLAY STATUS]], [[DISPLAY USERS]], [[Function Keys]], [[LIST STRUCTURE]], [[MODIFY STRUCTURE]], [[SET PAGELENGTH]], [[SET PAGEWIDTH]], [[SET PRINTER]]
+
[[COPY STRUCTURE]], [[COPY STRUCTURE EXTENDED]], [[CREATE FROM]], [[DISPLAY DICTIONARY]], [[DISPLAY MEMORY]], [[DISPLAY STATUS]], [[LIST STRUCTURE]]
 
+
  
 
==Description==
 
==Description==
The DISPLAY STRUCTURE command displays the structure of the active table.  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.
+
The DISPLAY STRUCTURE command displays the structure of the active table.
  
 
+
{| class="wikitable" width="100%"
{| class="wikitable"
+
!width="30%"|Keyword||Description
!Keyword||Description
+
 
|-
 
|-
|IN <alias>||The IN <alias> clause is used to display the structure of an open table in a workarea that is not currently selected.  Alias names may be assigned to tables with the USE command, or default to the table basename.
+
|valign="top"|IN <alias>||The IN <alias> clause is used to display the structure of an open table in a workarea that is not currently selected.  Alias names may be assigned to tables with the USE command, or default to the table basename.
 
|-
 
|-
|INDEX||The INDEX keyword is used to display index tag information along with the structure details.
+
|valign="top"|INDEX||The INDEX keyword is used to display index tag information along with the structure details.
 
|-
 
|-
|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.
+
|valign="top"|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.
|-
+
|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 41: Line 34:
 
</code>
 
</code>
  
 
==Products==
 
Recital Server, Recital
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Commands]]
 
[[Category:Commands]]
[[Category:Table Basics]]
+
[[Category:Databases]]
[[Category:Table Basics Commands]]
+
[[Category:NoSQL Commands]]

Latest revision as of 09:50, 5 February 2013

Purpose

Display the structure of the active table

Syntax

DISPLAY STRUCTURE

[IN <alias>]

[INDEX]

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

See Also

COPY STRUCTURE, COPY STRUCTURE EXTENDED, CREATE FROM, DISPLAY DICTIONARY, DISPLAY MEMORY, DISPLAY STATUS, LIST STRUCTURE

Description

The DISPLAY STRUCTURE command displays the structure of the active table.

Keyword Description
IN <alias> The IN <alias> clause is used to display the structure of an open table in a workarea that is not currently selected. Alias names may be assigned to tables with the USE command, or default to the table basename.
INDEX The INDEX keyword is used to display index tag information along with the structure details.
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.

Example

use patrons
display structure