Difference between revisions of "LIST STRUCTURE"

From Lianjapedia
Jump to: navigation, search
(Description)
(Description)
 
(7 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
==Syntax==
 
==Syntax==
LIST STRUCTURE [IN <alias>] [INDEX] [TO FILE <.txt filename> | (<expC>)] | [TO PRINT]
+
LIST STRUCTURE [IN <alias>] [INDEX] [TO FILE <.txt filename> | (<expC>)]
  
 
==See Also==
 
==See Also==
[[COPY STRUCTURE]], [[COPY STRUCTURE EXTENDED]], [[CREATE FROM]], [[DISPLAY DICTIONARY]], [[DISPLAY MEMORY]], [[DISPLAY STATUS]], [[DISPLAY STRUCTURE]], [[LIST DICTIONARY]], [[SET PRINTER]]
+
[[COPY STRUCTURE]], [[COPY STRUCTURE EXTENDED]], [[CREATE FROM]], [[DISPLAY DICTIONARY]], [[DISPLAY MEMORY]], [[DISPLAY STATUS]], [[DISPLAY STRUCTURE]], [[LIST DICTIONARY]]
  
 
==Description==
 
==Description==
 
The LIST STRUCTURE command displays the structure of the active table.
 
The LIST STRUCTURE command displays the structure of the active table.
  
{| class="wikitable"
+
{| class="wikitable" width="100%"
!Keyword||Description
+
!width="15%"|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 list index tag information along with the structure details.
+
|valign="top"|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.
+
|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.
+
 
|-
 
|-
 
|}
 
|}
 +
 +
From Lianja v6.0, if the table is a [[Virtual Tables|Virtual Table]], the following information is also displayed:
 +
* Connection String (connstr)
 +
* Database Type (dbtype)
 +
* Properties
 +
* Base Table (basetable)
 +
* SQL Command
 +
* Primary Key (primarykey)
 +
* Update Field List (updatefieldlist)
 +
* Named Parameters (namedparameters)
  
 
==Example==
 
==Example==
Line 32: Line 40:
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Commands]]
 
[[Category:Commands]]
[[Category:Table Basics]]
+
[[Category:Databases]]
[[Category:Table Basics Commands]]
+
[[Category:NoSQL Commands]]

Latest revision as of 05:50, 4 January 2021

Purpose

Display the structure of the active table

Syntax

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

See Also

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

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.

From Lianja v6.0, if the table is a Virtual Table, the following information is also displayed:

  • Connection String (connstr)
  • Database Type (dbtype)
  • Properties
  • Base Table (basetable)
  • SQL Command
  • Primary Key (primarykey)
  • Update Field List (updatefieldlist)
  • Named Parameters (namedparameters)

Example

use patrons
list structure