SysWorks©

SysWorks
Command Reference Manual
Previous Contents Index

The valid options include:
Option Usage
BATCH_UPDATE The set transaction statement should use batch update mode.
OBJECT A transaction should be placed around each object based statement. This is particularly useful for database objects such as indices which can cause large operations to be performed.
READ_ONLY The set transaction statement should use read only mode.
READ_WRITE The set transaction statement should use read write mode.
SOURCE A transaction should be placed at the beginning of and the end of each generated source. This is particularly useful for database meta-data definitions.

Examples

#1 

$ DBATOOLS EXTRACT/SOURCE TABLES

Extracts the definitions for all tables in the current default database.

#2 

$ DBATOOLS EXTRACT/FUNCTION *DATE*/DATABASE=FIN_RDB_DIR:FIN_DATABASE

Extracts the definitions for functions containing DATE within their name from the indicated database in the FIN application.

#3 

$ DBATOOLS EXTRACT/SOURCE INDEX DDAL$* -
_$   /CLUE=(-
_$     NODE_SIZE=990,-
_$     PERCENT_FILL=100,-
_$     STORE="in ddal_indices")-
_$   /DATABASE=FIN_RUNTIME_DATABASE-
_$   /LANGUAGE=SQL=CREATE-
_$   /OUTPUT=FIN_RUN_DIR:FIN_DATABASE_CREATE_DDAL_INDICES.SQL-
_$   /TRANSACTION=(BATCH_UPDATE,OBJECT)

Extracts SQL create index statements for indices starting with DDAL$ in the FIN database. The following is a fragment of the resultant output file: 


   .
   .
   .
set transaction batch update; 
 
create unique index DDAL$DBKEY_INDEX9_1 
  on CUSTOMER_DETAILS ( 
    DDAL$DBKEY asc ) 
  type is sorted 
  node size 990 
    percent fill 100 
  disable compression 
  store in ddal_indices; 
 
commit work; 
   .
   .
   .

DBATOOLS DEFINE/KEY

Defines a key to execute a command. This enables you to press a key to enter a command instead of typing the command name.

Format

DBATOOLS DEFINE/KEY key-name "string"

Parameters

key-name

Specifies the name of the key you are defining. Use the following key names when defining keys:

Key Name VT100 VT52 LK201
PF1 PF1 red key PF1
PF2 PF2 blue key PF2
PF3 PF3 black key PF3
PF4 PF4 - PF4
KP0, KP1-KP9 keypad 0-9 keypad 0-9 keypad 0-9
Period period key period key period key
Comma comma key comma key comma key
Minus minus key minus key minus key
Enter ENTER key ENTER key ENTER key
E1,E2 - - Find,Insert Here
E3,E4 - - Remove,Select
E5 - - Previous Screen
E6 - - Next Screen
Help,Do - - Help(15), Do(16)
F17-F20 - - Function Keys

Note
You cannot redefine the arrow keys or the function keys F1 to F14.

"string"

Specifies the string you want entered when you press the defined key. "String" can be a DBATOOLS command, for example, DIRECTORY or SET FILE.

Qualifiers

/ECHO

/NOECHO

Specifies whether the command line is visible on the screen after you press the defined key. You cannot define a key specifying both the /NOECHO and /NOTERMINATE qualifiers. The default qualifier is /ECHO.

/IF_STATE=state_list

/NOIF_STATE

Specifies a list of states, any one of which must be set in order to enable the specified key definition. If you omit or negate this qualifier, the current state prevails.

States are used to increase the number of key definitions available on your terminal. The same key can be assigned any number of definitions as long as each definition is associated with a different state. State names can be any alphanumeric string.

/LOCK_STATE

/NOLOCK_STATE

Retains the state specified by the /SET_STATE qualifier until you use the /SET_STATE qualifier again to change it. The default qualifier is /NOLOCK_STATE.

