16.10 - Filer Command Syntax - Teradata Database

Teradata Database Support Utilities

prodname
Teradata Database
vrm_release
16.10
created_date
June 2017
category
Configuration
featnum
B035-1180-161K

Filer presents a command-line environment that allows the entry of Filer commands. This section describes the general conventions involved in entering Filer commands.

Entering Filer Commands

The following is the general form for a command entry:


Syntax Element Description
cmd The Filer command.
cmdoption The options that are specific to the command that you type.

Different options pertain to specific commands. To determine the allowed options, see the specific command.

parameterlist The parameters included with specific commands.

Command Usage Rules

The following command usage rules apply to Filer commands:

  • A space is required between the following:
    • The cmdoption and the parameterlist
    • The cmd and the parameterlist if you do not specify cmdoption or if the cmdoption is at the end of the command
  • You can combine multiple Filer commands on a single command line, as shown below:


  • Filer is case insensitive, which means that you can enter any command, keyword, or option in uppercase, lowercase, or mixed-case letters.
  • If you end a command line with a backward slash (\), the command line continues on the next line.
  • If an error occurs during processing of a string of commands, processing stops because the latter commands usually depend on the correct processing of commands typed earlier, as shown below:
    ci /p 0001000600000024;delete /y

    In this case, if there is a problem accessing the CI, you might not want to execute the DELETE command.

  • If an error occurs while parsing the command line, you can type a single question mark (?) as the next command. Filer displays a list of alternatives expected by the parser at that point of the syntax error.

    If you type another single question mark (?) after Filer displays the alternatives, Filer returns the HELP text for the command in question.

    The following example shows help information about the RADIX command:
    Filer ==>radix in dex
    radix in de<-Syntax error->x
    
    Filer ==> ?
    Valid input at the point of error is:
    ;           end of command
    
    Filer ==> ?
    RADIX [ ( IN[PUT] | OUT[PUT] ) ] [ ( H[EX] | D[EC] )
    
    Filer ==> ?
    RADIX [ ( IN[PUT] | OUT[PUT] ) ] [ ( H[EX] | D[EC] ) ]
    
    Sets the Flags for how to treat Unqualified number. Either Hex (base 16) or Decimal (Base 10), respectively. See HELP NUMBER for a description of unqualified INPUT. The initial setting of these Flags
    are HEX.  If neither INPUT nor OUTPUT is specified,
    the command applies to both Flags.  If neither HEX nor DEC is specified, the current setting of the Flag is displayed.
    
    Filer ==> ?
    No more information available. Use HELP /L
  • Comments are allowed anywhere a blank is allowed. Enclose comments between braces ({}).
    If Filer does not find a closing brace (}) on the line, Filer interprets the rest of the line as a comment, as shown in the following example:
    Filer ==> db 0 2 1fa { this is the broken data block
  • If you use a single question mark (?) in place of a legal syntactic element, Filer informs you as to what you can type at that point in the command, as shown below:
    Filer ==> output ?
    Valid input at the ? is :
     ,           INTO        OVER        TO          ON          ;
    end of command

    In this example, Filer accepts any of the following:

    • A comma (,)
    • INTO
    • OVER
    • TO
    • ON
    • A semicolon (;)
      Other examples of using a single question mark (?) in place of a legal syntactic element are shown below:
      output ?
      output ?{comment}
      output ? {comment
      output {comment} ?
  • Unlike other commands, the PATCH command cannot be combined on the command line with other commands. For more information, see PATCH.

Filer Modes

When started, Filer displays the Filer command prompt in the Filer application window of Database Window:

Filer ==>

Filer enters different modes of operation, based on the last command entered. The modes are generally associated with the hierarchical level of the file system architecture at which Filer is currently operating. The Filer command prompt changes to reflect the current mode:

Filer ==>
mi /p

Command has been sent to Slave tasks.

Mon Apr 21, 2008  16:06:26
4 of 4 vprocs responded with no messages or errors.

MI  (Range) ==>

Filer commands are prompt-sensitive:

  • Global and upper-level commands are valid at any prompt.
  • Lower-level commands are valid only under certain prompts that are initiated by upper-level commands.

For more information on Filer command types, see Filer Command Types.

Filer retains data object parameters for the current level of operation until they are changed or until Filer changes to a different mode. For example, once a range of rows has been specified for Filer to act upon, subsequent commands will operate on those same rows, without requiring re-entry of the row range specification. For more information, see Stored Input Values.