The workbench commands can be written into the command line, or they can be specified directly as an argument of the call xpl.
When doing so, commands can be abbreviated as long as they remain unique (see uppercases in the command syntax).
Instead of unique program and module names it is possible to specify search patterns to limit the eligible programs and modules.
The version can be written directly after the module name specification, separated from it by a blank. The result list can be limited by specifying a search argument after the parameter symbol '-p'.
Examples: ml customer.* TEST -p FORM all form modules of the
program 'CUSTOMER' are
displayed in the test
version.
print c????."start" only the modules named
'start' of all programs
whose names begin with
'c' and have a length
of five characters are
printed out.
Description of the Workbench Commands:
ACREATE Command
With ACREATE, an alias name is created for a DB procedure. This name is used to identify the DB procedure from Windows programs that use the ODBC library.
Example: ACR accept FOR DBPROC customer.accept
COPY Command
With COPY the specified program of another user is copied to the own library.
Example: COPY CUSTOMER FROM MILLER PROD
DEBUG Command
The DEBUG command activates (deactivates) an option which allows modules to be compiled in such a way that they can be processed with the SQL-PL debugger. DEBUG without the parameters ON/OFF displays the current state.
Example: DEB ON
DELETE Command
With DELETE the specified module is deleted (and the whole program, if this is the only module of the program).
Example: DEL customer.reservation
DOMAIN Command
DOMAIN is an independent tool for the management of database objects and their relationships (see the DOMAIN manual).
DROP Command
With DROP the whole program is dropped from the user's SQL-PL library. DROP applied to a program of another user has the effect of revoking the execute privilege.
Example: DROP customer
EDIT Command
EDIT has the effect that the editor is called to edit either a new module or the specified module.
Examples: EDIT customer.reservation
EDIT /* to generate a new module
EWARN Command
The EWARN command can be used to enable the option for EDIT-WARNING. Then a message is output, when a program is called and one or more modules of the same program have the EDIT state.
Example: EWARN ON
EXEC Command
EXEC can be used to issue operating system commands.
EXIT Command
EXIT terminates the current SQL-PL session. When EXIT is specified in the editor, the current content of the editing form is not saved.
EXPORT Command
EXPORT writes programs to an operating system file. The modules are separated from each other by ENDMODULE. Granted privileges are exported as workbench commands.
Examples: EXPORT *.start all_menus TEST -p EDIT
EXP customer customer.pl APP
EXPRESS
EXPRESS is a tool for the generation of SQL-PL programs (see chapter The Generator EXPRESS).
GETHIST Command
The GETHIST command cancels the MKPROD command.
Example: GET customer
GRANT Command
With GRANT ... TO either the explicit execute privilege for a program is granted to a definite user or the implicit execute privilege (PUBLIC) is granted to all SQL-PL users. GRANT without TO specification displays a list of those users who have an execute or copy privilege for the program concerned. GRANT COPY also grantsthe implicit EXECUTE privilege (GRANT EXECUTE).
Examples: GRANT EXECUTE ON customer TO miller
GRA COP ON customer
HELP Command
HELP provides information about the workbench functions, the SQL-PL language syntax, REPORT commands and SQL statements.
Example: HELP
IMPORT Command
This command reads in a program from a file generated by means of the EXPORT command. It expects that the individual modules are separated from each other by ENDMODULE. The specified privileges commands are executed.
Example: IMP customer.fil
LANGUAGE Command
The LANGUAGE command can be used to set a language for the translation of modules with literals.
Example: LANG
LITERAL Command
LITERAL changes the LIT-CHECK option. If LIT-CHECK is ON, a module is searched for LITERAL entries and a check is made as to whether these are already entered in the literal table. If the entry is missing, a form for defining the literal is displayed. In the editor the LITERAL command can be called without parameters. In this case the current editing form is checked.
Example: LIT CUSTOMER.S*
MKPROD Command
With the MKPROD command a production version is made from a test version. When doing so, a production version which might already exist is saved as historic version, if 'NOHIST' has not been specified.
Example: MKP customer
MLIST Command
MLIST generates an index of modules for which the user has the execute privilege. It is possible to specify search patterns and search arguments.
Examples: MLIST miller.customer.*
MLIST c?er.start
MLIST c* -p FORM
MLIST -p SAVE
MLIST *.start -p >94/12/24
MONITOR Command
The MONITOR command enables the user to have information displayed about the execution of a program. When the monitor is switched on, the results are displayed directly after the execution of a program.
Examples: MON on
MON off
PCREATE Command
The command PCREATE stores a DB procedure in the database kernel. The state indication in the module list is changed from 'RUN' to '->DB' or ' +DB'.
Example: PCR customer.insert
PDROP Command
The command PDROP cancels the command PCREATE, i.e. the DB procedure is removed from the database kernel, thus becoming modifiable again.
Example: PDR customer.insert
PGRANT Command
PGRANT can be used to grant the execute privilege for a DB proeedure.
Example: PGRANT customer.accept TO PUBLIC
PLIST Command
According to a search pattern, if any, PLIST provides a menu of all SQL-PL programs which the user is allowed to call.
Examples: PLIST *.* displays all programs that can be called.
PL C* displays only those programs of the user
which begin with 'C'.
PPRIV Command
PPRIV displays the privileges granted for DB procedures.
Example: PPRIV customer.accept TO PUBLIC
PREVOKE Command
PREVOKE removes the execute privilege granted for a DB procedure.
Example: PREVOKE customer.accept TO PUBLIC
PRINT Command
With PRINT one or more modules or one or more programs are printed out.
Examples: PRINT customer.*
PRINT c?er.start
PRINT c* -p PROC
PRINT -p FUNC
PRINT *.start -p =97/12/24
PRIVILEGES Command
PRIVILEGES provides an index of the execute privileges that have been granted for all or for a particular program. In this index privileges for own programs can be withdrawn by means of REVOKE or foreign programs be copied or called.
Example: PRIV customer
PSHOW Command
The command PSHOW displays all DB procedures which the user has stored in the database kernel.
Example: PS
QUIT Command
With QUIT the editor is left without saving the current content of the form. The effects of previous SAVE commands are kept. The QUIT command can only be used in the editor.
REVOKE Command
REVOKE ... FROM withdraws either the explicit execute privilege from a particular user or the implicit execute privilege for a definite program from all users (PUBLIC). REVOKE without FROM specification displays a menu of all users who have a privilege for these programs.
Examples: REVOKE COPY ON C* FROM miller
REVOKE EXECUTE ON customer FROM PUBLIC
RUN Command
RUN starts the execution of the specified module.
Parameters can be specified which will be assigned to the formal parameters of the routine. The parameter specification begins with '-p'. The individual parameters are separated from each other by blanks.
Examples: RUN charles.customer.resservation
RUN customer.reservation
R customer
R customer -p charles miller
SAVE Command
With SAVE the currently edited version of the module is saved without checking it for executability. The module obtains the state EDIT (see module list display). The command can only be used within the editor; the editor is not left.
SET Command
The SET command has the effect that a form is displayed in which the user-specific settings relevant for SQL-PL (language, date format, ... ) can be modified. If a valid version (TEST, PROD, HIST) is specified after the SET command, the version setting is changed directly without displaying the SET menu.
A detailed description is given in the chapter User-specific SET Parameters.
Example: SET
SOPT Command
The SOPT command can be used to enable or disable the automatic SQL syntax check.
Example: SOPT ON
SQL Command
SQL provides the possibility of issuing database commands out of SQL-PL. After calling SQL a window opens in the lower half of the screen to enter the DB queries. The results of the query are output by means of REPORT.
STORE Command
STORE performs a syntax check for a set of SQL-PL modules and stores them.
In the editor STORE checks the current module for executability. If an error is detected, this is marked on the screen and an error message is output; otherwise the module is stored obtaining the state RUN.
Examples: ST customer.*
STO c?er.start
ST c* -p DEBUG
STORE -p SAVE
ST *.start -p <97/12/24
TCREATE Command
The command TCREATE activates a trigger procedure. In a dialog box the table name and the column names to which the trigger shall be applied must be specified. After successful activation, the state in the module list is changed from 'RUN' to '->DB'.
Example: TCR customer.insert
TDROP Command
The command TDROP cancels the TCREATE command, i.e. the trigger is removed from the kernel and deactivated.
Example: TDR customer.insert
TEST Command
TEST performs a syntax check for the currently edited module and executes it at once. If an error is detected, this is marked and an error message is output. Parameters which are to be passed with the call must be written into the command line. Then TEST is started with the function key. The editor is not left.
All modifications made to database contents during the test run are reset at the end of the run.
The TEST command can only be used within the editor.
TIME Command
TIME outputs the current date and time of day in the middle of the screen.
TSHOW Command
The command TSHOW displays alle triggers which the user has activated in the database kernel. For the program name and the module name search patterns can be specified as parameters.
Examples: TSH
TSH c*
TSH *.insert
USAGE Command
With the USAGE command the maintenance of the used-relations in the Data Dictionary can be enabled or disabled.
Example: USAGE ON
VALUE Command
VALUE generates an index of all variables of the module displayed in the editor. The index contains the current values from the last TEST execution. The command can only be used in the editor. The display of variables can be restricted by specifying a search argument in the command line.
VERSION Command
VERSION outputs the creation date and time of the current workbench version in the middle of the screen.
XREF Command
XREF shows how the global variables of a program are used in the modules. This command can also be used to find out which variables are used by a certain module. With a function key, the grouping can be toggled between module or variable.
Examples: XREF customer
