ANALYZE command - Revision history

DCameron: /* Sample result */

2019-02-04T16:35:05Z

Sample result

← Older revision		Revision as of 16:35, 4 February 2019
Line 97:		Line 97:
	<tr> <th><var>RECORDS</var></th> <td>Total records covered by each MRIB category/</td> </tr>		<tr> <th><var>RECORDS</var></th> <td>Total records covered by each MRIB category/</td> </tr>

	<tr> <th><var>PAGES</var></th> <td>Total Table D pages encountered in retrieving the respective MRIB category. Note: This count might be greater than the actual number of pages for the MRIB category.</td> </tr>		<tr> <th><var>PAGES</var></th> <td>Total [[Table_D_(File_architecture)\|Table D]] pages encountered in retrieving the respective MRIB category. Note: This count might be greater than the actual number of pages for the MRIB category.</td> </tr>

	</table>		</table>

DCameron: /* Usage */

2019-02-04T16:33:29Z

Usage

← Older revision		Revision as of 16:33, 4 February 2019
Line 22:		Line 22:
	==Usage==		==Usage==
	<p>For each Ordered Index field in the ANALYZE command, the analysis begins at the corresponding entry in the root node and then processes downward to the individual pages in the leaf nodes. Each page is analyzed in terms of its disk space usage. The usage information is then accumulated at the each node level.</p>		<p>For each Ordered Index field in the ANALYZE command, the analysis begins at the corresponding entry in the root node and then processes downward to the individual pages in the leaf nodes. Each page is analyzed in terms of its disk space usage. The usage information is then accumulated at the each node level.</p>
	<p>If the file to be analyzed has its FISTAT reset from Physically Broken, the following message and prompt are displayed: </p>		<p>If the file to be analyzed has its <var>[[FISTAT_parameter\|FISTAT]]</var> reset from Physically Broken, the following message and prompt are displayed: </p>
	<p class="code">FIWHO DVTEST TERMINAL ID THAT RESET FISTAT		<p class="code">FIWHO DVTEST TERMINAL ID THAT RESET FISTAT
	<b></b>*** M204.1076: DO YOU REALLY WANT TO CONTINUE?		<b></b>*** M204.1076: DO YOU REALLY WANT TO CONTINUE?

DCameron: /* Purpose */

2019-02-04T16:32:30Z

Purpose

← Older revision		Revision as of 16:32, 4 February 2019
Line 17:		Line 17:
	<p>In addition to providing information about inefficiencies, the ANALYZE command gives you insights on how <var class="product">Model 204</var> manages fields and values.</p>		<p>In addition to providing information about inefficiencies, the ANALYZE command gives you insights on how <var class="product">Model 204</var> manages fields and values.</p>
	<p>Because the analysis process is identical to that of the Ordered Index retrieval, this command can trigger a bug macro when a corrupted Ordered Index is encountered, thus providing a simplified and yet reproducible environment.</p>		<p>Because the analysis process is identical to that of the Ordered Index retrieval, this command can trigger a bug macro when a corrupted Ordered Index is encountered, thus providing a simplified and yet reproducible environment.</p>
	<p>This command examines the settings of Ordered Index spacing parameters, LRESERVE, NRESERVE, SPLITPCT, and IMMED, while creating or reorganizing a given <var class="product">Model 204</var> file in order to achieve the optimized results. </p>		<p>This command examines the settings of Ordered Index spacing parameters, <var>[[LRESERVE_parameter\|LRESERVE]]</var>, <var>[[NRESERVE_parameter\|NRESERVE]]</var>, <var>[[SPLITPCT_parameter\|SPLITPCT]]</var>, and <var>[[IMMED_parameter\|IMMED]]</var>, while creating or reorganizing a given <var class="product">Model 204</var> file in order to achieve the optimized results. </p>
	<p>The ANALYZE command can analyze any <var class="product">Model 204</var> file, going back to those of Version 8.1.</p>		<p>The ANALYZE command can analyze any <var class="product">Model 204</var> file, going back to those of Version 8.1.</p>

	==Usage==		==Usage==
	<p>For each Ordered Index field in the ANALYZE command, the analysis begins at the corresponding entry in the root node and then processes downward to the individual pages in the leaf nodes. Each page is analyzed in terms of its disk space usage. The usage information is then accumulated at the each node level.</p>		<p>For each Ordered Index field in the ANALYZE command, the analysis begins at the corresponding entry in the root node and then processes downward to the individual pages in the leaf nodes. Each page is analyzed in terms of its disk space usage. The usage information is then accumulated at the each node level.</p>

