$ChkpInf: Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
m (add italics)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<b>Function</b>
<b>
<p>Returns information about checkpoints. It takes one argument, which specifies what information to return.</p>
Function</b>
<b>Syntax</b>
<p>
<p class="code">$CHKPINF(request-code)
Returns information about checkpoints. It takes one argument, which specifies what information to return.</p>
</p>
<b>
<p>Where:</p>
Syntax</b>
<p class="syntax">$ChkpInf(<span class="term">request-code</span>) </p>
<p>
Where:</p>
<table>
<table>
<tr class="head">
<tr class="head">
<th>request-
<th>request-code </th>
code </th>
<th>Asking to return...</th>
<th>
<th>$CHKPINF returns...</th>
Asking to return...</th>
<th>Meaning that checkpointing is...</th>
<th>
$CHKPINF returns...</th>
<th>Meaning that  
checkpointing is...</th>
</tr>
</tr>
<tr>
<tr>
<td align="right">0 </td>
<td rowspan="4">0 </td>
<td rowspan="4">Checkpoint status</td>
<td rowspan="4">Checkpoint status</td>
<td align="right">0</td>
<td>0</td>
<td>Not active</td>
<td>Not active</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>1 </td>
<td align="right">1 </td>
<td>Currently being taken (by <var>[[CPTIME parameter|CPTIME]]</var> or by <var>[[CHECKPOINT command|CHECKPOINT]]</var> command) </td>
<td>Currently being taken (by <var>[[CPTIME_parameter|CPTIME]]</var> or by <var>[[CHECKPOINR_command|CHECKPOINT]]</var> command) </td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>2 </td>
<td align="right">2 </td>
<td>Active, but no auto checkpoints; <code>CPTIME=0</code></td>
<td>Active, but no auto checkpoints; CPTIME=0</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>3 </td>
<td align="right">3 </td>
<td>Active, and <var>CPTIME</var> does not equal 0</td>
<td>Active and CPTIME does not equal 0</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">1 </td>
<td rowspan="4">1</td>
<td rowspan="3">Date-time for/var> the next checkpoint attempt, scheduled by the CPTIME argument</td>
<td rowspan="4">Date-time for the next checkpoint attempt, scheduled by the <var>CPTIME</var> argument</td>
<td>9999/99/99 99:99:99.99 </td>
<td>9999/99/99 99:99:99.99 </td>
<td>Not active</td>
<td>Not active</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>9999/99/99 99:99:99.99 </td>
<td>9999/99/99 99:99:99.99 </td>
<td>CPTIME=0</td>
<td>CPTIME=0</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>Current date-time </td>
<td>Current date-time </td>
<td>In progress </td>
<td>In progress </td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>yyyy/mm/dd hh:mm:ss.hh</td>
<td>yyyy/mm/dd hh:mm:ss.hh</td>
<td>Scheduled date/time</td>
<td>Scheduled date/time</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">2</td>
<td rowspan="4">2</td>
<td rowspan="3">Seconds till the next checkpoint attempt, scheduled by the CPTIME parameter</td>
<td rowspan="4">Seconds till the next checkpoint attempt, scheduled by the <var>CPTIME</var> parameter</td>
<td align="right">999999999</td>
<td align="right">999999999</td>
<td>Not active</td>
<td>Not active</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>999999999 </td>
<td align="right">999999999 </td>
<td>CPTIME=0</td>
<td>CPTIME=0</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>0</td>
<td align="right">0</td>
<td>In progress</td>
<td>In progress</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>sss:hh</td>
<td>sss:hh</td>
<td>Scheduled in this many seconds</td>
<td>Scheduled in this many seconds</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">3</td>
<td rowspan="2">3</td>
<td rowspan="2">Time of last successful checkpoint </td>
<td rowspan="2">Time of last successful checkpoint </td>
<td>Date-time of last checkpoint as yyyy/mm/dd hh:mm:ss.hh</td>
<td>Date-time of last checkpoint as yyyy/mm/dd hh:mm:ss.hh</td>
<td>Due to CPTIME parameter or CHECKPOINT command</td>
<td>Due to <var>CPTIME</var> parameter or <var>CHECKPOINT</var> command</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>9999/99/99 99:99:99.99</td>
<td>9999/99/99 99:99:99.99</td>
<td>Not active</td>
<td>Not active</td>
</tr>
</tr>
<tr>
<tr>
<td rowspan="2" align="right">4</td>
<td rowspan="2">4</td>
<td rowspan="2">Seconds since the last successful checkpoint </td>
<td rowspan="2">Seconds since the last successful checkpoint </td>
<td>Time in seconds of checkpoint as sss:hh</td>
<td>Time in seconds of checkpoint as sss:hh</td>
<td>Due to CPTIME parameter or the CHECKPOINT command</td>
<td>Due to <var>CPTIME</var> parameter or the <var>CHECKPOINT</var> command</td>
</tr>
</tr>
<tr>
<tr>
Line 102: Line 94:
<td>Not active</td>
<td>Not active</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">5</td>
<td>5</td>
<td>Total number of records currently in CHKPOINT stream, which includes checkpoints and preimages</td>
<td>Total&nbsp;number&nbsp;of&nbsp;records currently in CHKPOINT stream, which includes checkpoints and preimages</td>
<td>Number of records</td>
<td>Number of records</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">6</td>
<td>6</td>
<td>Number of checkpoints currently in CHKPOINT stream</td>
<td>Number of checkpoints currently in CHKPOINT stream</td>
<td>Number of checkpoints</td>
<td>Number of checkpoints</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">7</td>
<td rowspan="5">7</td>
<td>[[System_and_media_recovery#Understanding_an_extended_quiesce|Extended quiesce]] status</td>
<td rowspan="5">[[System and media recovery#Understanding an extended quiesce|Extended quiesce]] status</td>
<td align="right">0</td>
<td>0</td>
<td>Extended quiesce inactive for this run</td>
<td>Extended quiesce inactive for this run</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>1</td>
<td>&nbsp;</td>
<td align="right">1</td>
<td>Extended quiesce unset: will not be entered</td>
<td>Extended quiesce unset: will not be entered</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>2</td>
<td>&nbsp;</td>
<td align="right">2</td>
<td>Extended quiesce set; at end of next successful checkpoint extended quiesce state will be reentered</td>
<td>Extended quiesce set; at end of next successful checkpoint extended quiesce state will be reentered</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>3</td>
<td>&nbsp;</td>
<td align="right">3</td>
<td>Currently in extended quiesce</td>
<td>Currently in extended quiesce</td>
</tr>
</tr>
<tr>
<tr>
<td>&nbsp;</td>
<td>4</td>
<td>&nbsp;</td>
<td>Extended quiesce facility non-functional: in <var>[[EOJ command|EOJ]]</var></td>
<td align="right">4</td>
<td>Extended quiesce facility non-functional: in <var>[[EOJ_command|EOJ]]</var></td>
</tr>
</tr>
<tr>
<tr>
<td align="right">8</td>
<td>8</td>
<td>Maximum number of checkpoint records written during an Online run. </td>
<td>Maximum number of checkpoint records written during an Online run. </td>
<td>Number of checkpoint records</td>
<td>Number of checkpoint records</td>
<td>Providing sizing information for the checkpoint data set.</td>
<td>Providing sizing information for the [[Configuring_checkpoint_and_journal_data_streams|checkpoint data set]].</td>
</tr>
</tr>
</table>
</table>
<b>Example</b>
<b>
<p>The following procedure illustrates using the $CHKPINF function.</p>
Example</b>
<p>
The following procedure illustrates using the <var>$ChkpInf</var> function.
</p>
<p class="code"> * * * TOP OF PROCEDURE * * *
<p class="code"> * * * TOP OF PROCEDURE * * *
BEGIN
BEGIN
Line 168: Line 159:
</p>
</p>
<p><var class="product">Model&nbsp;204</var> displays the following output:</p>
<p><var class="product">Model&nbsp;204</var> displays the following output:</p>
<p class="code">3                      CURRENT CHECKPOINTING STATUS
<p class="output">3                      CURRENT CHECKPOINTING STATUS
2001/11/19 12:40:00.75  NEXT SCHEDULED CHECKPOINT
2001/11/19 12:40:00.75  NEXT SCHEDULED CHECKPOINT
249.68                  SECONDS UNTIL NEXT SCHEDULED CHECKPOINT
249.68                  SECONDS UNTIL NEXT SCHEDULED CHECKPOINT
Line 178: Line 169:
22                      MAXIMUM CHECKPOINT RECORDS THAT WERE WRITTEN
22                      MAXIMUM CHECKPOINT RECORDS THAT WERE WRITTEN
</p>
</p>
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Latest revision as of 19:50, 24 April 2018

Function

Returns information about checkpoints. It takes one argument, which specifies what information to return.

Syntax

$ChkpInf(request-code)

Where:

request-code Asking to return... $CHKPINF returns... Meaning that checkpointing is...
0 Checkpoint status 0 Not active
1 Currently being taken (by CPTIME or by CHECKPOINT command)
2 Active, but no auto checkpoints; CPTIME=0
3 Active, and CPTIME does not equal 0
1 Date-time for the next checkpoint attempt, scheduled by the CPTIME argument 9999/99/99 99:99:99.99 Not active
9999/99/99 99:99:99.99 CPTIME=0
Current date-time In progress
yyyy/mm/dd hh:mm:ss.hh Scheduled date/time
2 Seconds till the next checkpoint attempt, scheduled by the CPTIME parameter 999999999 Not active
999999999 CPTIME=0
0 In progress
sss:hh Scheduled in this many seconds
3 Time of last successful checkpoint Date-time of last checkpoint as yyyy/mm/dd hh:mm:ss.hh Due to CPTIME parameter or CHECKPOINT command
9999/99/99 99:99:99.99 Not active
4 Seconds since the last successful checkpoint Time in seconds of checkpoint as sss:hh Due to CPTIME parameter or the CHECKPOINT command
999999999 Not active
5 Total number of records currently in CHKPOINT stream, which includes checkpoints and preimages Number of records  
6 Number of checkpoints currently in CHKPOINT stream Number of checkpoints  
7 Extended quiesce status 0 Extended quiesce inactive for this run
1 Extended quiesce unset: will not be entered
2 Extended quiesce set; at end of next successful checkpoint extended quiesce state will be reentered
3 Currently in extended quiesce
4 Extended quiesce facility non-functional: in EOJ
8 Maximum number of checkpoint records written during an Online run. Number of checkpoint records Providing sizing information for the checkpoint data set.

Example

The following procedure illustrates using the $ChkpInf function.

* * * TOP OF PROCEDURE * * * BEGIN PRINT $CHKPINF(0) WITH ' CURRENT CHECKPOINTING STATUS' AT 25 PRINT $CHKPINF(1) WITH ' NEXT SCHEDULED CHECKPOINT' AT 25 PRINT $CHKPINF(2) WITH ' SECONDS UNTIL NEXT SCHEDULED CHECKPOINT' AT 25 PRINT $CHKPINF(3) WITH ' LAST SUCCESSFUL CHECKPOINT TAKEN' AT 25 PRINT $CHKPINF(4) WITH ' SECONDS SINCE LAST SUCCESSFUL CHECKPOINT' AT 25 PRINT $CHKPINF(5) WITH ' # RECORDS CURRENTLY IN CHKPOINT STREAM' AT 25 PRINT $CHKPINF(6) WITH ' # CHECKPOINTS IN CHKPOINT STREAM' AT 25 PRINT $CHKPINF(7) WITH ' EXTENDED QUIESCE STATUS' AT 25 PRINT $CHKPINF(8) WITH ' MAXIMUM CHECKPOINT RECORDS THAT WERE WRITTEN' AT 25 END * * * BOTTOM OF PROCEDURE * * *

Model 204 displays the following output:

3 CURRENT CHECKPOINTING STATUS 2001/11/19 12:40:00.75 NEXT SCHEDULED CHECKPOINT 249.68 SECONDS UNTIL NEXT SCHEDULED CHECKPOINT 2001/11/19 12:20:00.66 LAST SUCCESSFUL CHECKPOINT TAKEN 950.42 SECONDS SINCE LAST SUCCESSFUL CHECKPOINT 7083 # RECORDS CURRENTLY IN CHKPOINT STREAM 1 # CHECKPOINTS IN CHKPOINT STREAM 1 EXTENDED QUIESCE STATUS 22 MAXIMUM CHECKPOINT RECORDS THAT WERE WRITTEN