Difference between revisions of "LIST STRUCTURE"

From Recital Documentation Wiki
Jump to: navigation, search
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=LIST STRUCTURE=
 
 
 
==Class==
 
Table Basics
 
 
 
 
==Purpose==
 
==Purpose==
 
Display the structure of the active table
 
Display the structure of the active table
Line 11: Line 4:
  
 
==Syntax==
 
==Syntax==
LIST STRUCTURE
+
LIST STRUCTURE [IN <alias>] [INDEX] [TO FILE <.txt filename> | (<expC>)] | [TO PRINT]
 
+
[IN <alias>]
+
 
+
[INDEX]
+
 
+
[TO FILE <.txt filename> | (<expC>)]
+
 
+
[TO PRINT]
+
  
  
 
==See Also==
 
==See Also==
[[CREATE]], [[DISPLAY DICTIONARY]], [[DISPLAY MEMORY]], [[DISPLAY STATUS]], [[DISPLAY USERS]], [[SET PAGELENGTH]], [[MODIFY STRUCTURE]], [[SET PAGEWIDTH]], [[SET PRINTER]]
+
[[COPY STRUCTURE]], [[COPY STRUCTURE EXTENDED]], [[CREATE]], [[CREATE FROM]], [[DISPLAY DICTIONARY]], [[DISPLAY MEMORY]], [[DISPLAY STATUS]], [[DISPLAY STRUCTURE]], [[DISPLAY USERS]], [[LIST DICTIONARY]], [[SET PAGELENGTH]], [[MODIFY STRUCTURE]], [[SET PAGEWIDTH]], [[SET PRINTER]]
  
  
Line 39: Line 24:
 
|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 <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.
+
|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.
 
|-
 
|-
 
|}
 
|}
Line 52: Line 37:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital Server, Recital  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Commands]]
 
[[Category:Commands]]
 +
[[Category:Table Basics]]
 +
[[Category:Table Basics Commands]]

Latest revision as of 17:13, 11 November 2009

Purpose

Display the structure of the active table


Syntax

LIST STRUCTURE [IN <alias>] [INDEX] [TO FILE <.txt filename> | (<expC>)] | [TO PRINT]


See Also

COPY STRUCTURE, COPY STRUCTURE EXTENDED, CREATE, CREATE FROM, DISPLAY DICTIONARY, DISPLAY MEMORY, DISPLAY STATUS, DISPLAY STRUCTURE, DISPLAY USERS, LIST DICTIONARY, SET PAGELENGTH, MODIFY STRUCTURE, SET PAGEWIDTH, SET PRINTER


Description

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

use patrons
list structure


Products

Recital Server, Recital