States are used to increase the number of key definitions available on your terminal. The same key can be assigned any number of definitions as long as each definition is associated with a different state. State names can be any alphanumeric string.

/LOG

/NOLOG

Specifies whether informational messages are displayed. These messages signal successfully created key definitions. The default qualifier is /LOG.

/SET_STATE=state

/NOSET_STATE

Associates a state with the key you are defining. A state name can be any alphanumeric string. If you omit or negate this qualifier, the current state remains unchanged. You cannot define a key specifying both the /SET_STATE and /TERMINATE qualifiers.

States are used to increase the number of key definitions available on your terminal. The same key can be assigned any number of definitions as long as each definition is associated with a different state.

/TERMINATE

/NOTERMINATE (default)

Determines whether the specified command string executes when you press the key. When you use the /NOTERMINATE qualifier, you must press the Return key to execute the command string. You cannot define a key specifying both the /SET_STATE and /TERMINATE qualifiers.

Examples

#1 

DBATOOLS> DEFINE/KEY PF1 "DIRECTORY"

This example shows how to define the keypad key PF1 as the DIRECTORY command. To enter the DIRECTORY command, press PF1 followed by the Return key.

#2 

DBATOOLS> DEFINE/KEY KP6 "EDIT" /TERMINATE

This example shows how to define the keypad key 6 (KP6) as the EDIT command. The /TERMINATE qualifier causes the EDIT command to execute when you press KP6; you do not have to press the Return key.

#3 

DBATOOLS> DEFINE/KEY PF2 "SET "/SET_STATE=ALTERED
DBATOOLS> DEFINE/KEY PF3 "FILE" /IF_STATE=ALTERED /TERMINATE

In this example, the PF2 key is defined as the SET command, with the state name ALTERED. Then, the PF3 key is defined to output the string FILE when the state ALTERED is specified.

The /TERMINATE qualifier is used to end the command line. When you specify the /TERMINATE qualifier, you can avoid pressing the Return key to execute the command line. After you define PF2 and PF3, you can use them together. Press PF2 to produce the first half of the command line (SET) and press PF3 to finish the command line (FILE).

#4 

DBATOOLS> DEFINE/KEY PF4 "SET " /SET_STATE=ALTERED
DBATOOLS> DEFINE/KEY KP7 "FILE" /TERMINATE /IF_STATE=ALTERED
DBATOOLS> DEFINE/KEY KP8 "FORWARD" /TERMINATE /IF_STATE=ALTERED
DBATOOLS> DEFINE/KEY KP9 "WASTEBASKET" /TERMINATE /IF_STATE=ALTERED

This example shows how to define four different keys and associate them with a state named ALTERED:

  1. The first definition defines the key PF4 as the SET command and associates this key with a state named ALTERED.
  2. The second definition defines the keypad key 7 as "FILE" and makes it dependent on a state named ALTERED. When you press PF4 followed by keypad key 7, DBATOOLS executes the SET FILE command.
  3. The third definition defines keypad key 8 as "FORWARD" and also makes it dependent on the ALTERED state. When you press PF4 followed by keypad key 8, DBATOOLS executes the SET FORWARD command.
  4. The fourth definition defines keypad key 9 as "WASTEBASKET" and also makes it dependent on the ALTERED state. When you press PF4 followed by keypad key 9, DBATOOLS executes the SET WASTEBASKET command.

DBATOOLS EXIT

Exits the DBATOOLS utility. You can also exit from DBATOOLS by pressing [Ctrl/Z].

Format

DBATOOLS EXIT

Parameters

None.

Qualifiers

None.

DBATOOLS HELP

Enables you to obtain information about the DBATOOLS utility.

To obtain information about all of the DBATOOLS commands, enter the following command: 


       DBATOOLS> HELP

To obtain information about individual commands or topics, enter the HELP command followed by the command or topic name.

Format

DBATOOLS HELP topic

Parameters

topic

Indicates a topic about which you want information. To display the list of available topics, enter the HELP command at the DBATOOLS> prompt.