DCameron: /* Syntax */

2019-02-04T16:29:58Z

Syntax

← Older revision		Revision as of 16:29, 4 February 2019
Line 11:		Line 11:

	<b>Where:</b>		<b>Where:</b>
	<var class="term">fieldname</var> is a valid field with the ORDERED attribute. If an asterisk (<code>*</code>) is provided in the place of a field name, all entries in the root node of the ordered index are analyzed. The information is collected based on field codes instead of field names.		<var class="term">fieldname</var> is a valid field with the [[Field_design#ORDERED_field_definition\|ORDERED]] attribute. If an asterisk (<code>*</code>) is provided in the place of a field name, all entries in the root node of the ordered index are analyzed. The information is collected based on field codes instead of field names.

	==Purpose==		==Purpose==

ELowell: removed italics from table headings

2017-03-31T15:46:52Z

removed italics from table headings

← Older revision		Revision as of 15:46, 31 March 2017
Line 64:		Line 64:
	<caption>Notes on the results of an ANALYZE command</caption>		<caption>Notes on the results of an ANALYZE command</caption>

	<tr> <th>Result column</th> <th>Explanation</th> </tr>		<tr class="head"> <th>Result column</th> <th>Explanation</th> </tr>

	<tr> <th><var>ROOT NODE VERSION NUMBER</var></th> <td>A version number recorded in the Root node.</td> </tr>		<tr> <th><var>ROOT NODE VERSION NUMBER</var></th> <td>A version number recorded in the Root node.</td> </tr>
Line 130:		Line 130:
	<caption>Nonfatal error return codes</caption>		<caption>Nonfatal error return codes</caption>

	<tr> <th>Code</th> <th>Explanation</th> </tr>		<tr class="head"> <th>Code</th> <th>Explanation</th> </tr>

	<tr> <th align="right"><var>X'1'</var></th> <td>Attempt to find an equal key failed, no position exists.</td> </tr>		<tr> <th align="right"><var>X'1'</var></th> <td>Attempt to find an equal key failed, no position exists.</td> </tr>

Dme: /* Syntax */

2014-08-31T15:05:12Z

Syntax

← Older revision		Revision as of 15:05, 31 August 2014
Line 7:		Line 7:
	</dl>		</dl>
	==Syntax==		==Syntax==
	<p class="syntax">ANALYZE <var class="term">fieldname</var>		<p class="syntax">ANALYZE <span class="squareb">{</span><var class="term">fieldname</var> <span class="squareb">\|</span> * <span class="squareb">}</span>
	</p>		</p>

	<b>Where:</b>		<b>Where:</b>
	<var class="term">fieldname</var> is a valid field with the ORDERED attribute. If an asterisk (*) is provided in the place of a field name, all entries in the root node of the ~~file~~ are analyzed. The information is collected based on field codes instead of field names.		<var class="term">fieldname</var> is a valid field with the ORDERED attribute. If an asterisk (<code>*</code>) is provided in the place of a field name, all entries in the root node of the ordered index are analyzed. The information is collected based on field codes instead of field names.

	==Purpose==		==Purpose==

ELowell: /* Sample result */

2013-07-16T17:41:26Z

Sample result

← Older revision		Revision as of 17:41, 16 July 2013
Line 62:		Line 62:
	<p>The table below lists the column headings from the previous example's output with an explanation of what the information represents. </p>		<p>The table below lists the column headings from the previous example's output with an explanation of what the information represents. </p>
	<table>		<table>
	<caption>Notes on the results of an ANALYZE command ~~(Continued)~~</caption>		<caption>Notes on the results of an ANALYZE command</caption>

	<tr> <th>Result column</th> <th>Explanation</th> </tr>		<tr> <th>Result column</th> <th>Explanation</th> </tr>
Line 99:		Line 99:

	</table>		</table>

	==Fatal errors==		==Fatal errors==
	During the execution of the ANALYZE command, some errors might occur, triggering a bug macro. However, the ANALYZE detects most errors before calling existing routines. In such cases, the following type of error message is displayed:		During the execution of the ANALYZE command, some errors might occur, triggering a bug macro. However, the ANALYZE detects most errors before calling existing routines. In such cases, the following type of error message is displayed:

ELowell: /* Usage */

2013-07-16T16:02:24Z

Usage

← Older revision		Revision as of 16:02, 16 July 2013
Line 21:		Line 21:
	==Usage==		==Usage==
	<p>For each Ordered Index field in the ANALYZE command, the analysis begins at the corresponding entry in the root node and then processes downward to the individual pages in the leaf nodes. Each page is analyzed in terms of its disk space usage. The usage information is then accumulated at the each node level.</p>		<p>For each Ordered Index field in the ANALYZE command, the analysis begins at the corresponding entry in the root node and then processes downward to the individual pages in the leaf nodes. Each page is analyzed in terms of its disk space usage. The usage information is then accumulated at the each node level.</p>
	<p>If the file to be analyzed has its FISTAT reset from Physically Broken, the following message and ~~DYRWT~~ are displayed: </p>		<p>If the file to be analyzed has its FISTAT reset from Physically Broken, the following message and prompt are displayed: </p>
	<p class="code">FIWHO DVTEST TERMINAL ID THAT RESET FISTAT		<p class="code">FIWHO DVTEST TERMINAL ID THAT RESET FISTAT
	<b></b>*** M204.1076: DO YOU REALLY WANT TO CONTINUE?		<b></b>*** M204.1076: DO YOU REALLY WANT TO CONTINUE?
Line 32:		Line 32:
	<b></b>*** M204.0003: ANALYZE DONE		<b></b>*** M204.0003: ANALYZE DONE
	</p>		</p>

	==Example==		==Example==
	<p>In the following example the ANALYZE command is diagnosing the CLIENT CODE field in the CLIENT file. The example continues with the screen display of the results, followed by a table explaining the output for each column.</p>		<p>In the following example the ANALYZE command is diagnosing the CLIENT CODE field in the CLIENT file. The example continues with the screen display of the results, followed by a table explaining the output for each column.</p>

ELowell: /* Syntax */

2013-07-16T15:58:34Z

Syntax

← Older revision		Revision as of 15:58, 16 July 2013
Line 7:		Line 7:
	</dl>		</dl>
	==Syntax==		==Syntax==
	<p class="syntax">ANALYZE fieldname		<p class="syntax">ANALYZE <var class="term">fieldname</var>
	</p>		</p>

	<b>Where:</b>		<b>Where:</b>
	<var>~~Fieldname~~</var> is a valid field with the ORDERED attribute. If an asterisk (*) is provided in the place of a ~~fieldname~~, all entries in the root node of the file are analyzed. The information is collected based on field codes instead of field names.		<var class="term">fieldname</var> is a valid field with the ORDERED attribute. If an asterisk (*) is provided in the place of a field name, all entries in the root node of the file are analyzed. The information is collected based on field codes instead of field names.

	==Purpose==		==Purpose==
	<p>The ANALYZE command provides sufficient information about Ordered Index fields so that you can assess an Ordered Index, a prerequisite in debugging an Ordered Index and related problems. A file manager can use the ANALYZE command to diagnose those fields that are experiencing Ordered Index related problems and verify the possibility of an Ordered Index inefficiency. </p>		<p>The ANALYZE command provides sufficient information about Ordered Index fields so that you can assess an Ordered Index, a prerequisite in debugging an Ordered Index and related problems. A file manager can use the ANALYZE command to diagnose those fields that are experiencing Ordered Index related problems and verify the possibility of an Ordered Index inefficiency. </p>

Alex: Automatically generated page update

2013-02-28T01:04:28Z

Automatically generated page update

New page

==Summary==
<dl>
<dt>Privileges
<dd>File manager
<dt>Function
<dd>Analyze an Ordered Index, validate and output index and page information
</dl>
==Syntax==
ANALYZE fieldname


Where:
<var>Fieldname</var> is a valid field with the ORDERED attribute. If an asterisk (*) is provided in the place of a fieldname, all entries in the root node of the file are analyzed. The information is collected based on field codes instead of field names.
==Purpose==
The ANALYZE command provides sufficient information about Ordered Index fields so that you can assess an Ordered Index, a prerequisite in debugging an Ordered Index and related problems. A file manager can use the ANALYZE command to diagnose those fields that are experiencing Ordered Index related problems and verify the possibility of an Ordered Index inefficiency. 
In addition to providing information about inefficiencies, the ANALYZE command gives you insights on how <var class="product">Model 204</var> manages fields and values.
Because the analysis process is identical to that of the Ordered Index retrieval, this command can trigger a bug macro when a corrupted Ordered Index is encountered, thus providing a simplified and yet reproducible environment.
This command examines the settings of Ordered Index spacing parameters, LRESERVE, NRESERVE, SPLITPCT, and IMMED, while creating or reorganizing a given <var class="product">Model 204</var> file in order to achieve the optimized results. 
The ANALYZE command can analyze any <var class="product">Model 204</var> file, going back to those of Version 8.1.
==Usage==
For each Ordered Index field in the ANALYZE command, the analysis begins at the corresponding entry in the root node and then processes downward to the individual pages in the leaf nodes. Each page is analyzed in terms of its disk space usage. The usage information is then accumulated at the each node level.
If the file to be analyzed has its FISTAT reset from Physically Broken, the following message and DYRWT are displayed: 
FIWHO DVTEST TERMINAL ID THAT RESET FISTAT
*** M204.1076: DO YOU REALLY WANT TO CONTINUE?

Note:
 If someone resets the FISTAT parameter from Physically Broken, the Ordered Index might be broken and the ANALYZE command might not work.
 Enter Y to proceed.
 However, if the field name is not an Ordered Index, the following message is displayed: 
*** 1 M204.1265: NO SUCH FIELD NAME. FIELD = FOO
*** M204.0003: ANALYZE DONE

==Example==
In the following example the ANALYZE command is diagnosing the CLIENT CODE field in the CLIENT file. The example continues with the screen display of the results, followed by a table explaining the output for each column.
Commands entered
OPEN CLIENT
ANALYZE CLIENT CODE

====Sample result====
ANALYZE CLIENT CODE
FIWHO TERMINAL ID THAT RESET FISTAT
*** M204.1076: DO YOU REALLY WANT TO CONTINUE
Y
ROOT NODE VERSION NUMBER = 434975
*** M204.0005: ANALYZE FIELDNAME = CLIENT CODE
AVG.NO. OFFSET COMPRES KEY PAGE AVG.
PAGES ENTRIES AREA KEYSIZE AREA USAGE% UNUSED
ROOT 1 7 34 61 1 6049
I-NODE 1 276 572 3080 59 2492
LEAF 4 173 366 2 4244 75 1532

MRIB: IMMEDIATE LIST BITMAP TOTAL
ENTRIES 402 1859 4 2265
RECORDS 574 48664 16432 65670
PAGES 1603 4 1607
SRIB: 96

*** M204.0003: ANALYZE DONE

The table below lists the column headings from the previous example's output with an explanation of what the information represents. 
<table>
<caption>Notes on the results of an ANALYZE command (Continued)</caption>

<tr> <th>Result column</th> <th>Explanation</th> </tr>

<tr> <th><var>ROOT NODE VERSION NUMBER</var></th> <td>A version number recorded in the Root node.</td> </tr>

<tr> <th><var>ROOT</var></th> <td>The entire page information, same for all ordered fields.</td> </tr>

<tr> <th><var>LEAF</var></th> <td>The average page information of the selected ordered field.</td> </tr>

<tr> <th><var>PAGES</var></th> <td>Number of pages in the node.</td> </tr>

<tr> <th><var>AVG. ENTRY</var></th> <td>Average (Index) entries per page.</td> </tr>

<tr> <th><var>OFFSET AREA</var></th> <td>Average number of bytes per page for the offsets.</td> </tr>

<tr> <th><var>COMP. SIZE</var></th> <td>Average number of bytes for the compression key.</td> </tr>

<tr> <th><var>KEY AREA</var></th> <td>Average number of bytes for the (Index) key.</td> </tr>

<tr> <th><var>PAGE USAGE%</var></th> <td>(Offset area + Key area + Compress size) / (Page size - Header - Trailer).</td> </tr>

<tr> <th><var>Record Information</var></th> <td>Contained in the entries in the leaf node.</td> </tr>

<tr> <th><var>SRIB #</var></th> <td>Single Record Information Block number.</td> </tr>

<tr> <th><var>MRIB # </var></th> <td>The categories of MRIB are: IMMEDIATE LIST BITMAP</td> </tr>

<tr> <th><var>TOTAL </var></th> <td>Sum of all MRIB categories.</td> </tr>

<tr> <th><var>ENTRIES</var></th> <td>Total entry count in the category/</td> </tr>

<tr> <th><var>RECORDS</var></th> <td>Total records covered by each MRIB category/</td> </tr>

<tr> <th><var>PAGES</var></th> <td>Total Table D pages encountered in retrieving the respective MRIB category. Note: This count might be greater than the actual number of pages for the MRIB category.</td> </tr>

</table>
==Fatal errors==
During the execution of the ANALYZE command, some errors might occur, triggering a bug macro. However, the ANALYZE detects most errors before calling existing routines. In such cases, the following type of error message is displayed:
*** M204.0005: ANALYZE FIELDNAME = FOO
SEGMENT POINTER EXCEEDS NEXT CLUSTER POINTER ON PAGE X'04000002'
*** M204.0623: FILE DATA MAY BE LOGICALLY INCONSISTENT
*** M204.1076: DO YOU REALLY WANT TO CONTINUE?

Enter Y to continue the diagnosis.
Other messages are: 
SEGMENT POINTER EXCEEDS NEXT CLUSTER POINTER ON PAGE X'04000002'
CLUSTER POINTER EXCEEDS RANGE OF MRIB POINTER ON PAGE X'04000002'
SEGMENT POINTER IS NOT IN THE RANGE OF MRIB POINTER ON PAGE X'04000002'
INVALID BIBSIT VALUE ON PAGE X'04000002'
POINTER TO IMMEDIATE IS NOT AN EVEN OFFSET ON PAGE X'04000002'
TABLE D LIST POINTER IS NOT AN EVEN OFFSET ON PAGE X'04000002'

Rocket Software strongly recommends that you record the page number shown in the message and report this problem by sending the file to Rocket Software Technical Support for further analysis, whenever possible. 
==Nonfatal errors==
Nonfatal errors are shown in the following format:
RETURN CODE FROM %C WAS %C'

The FROM clause can be one of the following names:
BXFIND
BXNEXT
BXNEXT2

The table below lists each return code with an explanation of its meaning. 
<table>
<caption>Nonfatal error return codes</caption>

<tr> <th>Code</th> <th>Explanation</th> </tr>

<tr> <th align="right"><var>X'1'</var></th> <td>Attempt to find an equal key failed, no position exists.</td> </tr>

<tr> <th align="right"><var>X'2'</var></th> <td>Attempt to refind a position failed, no position exists.</td> </tr>

<tr> <th align="right"><var>X'4'</var></th> <td>Result of BX call is OFFEND position, either OFFENDL or OFFENDR - find which by checking CIA flags BXCFOFLE and BXCFOFRI </td> </tr>

<tr> <th align="right"><var>X'8'</var></th> <td>Result of BX calls OFFEND of tree, for example, OFFENDR or OFFENDL, no next or previous node. </td> </tr>

<tr> <th align="right"><var>X'10'</var></th> <td>Empty tree - Position is OFFENDL</td> </tr>

<tr> <th align="right"><var>X'20'</var></th> <td>Insert would illegally duplicate key</td> </tr>

<tr> <th align="right"><var>X'40'</var></th> <td>BXINSE or BXCHNG would result in entry, which is illegally large</td> </tr>

<tr> <th align="right"><var>X'100'</var></th> <td>Next entry in given direction does not satisfy given RELCODE</td> </tr>

<tr> <th align="right"><var>X'200'</var></th> <td>Position has ceased to exist, as when a call to BXDELE frees the current node and there is no right sibling</td> </tr>

</table>
[[Category: File manager commands]]
[[Category:Commands]]