CREATE command: Temporary group: Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
m (misc cleanup)
Line 6: Line 6:
<dd>Creates a <var class="product">Model&nbsp;204</var> temporary file group
<dd>Creates a <var class="product">Model&nbsp;204</var> temporary file group
</dl>
</dl>
==Syntax==
==Syntax==
<p class="syntax">CREATE [TEMP] GROUP <var class="term">groupname</var>
<p class="syntax">CREATE [TEMP] GROUP <var class="term">groupname</var>
Line 18: Line 19:
</p>
</p>
   
   
<b>Where:</b>
Where:
<table>  
<table>  
<tr>
<tr>
<th>groupname</th>
<th>groupname</th>
<td> is the name of the temporary file group that is being created (1 to 8 characters). The group name cannot be FILE or GROUP and cannot start with CCA, SYS, OUT, TAPE, dollar sign ($), or percent sign (%). It can contain any alphanumeric characters except those in the following table:
<td>The name of the temporary file group that is being created (1 to 8 characters). The group name cannot be <code>FILE</code> or <code>GROUP</code>, and it cannot start with <code>CCA</code>, <code>SYS</code>, <code>OUT</code>, <code>TAPE</code>, dollar sign (<tt>$</tt>), or percent sign (<tt>%</tt>).  
<p>
The group name can contain any alphanumeric characters except those in the following table: </p>
<table>
<table>
 
<tr class="head"> <th>Character name </th> <th>Keyboard symbol</th> </tr>
<tr> <th>Character name </th> <th>Keyboard symbol</th> </tr>
    
    
<tr> <th><var>Asterisk</var></th> <td>( * )</td> </tr>
<tr> <th><var>Asterisk</var></th> <td>( * )</td> </tr>
Line 45: Line 47:
<tr> <th><var>Slash </var></th> <td>( / )</td> </tr>
<tr> <th><var>Slash </var></th> <td>( / )</td> </tr>
   
   
<tr> <th><var>Space </var></th> <td></td> </tr>
<tr> <th><var>Space </var></th> <td></td> </tr>  
 