Qualifiers

None.

DBATOOLS SHOW VERSION

Display the DBATOOLS utility version.

Format

DBATOOLS SHOW VERSION

Examples

#1 

$ DBATOOLS SHOW VERSION
  SysWorks Version V3.4

Creates a subprocess of the current process. The context of the subprocess is copied from the current process. You can use the SPAWN command to leave the DBATOOLS utility temporarily, perform other functions (such as displaying a directory listing or printing a file), and then return to DBATOOLS.

Note that this command is only available for users with DCL access.

Format

DBATOOLS SPAWN [command]

Parameters

command

Specifies the DCL command string that executes in the context of the created subprocess. When the command completes, the subprocess terminates and control is returned to the parent process. If this parameter is not specified, a subprocess is created that transfers control to DCL command level.

Qualifiers

/INPUT=file-spec

Specifies an input file containing one or more DCL command strings to be executed by the spawned subprocess. If you specify a command string along with an input file, the command string is processed before the commands in the input file. Once processing is complete, the subprocess is terminated.

/LOGICAL_NAMES

/NOLOGICAL_NAMES

Specifies that the logical names of the parent process are to be copied to the subprocess. When you do not want the subprocess to use the logical names of the parent process, enter the qualifier /NOLOGICAL_NAMES. The default is /LOGICAL_NAMES.

/OUTPUT=file-spec

Identifies the output file to which the results of the SPAWN operation are written. Whenever you use the /NOWAIT qualifier, you should also use the /OUTPUT qualifier to specify a new output destination. Doing so prevents output from being displayed while you are specifying new commands. If you omit the /OUTPUT qualifier, output is written by default to the current SYS$OUTPUT device.

/PROCESS=subprocess-name

Specifies the name of the subprocess to be created. The default name of the subprocess is USERNAME_n. If the subprocess name contains spaces or special characters, or is case-sensitive, then the subprocess name must be enclosed in quotation marks.

/SYMBOLS

/NOSYMBOLS

Determines whether the system passes DCL global and local symbols to the subprocess. The default is /SYMBOLS.

/WAIT/NOWAIT

Controls whether the system waits until the subprocess is completed before allowing more commands to be specified. The /NOWAIT qualifier allows you to specify new commands while the specified subprocess is running. If you specify /NOWAIT, you should also use the /OUTPUT qualifier to direct the output stream to a file, rather than displaying it on your terminal. Doing so prevents your terminal from being used by more than one process simultaneously.

Examples

#1 

DBATOOLS> SPAWN SHOW TIME

This example shows how to create a subprocess that executes the DCL command SHOW TIME while you are using DBATOOLS utility.

#2 

DBATOOLS> SPAWN /NOLOGICAL_NAMES SET HOST
_Node: MARS 
   .
   .
   .
$ LOGOUT
CRAMMER logged out at ... 
 
%REM-S-END, control returned to node _BETA:: 
 
DBATOOLS>

This example shows how to use the SPAWN command to create a subprocess in which you SET HOST to another node. When you want to leave node MARS and move back to node BETA, enter the DCL command LOGOUT. The /NOLOGICAL_NAMES qualifier prevents the logical names of the parent process from being copied to the subprocess.

DEFAPP

Define a checked logical name.

Format

DEFAPP logical-name required-flag equivalence-name

Parameters

logical-name

Specifies the logical name string. The logical name string can contain from 1 to 255 characters.

By default, the logical name is placed in the application logical name table. The string may contain any characters that constitute a valid logical name.

required-flag

Indicates whether to check for existance of the device, directory or file specified by the equivalence-name, and what behaviour to take if its is not found.

If the equivalence-name is a device or directory, its existance is always checked. A NO indicates that if the device or directory does not exist, the logical name should not be defined. A YES indicates that if it does not exist, an error should be reported and no logical name defined.

