Difference between revisions of "LIST TABLES"
From Recital Documentation Wiki
Yvonnemilne (Talk | contribs) |
Yvonnemilne (Talk | contribs) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Purpose== | ==Purpose== | ||
List table information about the active database | List table information about the active database | ||
| Line 11: | Line 4: | ||
==Syntax== | ==Syntax== | ||
| − | LIST TABLES | + | LIST TABLES [TO FILE <.txt filename> | (<expC>)] | [TO PRINT] |
| − | + | ||
| − | [TO FILE <.txt filename> | (<expC>)] | + | |
| − | + | ||
| − | [TO PRINT] | + | |
==See Also== | ==See Also== | ||
| − | [[ALTER TABLE]], [[ALTER INDEX]], [[CLOSE DATABASES]], [[CLOSE TABLES]], [[COMPILE DATABASE]], [[CREATE DATABASE]], [[CREATE INDEX]], [[CREATE TABLE]], [[CREATE VIEW]], [[DISPLAY DATABASE]], [[DISPLAY INDEXES]], [[DISPLAY TABLES]], [[DROP DATABASE]], [[DROP INDEX]], [[DROP TABLE]], [[ | + | [[ADATABASES()]], [[ADD TABLE]], [[ALTER TABLE]], [[ALTER INDEX]], [[CLOSE DATABASES]], [[CLOSE TABLES]], [[COMPILE DATABASE]], [[COPY DATABASE]], [[CREATE DATABASE]], [[CREATE INDEX]], [[CREATE TABLE]], [[CREATE VIEW]], [[DB_DATADIR]], [[DBUSED()]], [[DISPLAY DATABASE]], [[DISPLAY INDEXES]], [[DISPLAY SCHEMAS]], [[DISPLAY TABLES]], [[DROP DATABASE]], [[DROP INDEX]], [[DROP TABLE]], [[GETENV()]], [[LIST DATABASE]], [[LIST INDEXES]], [[LIST SCHEMAS]], [[OPEN DATABASE]], [[REMOVE TABLE]], [[SET AUTOCATALOG]], [[SET DATADIR]], [[SET EXCLUSIVE]], [[SET PAGELENGTH]], [[SET PAGEWIDTH]], [[SET PRINTER]], [[SET SQL]], [[USE]] |
| Line 25: | Line 14: | ||
The LIST TABLES command displays the base name and file name including the full path for each table in the currently active database. | The LIST TABLES command displays the base name and file name including the full path for each table in the currently active database. | ||
| − | Databases in Recital are implemented as directories containing files that correspond to the tables and associated files in the database. Operating System file protection can be applied individually to the files for added security. The directories are sub-directories of the Recital data directory. The environment variable | + | Databases in Recital are implemented as directories containing files that correspond to the tables and associated files in the database. Operating System file protection can be applied individually to the files for added security. The directories are sub-directories of the Recital data directory. The environment variable DB_DATADIR points to the current Recital data directory and can be queried using the GETENV() function. Files from other directories can be added to the database using the ADD TABLE command or via the database catalog and SET AUTOCATALOG functionality. Databases are opened using the OPEN DATABASE command. |
| Line 33: | Line 22: | ||
|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 40: | Line 29: | ||
==Example== | ==Example== | ||
<code lang="recital"> | <code lang="recital"> | ||
| − | + | OPEN DATABASE southwind | |
| − | + | LIST TABLES | |
</code> | </code> | ||
==Products== | ==Products== | ||
| − | Recital | + | Recital Server, Recital |
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Commands]] | [[Category:Commands]] | ||
[[Category:SQL]] | [[Category:SQL]] | ||
| + | [[Category:Databases]] | ||
| + | [[Category:Databases Commands]] | ||
Latest revision as of 10:05, 26 August 2011
Purpose
List table information about the active database
Syntax
LIST TABLES [TO FILE <.txt filename> | (<expC>)] | [TO PRINT]
See Also
ADATABASES(), ADD TABLE, ALTER TABLE, ALTER INDEX, CLOSE DATABASES, CLOSE TABLES, COMPILE DATABASE, COPY DATABASE, CREATE DATABASE, CREATE INDEX, CREATE TABLE, CREATE VIEW, DB_DATADIR, DBUSED(), DISPLAY DATABASE, DISPLAY INDEXES, DISPLAY SCHEMAS, DISPLAY TABLES, DROP DATABASE, DROP INDEX, DROP TABLE, GETENV(), LIST DATABASE, LIST INDEXES, LIST SCHEMAS, OPEN DATABASE, REMOVE TABLE, SET AUTOCATALOG, SET DATADIR, SET EXCLUSIVE, SET PAGELENGTH, SET PAGEWIDTH, SET PRINTER, SET SQL, USE
Description
The LIST TABLES command displays the base name and file name including the full path for each table in the currently active database.
Databases in Recital are implemented as directories containing files that correspond to the tables and associated files in the database. Operating System file protection can be applied individually to the files for added security. The directories are sub-directories of the Recital data directory. The environment variable DB_DATADIR points to the current Recital data directory and can be queried using the GETENV() function. Files from other directories can be added to the database using the ADD TABLE command or via the database catalog and SET AUTOCATALOG functionality. Databases are opened using the OPEN DATABASE command.
| 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
OPEN DATABASE southwind LIST TABLES
Products
Recital Server, Recital