</table>
</table>
</td>
</td></tr>
</tr>
   
   
<tr>
<tr>
<th>filename</th>
<th>filename</th>
<td> is the name of a <var class="product">Model&nbsp;204</var> file.
<td>The name of a <var class="product">Model&nbsp;204</var> file.
<p>If you are specifying Parallel Query Option/204 remote files, <var class="term">filename</var> must include a remote location (AT <var class="term">location</var>) or be a defined file synonym. Also, you cannot specify multiple identifiers for the same file: that is, you cannot include two synonyms for the same file, and you cannot include a synonym and a remote file specification for the same file. </p>
<p>
If you are specifying [[PQO|Parallel Query Option/204]] remote files, <var class="term">filename</var> must include a remote location (AT <var class="term">location</var>) or be a defined file synonym. Also, you cannot specify multiple identifiers for the same file: that is, you cannot include two synonyms for the same file, and you cannot include a synonym and a remote file specification for the same file. </p>
</td>
</td>
</tr>
</tr>
Line 60: Line 61:
<tr>
<tr>
<th>location</th>
<th>location</th>
<td>for PQO files, <var class="term">location</var> is the symbolic name (as many as eight characters) that refers to the location of the node on which the remote file resides. An unquoted equal sign (=) specifies that the file is local.</td>
<td>For PQO files, <var class="term">location</var> is the symbolic name (as many as eight characters) that refers to the location of the node on which the remote file resides. An unquoted equal sign (<tt>=</tt>) specifies that the file is local.</td></tr>
</tr>
   
   
<tr>
<tr>
<th><var>OPTIONAL</var></th>
<th><var>OPTIONAL</var> or <var>MANDATORY</var></th>
<td> or <var>MANDATORY</var> indicates whether PQO scattered group operations can proceed in the absence of this group member. The default is MANDATORY. Valid abbreviations are OPT and MAND.
<td>Indicates whether PQO scattered group operations can proceed in the absence of this group member. The default is <var>MANDATORY</var>. Valid abbreviations are <var>OPT</var> and <var>MAND</var>.
<p>You cannot open a group if a mandatory member is unavailable. Also, you cannot specify OPTIONAL for local files.</p>
<p>
</td>
You cannot open a group if a mandatory member is unavailable. Also, you cannot specify <var>OPTIONAL</var> for local files.</p></td></tr>
</tr>
   
   
<tr>
<tr>
<th>parameter=value</th>
<th>parameter=value</th>
<td> specifies <var class="product">Model&nbsp;204</var> temporary group parameters. Multiple PARAMETER statements can follow, and each statement can contain as many parameters in any order as will fit on one input line. Valid temporary group parameters are described in the table below.</td>
<td>Specifies <var class="product">Model&nbsp;204</var> temporary group parameters. Multiple <var>PARAMETER</var> statements can follow, and each statement can contain as many parameters in any order as will fit on one input line. Valid temporary group parameters are described in [[#Temporary group parameters|Temporary group parameters]], below.</td></tr>
</tr>
</table>
</table>


Line 85: Line 82:
<b></b>*** M204.0828: TEMP GROUP CREATED: REGION
<b></b>*** M204.0828: TEMP GROUP CREATED: REGION
</p>
</p>
==Usage notes==
==Usage notes==
<p>The CREATE TEMP GROUP command creates a temporary file group from the <var class="product">Model&nbsp;204</var> files specified in the command. A temporary group is established by a user for use during the current login session. A temporary group can be referenced only by the user who creates it. </p>
<ul>
<p>The temporary group ceases to exist when the user logs out. If TEMP is omitted from the CREATE GROUP command, <var class="product">Model&nbsp;204</var> assumes that the user is creating a temporary group.</p>
<li>The <var>CREATE TEMP GROUP</var> command creates a temporary file group from the <var class="product">Model&nbsp;204</var> files specified in the command. A temporary group is established by a user for use during the current login session. </li>
<p>The preceding example shows how group parameters can be specified. The <var class="product">Model&nbsp;204</var> temporary group parameters that can be set in the CREATE command's parameter list are shown in the table below. </p>
 
<li>A temporary group can be referenced only by the user who creates it.  
The temporary group ceases to exist when the user logs out. </li>
 
<li>If you omit <code>TEMP</code> from the <var>CREATE GROUP</var> command, <var class="product">Model&nbsp;204</var> assumes you are creating a temporary group.</li>
</ul>
 
===Temporary group parameters===
The [[#Example|CREATE GROUP REGION example]] above shows how group parameters can be specified. The <var class="product">Model&nbsp;204</var> temporary group parameters that can be set in the <var>CREATE</var> command's parameter list are shown in the table below:
<table>
<table>
<caption>Parameters for CREATE TEMP GROUP</caption>
<caption>Parameters for CREATE TEMP GROUP</caption>
      
      
<tr> <th>Parameter</th> <th>Defines...</th> </tr>
<tr class="head"> <th>Parameter</th>  
<th>Defines...</th> </tr>
    
    
<tr> <th><var>UPDTFILE</var></th> <td>Group's update file.  </td> </tr>
<tr> <th><var>UPDTFILE</var></th>  
<td>Group's update file.  </td> </tr>
   
   
<tr> <th><var>PROCFILE</var></th> <td>Group's procedure file, or specifies that the group can contain multiple procedure files.  </td> </tr>
<tr> <th><var>PROCFILE</var></th>  
<td>Group's procedure file, or specifies that the group can contain multiple procedure files.  </td> </tr>
   
   
<tr> <th><var>BLDGFT</var></th> <td>Whether to build an internal field table for this group. Can be YES or NO; YES is the default. </td> </tr>
<tr> <th><var>BLDGFT</var></th>  
 
<td>Whether to build an internal field table for this group. Can be YES or NO; YES is the default. </td> </tr>
</table>
</table>
<ul>
<ul>
<li>
<li>The <var>[[UPDTFILE parameter|UPDTFILE]]</var> parameter defines the group's update file. When a SOUL <var>Store Record</var> statement is encountered and <var class="product">Model&nbsp;204</var> cannot determine a file context, the record is stored in the group update file. If <var>UPDTFILE</var> is not specified, no update file is assigned. The [[$Update]] function provides a convenient method for manipulating the update file. </li>
The UPDTFILE parameter defines the group's update file. When a User Language STORE RECORD statement is encountered and <var class="product">Model&nbsp;204</var> cannot determine a file context, the record is stored in the group update file. If UPDTFILE is not specified, no update file is assigned. The [[$Update]] function provides a convenient method for manipulating the update file. </li>


<li>The PROCFILE parameter defines the group's procedure file. All procedure-related commands and the INCLUDE statement operate on this file if no other file context is established. If this parameter is omitted, no procedure file is assigned. You can also use PROCFILE to specify multiple procedure files for a group. If a group contains multiple procedure files, then the INCLUDE statement searches the entire group for the procedure to be included. The search proceeds in order from the first file defined in the CREATE GROUP command to the last.
<li>The <var>[[PROCFILE parameter|PROCFILE]]</var> parameter defines the group's procedure file. All procedure-related commands and the <var>INCLUDE</var> statement operate on this file if no other file context is established. If this parameter is omitted, no procedure file is assigned.  
<p>To specify multiple procedure files, specify PROCFILE = *, which indicates that any of the files in a group can contain procedures. This specification is optional; use it only if more than one file in the group contains procedures that you want to include.</p>
<p>
For more information, see the SOUL/User Language topic [[Application Subsystem development]] and its subtopic on [[Application Subsystem development#Multiple procedure files|multiple procedure files]]. </li>
You can also use <var>PROCFILE</var> to specify multiple procedure files for a group. If a group contains multiple procedure files, then the <var>INCLUDE</var> statement searches the entire group for the procedure to be included. The search proceeds in order from the first file defined in the <var>CREATE GROUP</var> command to the last. </p>
<p>
To allow for multiple procedure files, specify <code>PROCFILE = *</code>, which indicates that any of the files in a group can contain procedures. This specification is optional; use it only if more than one file in the group contains procedures that you want to include.</p>
<p>
For more information, see [[Application Subsystem development#Multiple procedure files|multiple procedure files]]. </p></li>


<li>The BLDGFT parameter, if YES, directs <var class="product">Model&nbsp;204</var> to maintain certain information about the group in an internal field table. The option you should specify depends upon how long you expect to use the group. If the group is only to satisfy a few short requests, specify NO. The default is YES.</li>
<li>The <var>[[BLDGFT parameter|BLDGFT]]</var> parameter, if <code>YES</code> (the default), directs <var class="product">Model&nbsp;204</var> to maintain certain information about the group in an internal field table. The option to specify depends upon how long you expect to use the group. If the group is only to satisfy a few short requests, specify <code>NO</code>.</li>
</ul>
</ul>
[[Category: General user commands]]
[[Category: General user commands]]
[[Category:Commands]]
[[Category:Commands]]

Revision as of 21:39, 23 February 2017

Summary

Privileges
Any user
Function
Creates a Model 204 temporary file group

Syntax

CREATE [TEMP] GROUP groupname FROM {filename [AT location] [(OPTIONAL) | (MANDATORY)]} ,... [PARAMETER parameter[=value] [,parameter[=value]]... . . . END

Where:

groupname The name of the temporary file group that is being created (1 to 8 characters). The group name cannot be FILE or GROUP, and it cannot start with CCA, SYS, OUT, TAPE, dollar sign ($), or percent sign (%).

The group name can contain any alphanumeric characters except those in the following table:

Character name Keyboard symbol
Asterisk ( * )
Equal sign ( = )
Left parenthesis ( ( )
Minus sign ( - )
Plus sign ( + )
Right parenthesis ( ) )
Semicolon ( ; )
Single quote ( ' )
Slash ( / )
Space
filename The name of a Model 204 file.

If you are specifying Parallel Query Option/204 remote files, filename must include a remote location (AT location) or be a defined file synonym. Also, you cannot specify multiple identifiers for the same file: that is, you cannot include two synonyms for the same file, and you cannot include a synonym and a remote file specification for the same file.

location For PQO files, location is the symbolic name (as many as eight characters) that refers to the location of the node on which the remote file resides. An unquoted equal sign (=) specifies that the file is local.
OPTIONAL or MANDATORY Indicates whether PQO scattered group operations can proceed in the absence of this group member. The default is MANDATORY. Valid abbreviations are OPT and MAND.

You cannot open a group if a mandatory member is unavailable. Also, you cannot specify OPTIONAL for local files.

parameter=value Specifies Model 204 temporary group parameters. Multiple PARAMETER statements can follow, and each statement can contain as many parameters in any order as will fit on one input line. Valid temporary group parameters are described in Temporary group parameters, below.

Example

CREATE GROUP REGION FROM DELAWARE, - MARYLAND, VIRGINIA *** M204.0825: READING GROUP PARAMETERS PARAMETER PROCFILE = VIRGINIA END *** M204.0828: TEMP GROUP CREATED: REGION

Usage notes

  • The CREATE TEMP GROUP command creates a temporary file group from the Model 204 files specified in the command. A temporary group is established by a user for use during the current login session.
  • A temporary group can be referenced only by the user who creates it. The temporary group ceases to exist when the user logs out.
  • If you omit TEMP from the CREATE GROUP command, Model 204 assumes you are creating a temporary group.

Temporary group parameters

The CREATE GROUP REGION example above shows how group parameters can be specified. The Model 204 temporary group parameters that can be set in the CREATE command's parameter list are shown in the table below:

Parameters for CREATE TEMP GROUP
Parameter Defines...
UPDTFILE Group's update file.
PROCFILE Group's procedure file, or specifies that the group can contain multiple procedure files.
BLDGFT Whether to build an internal field table for this group. Can be YES or NO; YES is the default.
  • The UPDTFILE parameter defines the group's update file. When a SOUL Store Record statement is encountered and Model 204 cannot determine a file context, the record is stored in the group update file. If UPDTFILE is not specified, no update file is assigned. The $Update function provides a convenient method for manipulating the update file.
  • The PROCFILE parameter defines the group's procedure file. All procedure-related commands and the INCLUDE statement operate on this file if no other file context is established. If this parameter is omitted, no procedure file is assigned.

    You can also use PROCFILE to specify multiple procedure files for a group. If a group contains multiple procedure files, then the INCLUDE statement searches the entire group for the procedure to be included. The search proceeds in order from the first file defined in the CREATE GROUP command to the last.

    To allow for multiple procedure files, specify PROCFILE = *, which indicates that any of the files in a group can contain procedures. This specification is optional; use it only if more than one file in the group contains procedures that you want to include.

    For more information, see multiple procedure files.

  • The BLDGFT parameter, if YES (the default), directs Model 204 to maintain certain information about the group in an internal field table. The option to specify depends upon how long you expect to use the group. If the group is only to satisfy a few short requests, specify NO.