If the equivalence-name is a file, its existance is always checked. A NO indicates that if the file does not exist, the logical name will be defined to be the file in the found directory. A YES indicates that if the file does not exist, an error should be reported and no logical name defined.

If the equivalence is a quoted string or there is more than one equivalence, no checking is performed, and the required-flag is ignored.

equivalence-name[,...]

Defines the equivalence names to be associated with the logical name. An equivalence name string can contain from 1 to 255 characters. If the string is not intended as a valid OpenVMS file (or node, device or directory) specification, use the DEFLIT command.

You must include the punctuation marks (colons, brackets, periods) that would be required if the equivalence name were used directly as a file specification. Therefore, if you specify a device name as an equivalence name, you must terminate the equivalence name with a colon.

The DEFAPP command allows you to assign the same logical name to more than one equivalence name. For example, you can use the same logical name to access different directories on different disks, or to access different files in different directories. When you specify more than one equivalence name for a logical name, you create a search list. See the OpenVMS DCL Concepts Manual for more information on search lists.

Note that the DEFAPP command does not check for the existance of the specified file, directory or device if more than one equivalence is defined.

Examples

#1 

$ DEFAPP FIN_WRK_DIR NO DISK_'CUR_ENV':[FIN.WRK]

DEFLIT

Define a literal logical name.

Format

DEFLIT logical-name required-flag equivalence-name

Parameters

logical-name

Specifies the logical name string. The logical name string can contain from 1 to 255 characters.

By default, the logical name is placed in the application logical name table. The string may contain any characters that constitute a valid logical name.

required-flag

Indicates whether to check for existance of the device, directory or file specified by the equivalence-name, and what behaviour to take if its is not found. This flag is ignored by the DEFLIT command.

equivalence-name[,...]

Defines the equivalence names to be associated with the logical name. An equivalence name string can contain from 1 to 255 characters. If the string contains any characters other than alphanumerics, the dollar sign, or the underscore character, enclose the string in quotation marks (i.e. "equivalence-name"). If the equivalence name contains quotation marks, enclose the string in quotation marks and use double quotation marks ("") in the places where you want a quotation mark (") to occur.

The DEFLIT command allows you to assign the same logical name to more than one equivalence name. When you specify more than one equivalence name for a logical name, you create a search list. See the OpenVMS DCL Concepts Manual for more information on search lists.

Examples

#1 

$ DEFLIT FIN_HEADING YES "Financial Systems"

DEFROT

Define a checked root logical name.

Format

DEFROT logical-name required-flag equivalence-name

Parameters

logical-name

Specifies the logical name string. The logical name string can contain from 1 to 255 characters. By default, the logical name is placed in the application logical name table. The string may contain any characters that constitute a valid logical name.

required-flag

Indicates whether to check for existance of the device, directory specified by the equivalence-name, and what behaviour to take if its is not found.

If the equivalence-name is a device or directory, its existance is always checked. A NO indicates that if the device or directory does not exist, the logical name should not be defined. A YES indicates that if it does not exist, an error should be reported and no logical name defined.

equivalence-name

Defines the equivalence name to be associated with the logical name. Only valid device and/or directory paths should be specified. The resultant equivalence after parsing will be given the concealed and terminal translation attributes to make it a rooted logical name.

Examples

#1 

$ DEFROT FIN_SRC_ROOT YES DISK_APPL:[FIN.SRC]

DETAB

Converts tabs in the source file into the appropriate number of spaces in the destination file.

Format

DETAB source-file-spec[,...] dest-file-spec

Parameters

source-file-spec

The file specification of the source file from which to remove tabs.

dest-file-spec

The optional file specification of the destination file to produce. By default, the a new version of the source file is generated.

See Also

Examples

#1 

$ DETAB EXAMPLE.SRC EXAMPLE.TXT

This command generates a file EXAMPLE.TXT which is the same as EXAMPLE.SRC except that the tabs are converted into spaces.

Previous Next Contents Index