1757 lines
52 KiB
HTML
1757 lines
52 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>List Statistics Collections (QDBSTLS, QdbstListStatistics) API</title>
|
|
<!-- Begin Header Records -->
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- Created by Ulrich Thiemann on 07-May-2001 -->
|
|
<!-- Updated by Ulrich Thiemann on 01-Aug-2002 -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!-- Java sync-link -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<h2>List Statistics Collections (QDBSTLS, QdbstListStatistics) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Qualified user space name</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Format of output</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Input data</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Length of input data</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Format of input data</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Service Program Name: QDBSTMGR<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The List Statistics Collections (QDBSTLS, QdbstListStatistics) API allows to
|
|
find out all of the columns and combination of columns for a given file member,
|
|
which have statistics available and will optionally list those columns, not
|
|
contained in any statistics collection.
|
|
The generated list replaces any existing list in the user space.</p>
|
|
|
|
<p>Each returned list entry contains a number of different statistic data
|
|
items, including the number of histogram ranges and the number of most frequent
|
|
values, while detailed information for these two items can be retrieved using the
|
|
<a href="qdbstlistdetailstatistics.htm">List Statistics Collection Details</a>
|
|
(QDBSTLDS, QdbstListDetailStatistics) API, using the internal statistics ID
|
|
returned by the QdbstListStatistics API.</p>
|
|
|
|
<p>The QdbstListStatistics API also allows to list statistics related
|
|
attributes at the file member level, not related to a single statistics collection.</p>
|
|
|
|
<br>
|
|
|
|
<h3>Section overview</h3>
|
|
<ul>
|
|
<li><a href="#AuthAndLocks">Authorities and Locks</a></li>
|
|
<li><a href="#ReqParmGroup">Required Parameter Group</a></li>
|
|
|
|
<li><a href="#STIL0100Format">STIL0100 Input Format</a></li>
|
|
<li><a href="#VALIDKEYS">Valid Keys - Request output</a></li>
|
|
|
|
<li><a href="#GeneratedListFormat">Format of the Generated List</a></li>
|
|
|
|
<li><a href="#InputParmSection">Input parameter section</a></li>
|
|
<li><a href="#HeaderSection">Header section</a></li>
|
|
<li><a href="#ListDataSection">List data section</a></li>
|
|
|
|
<li><a href="#ColumnDesc">Column Description</a></li>
|
|
|
|
<li><a href="#FieldDescriptions">Field Descriptions</a></li>
|
|
<li><a href="#ErrorMsgs">Error Messages</a></li>
|
|
<li><a href="#RelInfo">Related Information</a></li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
<h3><a name="AuthAndLocks">Authorities and Locks</a></h3>
|
|
|
|
<dl>
|
|
<dt><em>User Space Authority</em></dt>
|
|
|
|
<dd>*CHANGE</dd>
|
|
|
|
<dt><em>User Space Library Authority</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>User Space Lock</em></dt>
|
|
|
|
<dd>*EXCLRD</dd>
|
|
|
|
<dt><em>ASP Device Authority</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>File Authority</em></dt>
|
|
|
|
<dd>*OBJOPR</dd>
|
|
|
|
<dt><em>File Library Authority</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>File Lock</em></dt>
|
|
|
|
<dd>*SHRRD</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="ReqParmGroup">Required Parameter Group</a></h3>
|
|
|
|
<dl>
|
|
<dt><strong>Qualified user space name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The user space that is to receive the generated list, and the library in
|
|
which it is located. The first 10 characters contain the user space name, and
|
|
the second 10 characters contain the library name.</p>
|
|
|
|
<p>You can use these special values for the library name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The job's current library or QGPL if the current
|
|
library is not set.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The library list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*USRLIBL</em></td>
|
|
<td align="left" valign="top">Libraries listed in the user portion of the
|
|
library list.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Format of output</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the statistics collections list to be returned. If format
|
|
<strong>STOL0100</strong> is specified, the fields that were selected by the
|
|
caller will be returned for each statistics collection in the list. Possible
|
|
format names are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>STOL0100</em></td>
|
|
<td align="left" valign="top">Statistics collections list with keyed return
|
|
fields.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>Refer to <a href="#GeneratedListFormat">Format of the Generated List</a> and <a
|
|
href="#STOL0100Format">STOL0100 Output Format</a> for more information.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Input data</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The buffer containing the input parameters according to the format of input
|
|
data parameter. The buffer content has to start at a four-byte boundary.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of input data</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the input data buffer provided.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format of input data</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the input data. Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>STIL0100</em></td>
|
|
<td align="left" valign="top">List statistics collections input parameters.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>Refer to <a href="#STIL0100Format">STIL0100 Input Format</a> for more
|
|
information.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h4><a name="STIL0100Format">STIL0100 Input Format</a></h4>
|
|
|
|
<p>List statistics collections input parameters. See <a href=
|
|
"#FieldDescriptions">Field Descriptions</a> for details of the fields
|
|
listed.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">ASP device name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File library name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File member name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Column option</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">41</td>
|
|
<td align="center" valign="top">29</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">CHAR(48)</td>
|
|
<td align="left" valign="top">Continuation handle</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">92</td>
|
|
<td align="center" valign="top">5C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to fields to return</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">96</td>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of fields to return</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">Array(*) of BINARY(4)</td>
|
|
<td align="left" valign="top">Keys of fields to return</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h4><a name="VALIDKEYS">Valid Keys - Request output</a></h4>
|
|
|
|
<p>The keys listed below are used to determine in the
|
|
<a href="#STIL0100Format">STIL0100 Input Format</a>
|
|
what will be returned per
|
|
list entry in the <a href="#STOL0100Format">List Data Section - STOL0100 Output Format</a>.
|
|
Each key can only be specified once.
|
|
See <a href="#FieldDescriptions">Field Descriptions</a> for details of the
|
|
fields listed.</p>
|
|
|
|
<p>Each list entry returned in the output format describes a
|
|
single statistics collection for a specific file member and
|
|
can be thought of as two groups of related keys:</p>
|
|
|
|
<p><em>Group 1</em>: The following keys describe information at file member level and
|
|
will repeat in list entries describing different statistics collections (see
|
|
group 2) for the same file member:</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="top">Key</th>
|
|
<th align="left" valign="top">Type</th>
|
|
<th align="left" valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">1</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="65%">ASP device name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File library name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File member name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">CHAR(26)</td>
|
|
<td align="left" valign="top">Current time stamp of last change</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Current number of (undeleted) records.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Current number of deleted records.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Current total count of inserts, updates, and
|
|
deletes.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">47</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Current block system statistics collections
|
|
option.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Current size of statistics collections.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><em>Group 2</em>: The following keys describe information at statistics collection
|
|
level per file member:</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="top">Key</th>
|
|
<th align="left" valign="top">Type</th>
|
|
<th align="left" valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">7</td>
|
|
<td align="left" valign="top" width="20%">CHAR(16)</td>
|
|
<td align="left" valign="top" width="65%">Internal statistics ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">46</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Statistics collection name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Name of creating user profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">15</td>
|
|
<td align="left" valign="top">CHAR(26)</td>
|
|
<td align="left" valign="top">Time stamp of create</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Name of last modifying user profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">53</td>
|
|
<td align="left" valign="top">CHAR(26)</td>
|
|
<td align="left" valign="top">Time stamp of last modification</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of most frequent values available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">17</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of histogram ranges available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Aging mode</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">19</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Aging status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">22</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Translation attribute</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">23</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Number of (undeleted) records</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Number of deleted records</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">25</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Total counts of inserts, updates, and
|
|
deletes</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">26</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Number of distinct values (cardinality)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">27</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Number of NULLs</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of columns</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">29</td>
|
|
<td align="left" valign="top">Array(*) of CHAR(10)</td>
|
|
<td align="left" valign="top">Column names</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">41</td>
|
|
<td align="left" valign="top">Array(*) of CHAR(1)</td>
|
|
<td align="left" valign="top">Translation attributes</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">Array(*) of CHAR(20)</td>
|
|
<td align="left" valign="top">Qualified translation table names</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">31</td>
|
|
<td align="left" valign="top">Array(*) of CHAR(*)</td>
|
|
<td align="left" valign="top"><a href="#ColumnDescField">Column
|
|
descriptions</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="GeneratedListFormat">Format of the Generated List</a></h3>
|
|
|
|
The statistics collections list consists of:
|
|
|
|
<ul>
|
|
<li>A user area</li>
|
|
|
|
<li>A generic header</li>
|
|
|
|
<li><a href="#InputParmSection">An input parameter section</a></li>
|
|
|
|
<li><a href="#HeaderSection">A header section</a></li>
|
|
|
|
<li><a href="#ListDataSection">A list data section</a></li>
|
|
</ul>
|
|
|
|
<p>The user area and generic header are described in <a href="../apiref/usf.htm">User
|
|
Space Format for List APIs</a>. The remaining items are described in the
|
|
following sections.
|
|
</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h4><a name="InputParmSection">Input Parameter Section</a></h4>
|
|
|
|
<p>The following information is returned in the input parameter section. For
|
|
detailed descriptions of the fields in this table, see <a href=
|
|
"#FieldDescriptions">Field Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">User space name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User space library name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Format of output specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of input data specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Format of input data specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">ASP device name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="center" valign="top">3C</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File library name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="center" valign="top">46</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File member name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Column option specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">81</td>
|
|
<td align="center" valign="top">51</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top">CHAR(48)</td>
|
|
<td align="left" valign="top">Continuation handle specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">132</td>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to fields to return specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">136</td>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of fields to return specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">140</td>
|
|
<td align="center" valign="top">8C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Displacement to specified fields to
|
|
return</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">Array(*) of BINARY(4)</td>
|
|
<td align="left" valign="top">Keys of fields to return specified</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h4><a name="HeaderSection">Header Section</a></h4>
|
|
|
|
<p>For detailed descriptions of the fields in this table, see <a href=
|
|
"#FieldDescriptions">Field Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(48)</td>
|
|
<td align="left" valign="top" width="60%">Continuation handle</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">48</td>
|
|
<td align="center" valign="top" width="10%">30</td>
|
|
<td align="left" valign="top" width="20%"> </td>
|
|
<td align="left" valign="top" width="60%"> </td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h4><a name="ListDataSection"></a>
|
|
<a name="STOL0100Format">List Data Section - STOL0100 Output Format</a></h4>
|
|
|
|
<p>For output format STOL0100, the list data section has the following layout,
|
|
where each list entry contains the requested fields for a single statistics
|
|
collection for a specific file member. See also
|
|
<a href="#VALIDKEYS">Valid Keys - Request output</a> and note,
|
|
that the fields for each list entry will be returned in the
|
|
order requested.</p>
|
|
|
|
<p>See <a href="#FieldDescriptions">Field Descriptions</a> for details of the
|
|
fields listed in the layout.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Length of list entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of key fields returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="5" colspan="2">These fields repeat, in
|
|
the order listed, for each key selected.</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of field information returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Key identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved (padding to the next four-byte
|
|
boundary)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h4><a name="ColumnDesc">Column Description</a></h4>
|
|
|
|
<p>Layout of a single returned column description,
|
|
if <em>Column descriptions</em> were requested
|
|
as output in the <a href="#STIL0100Format">STIL0100 Input Format</a>.
|
|
See <a href="#FieldDescriptions">Field Descriptions</a> for details of the
|
|
fields listed.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">SQL data type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Field length</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length in bytes</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Scale</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Precision</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Radix</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">CCSID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">NULL capable</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">29</td>
|
|
<td align="center" valign="top">1D</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Has default</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">Column text</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Ordinal position</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="FieldDescriptions">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Aging mode.</strong> Whether the system is allowed to
|
|
age or remove the statistics collection. The possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SYS</em></td>
|
|
<td align="left" valign="top">Refresh or removal of the resulting
|
|
statistics collections will be performed automatically by the statistics
|
|
manager.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*USER</em></td>
|
|
<td align="left" valign="top">Refresh or removal will only occur
|
|
when a user requests it.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Aging status.</strong> How current the statistics data
|
|
is. The possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">There are no indications, that the statistics
|
|
data needs to be refreshed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">There are indications, that the statistics data
|
|
needs to be refreshed.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>ASP device name.</strong> The name of one auxiliary storage pool
|
|
(ASP) device in the ASP group in which the library and file are located.
|
|
The ASP device must have a status of 'Available'. The documented authority
|
|
is required for the given ASP and the primary of the corresponding ASP group.
|
|
The name can be a specific ASP device name
|
|
(for an ASP with a number greater than 32), or one of the
|
|
following special values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*</em></td>
|
|
<td align="left" valign="top">Locate the library and file in the name space
|
|
for the current thread.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SYSBAS</em></td>
|
|
<td align="left" valign="top">Locate the library and file in the system ASP
|
|
(ASP number 1) and all basic ASPs (ASP numbers 2 through 32).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>ASP device name used.</strong> The actual auxiliary
|
|
storage pool device name used, after possible resolution of special values.</p>
|
|
|
|
<p><strong>CCSID.</strong> The column CCSID for character type
|
|
columns.</p>
|
|
|
|
<p><strong><a name="ColumnDescField">Column descriptions.</a></strong>
|
|
The array of detailed
|
|
column descriptions in the same order as the columns were requested. The array
|
|
dimension is given by the <em>Number of Columns</em> field. See <a href="#ColumnDesc">
|
|
Column description</a> for the layout of a single column description.</p>
|
|
|
|
<p><strong>Column names.</strong> The array of names of the columns
|
|
within the statistics collection, in the same order as at request time. The
|
|
array dimension is given by the <em>Number of Columns</em> field.</p>
|
|
|
|
<p><strong>Column option.</strong> Which columns and combination of
|
|
columns to include in the list. The possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">Do not include pseudo, single column statistics
|
|
collection list entries for columns not contained in any actual statistics
|
|
collection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">Do include pseudo, single column statistics
|
|
collection list entries for columns not contained in any actual statistics
|
|
collection.
|
|
|
|
<p><strong>Note:</strong> Pseudo statistics collections will be marked by
|
|
having an internal statistics ID of zero. All other statistics collection
|
|
related fields for such a statistics collection list entry will be undefined,
|
|
if requested to be returned.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Column text.</strong> The character string supplied with
|
|
the LABEL ON SQL statement for this column.</p>
|
|
|
|
<p><strong>Continuation handle (input section).</strong> The handle
|
|
used to continue from a previous call to this API that resulted in partially
|
|
complete information. You can determine if a previous call resulted in
|
|
partially complete information by checking the Information Status variable in
|
|
the generic user space header following the API call.</p>
|
|
|
|
<p>If the API is not attempting to continue from a previous call, this
|
|
parameter must be set to blanks. Otherwise, a valid continuation value must be
|
|
supplied. The value may be obtained from the list header section of the user
|
|
space used in the previous call. When continuing, the first entry in the
|
|
returned list is the entry that immediately follows the last entry returned in
|
|
the previous call.</p>
|
|
|
|
<p><strong>Continuation handle (header section).</strong> A
|
|
continuation point for the API. This value is set based on the contents of the
|
|
Information Status variable in the generic header for the user space. The
|
|
following situations can occur:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top" width="22%"><em>Information status-C</em></td>
|
|
<td align="left" valign="top" width="78%">The information returned in the user
|
|
space is valid and complete. No continuation is necessary and the continuation
|
|
handle is set to blanks.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Information status-P</em></td>
|
|
<td align="left" valign="top">The information returned in the user space is
|
|
valid but incomplete. The user may call the API again, starting where the last
|
|
call left off. The continuation handle contains a value which may be supplied
|
|
as an input parameter in later calls.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Information status-I</em></td>
|
|
<td align="left" valign="top">The information returned in the user space is not
|
|
valid and incomplete. The content of the continuation handle is
|
|
unpredictable.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Current block system statistics collections option.</strong>
|
|
Whether system initiated (automatic) statistics collection create requests
|
|
are allowed for this database file member. The possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">System initiated statistics collection requests
|
|
are not blocked.
|
|
|
|
<p><strong>Note:</strong> This is the system default.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">System initiated statistics collection requests
|
|
are blocked.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Current number of deleted records.</strong> The total
|
|
count of deleted records in the file member at the time of the list
|
|
request.</p>
|
|
|
|
<p><strong>Current number of (undeleted) records.</strong> The
|
|
total count of active records in the file member at the time of the list
|
|
request.</p>
|
|
|
|
<p><strong>Current size of statistics collections.</strong> The
|
|
total amount of space in bytes used for
|
|
statistics collections related data for this file member.</p>
|
|
|
|
<p><strong>Current time stamp of last change.</strong> The
|
|
time stamp, when the file member was last changed at the time of the list
|
|
request.</p>
|
|
|
|
<p><strong>Current total count of inserts, updates, and
|
|
deletes.</strong> The number of insert, update, and delete operations
|
|
that were recorded for the file member at the time of the list request.</p>
|
|
|
|
<p><strong>Data.</strong> The data returned for the key
|
|
identifier.</p>
|
|
|
|
<p><strong>Displacement to specified fields to return.</strong>
|
|
Displacement to the start of the
|
|
array of specified fields to return.</p>
|
|
|
|
<p><strong>Note:</strong> This is not the offset specified on input, but the
|
|
displacement within the input parameter section. See the <a href=
|
|
"#OffsetToFieldsSpecified">Offset to fields to return specified</a>
|
|
instead.</p>
|
|
|
|
<p><strong>Field length.</strong> Column field length.</p>
|
|
|
|
<p><strong>File library name.</strong> Where the file for which
|
|
statistics collections are to be listed is located. You can use these special
|
|
values for the library name, if the <em>ASP Device Name</em> is <em>*</em>:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The job's current library or QGPL if the current
|
|
library is not set.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The library list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*USRLIBL</em></td>
|
|
<td align="left" valign="top">Libraries listed in the user portion of the
|
|
library list.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>File library name used.</strong> The actual file library
|
|
name used, after possible resolution of special values.</p>
|
|
|
|
<p><strong>File member name.</strong> The name of the file member
|
|
to be used for the list request. This value can be a specific file member name
|
|
or one of the following special values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*FIRST</em></td>
|
|
<td align="left" valign="top">The first member (in the order created) in the
|
|
specified file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LAST</em></td>
|
|
<td align="left" valign="top">The last member (in the order created) in the
|
|
specified file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All members in the specified file.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>File member name used.</strong> The actual file member
|
|
name used, after possible resolution of special values.</p>
|
|
|
|
<p><strong>File name.</strong> The name of the file for which
|
|
statistics collections are to be listed. This can be a name of an existing
|
|
local, single format, physical file. If an actual name is specified for the
|
|
file library name, then you can also use the special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All local, single format, physical files in the
|
|
specified library.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>File name used.</strong> The actual file name used.</p>
|
|
|
|
<p><strong>Has default.</strong> Whether the column has a default
|
|
value (DEFAULT clause or null capable). The possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">Column does not have a default value.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">Column has default value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Internal statistics ID.</strong> Together with the
|
|
qualified file name and member name this represents a unique ID for the
|
|
statistics collection listed.</p>
|
|
|
|
<p><strong>Note:</strong> The ID is stored in binary, non printable form in the
|
|
character array.</p>
|
|
|
|
<p><strong>Key identifier.</strong> The field returned. For a list
|
|
of valid keys see <a href="#VALIDKEYS">Valid Keys - Request output</a>.</p>
|
|
|
|
<p><strong>Keys of fields to return.</strong> The list of fields to
|
|
return per list entry. For a list of valid keys see <a href="#VALIDKEYS">Valid
|
|
Keys - Request output</a>.</p>
|
|
|
|
<p><strong>Length in bytes.</strong> Column length in bytes.</p>
|
|
|
|
<p><strong>Length of data.</strong> The length of the data returned
|
|
for the field.</p>
|
|
|
|
<p><strong>Length of field information returned.</strong> Total
|
|
number of bytes returned for this field.</p>
|
|
|
|
<p><strong>Length of list entry.</strong> Number of bytes returned
|
|
for this list entry.</p>
|
|
|
|
<p><strong>Name of creating user profile.</strong> The name of the user
|
|
profile, which requested the statistics collection. The name will be *SYS for
|
|
statistics collections automatically requested by the system.</p>
|
|
|
|
<p><strong>Name of last modifying user profile.</strong>
|
|
The name of the user profile, which updated the statistics collection data last.
|
|
The name will be *SYS for statistics collections automatically refreshed
|
|
by the system.</p>
|
|
<p><strong>Note:</strong> Updates of statistics collection attributes
|
|
will not be logged here.</p>
|
|
|
|
<p><strong>NULL capable.</strong> whether the column allows NULL
|
|
values or not. The possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">Column does not allow NULL values.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">Column does allow NULL values.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Number of columns.</strong> Number of columns within the
|
|
single statistics collection.</p>
|
|
|
|
<p><strong>Number of deleted records.</strong> The total count of
|
|
deleted records in the file member at the time the statistics were
|
|
collected.</p>
|
|
|
|
<p><strong>Number of distinct values.</strong> The estimated number
|
|
of distinct (non NULL) values found in the statistics collection key.</p>
|
|
|
|
<p><strong>Number of fields to return.</strong> The number of
|
|
fields to return for each list entry.</p>
|
|
|
|
<p><strong>Number of histogram ranges available.</strong> The
|
|
number of histogram ranges available for this statistics collection. The actual
|
|
histogram range values can be obtained using the <a href=
|
|
"qdbstlistdetailstatistics.htm">List Statistics Collection Details</a>
|
|
(QDBSTLDS, QdbstListDetailStatistics) API.</p>
|
|
|
|
<p><strong>Number of key fields returned.</strong> Number of fields
|
|
actually returned.</p>
|
|
|
|
<p><strong>Number of most frequent values available.</strong> The
|
|
number of most frequent values available for this statistics collection. The
|
|
actual most frequent values can be obtained using the <a href=
|
|
"qdbstlistdetailstatistics.htm">List Statistics Collection Details</a>
|
|
(QDBSTLDS, QdbstListDetailStatistics) API.</p>
|
|
|
|
<p><strong>Number of NULLs.</strong> The estimated number of NULL
|
|
values found in the statistics collection key.</p>
|
|
|
|
<p><strong>Number of (undeleted) records.</strong> The total count
|
|
of active records in the file member at the time the statistics were
|
|
collected.</p>
|
|
|
|
<p><strong>Number of deleted records.</strong> The total count of
|
|
deleted records in the file at the time the statistics were collected.</p>
|
|
|
|
<p><strong>Offset to fields to return.</strong> Offset to the start
|
|
of the array of fields to return.</p>
|
|
|
|
<p><strong><a name="#OffsetToFieldsSpecified">Offset to fields to return
|
|
specified.</a></strong> Offset to fields to return as specified on
|
|
the call of the API.</p>
|
|
|
|
<p><strong>Displacement to specified fields to return.</strong>
|
|
Displacement to the start of the
|
|
array of specified fields to return.</p>
|
|
|
|
<p><strong>Note:</strong> This is not the offset specified on input, but the
|
|
displacement within the input parameter section. See the <a href=
|
|
"#OffsetToFieldsSpecified">Offset to fields to return specified</a>
|
|
instead.</p>
|
|
|
|
<p><strong>Ordinal position.</strong> Numeric place of the column
|
|
in the file member, ordered from left to right, starting with one.</p>
|
|
|
|
<p><strong>Precision.</strong> The precision of the column for
|
|
numeric data type columns.</p>
|
|
|
|
<p><strong>Qualified translation table names.</strong> The array of
|
|
names of the translation tables that were specified, when the statistics
|
|
collection was requested, in the same order as requested. The first 10
|
|
characters contain the translation table name, and the second 10 characters
|
|
contain the name of the library where the table is located. The array dimension
|
|
is given by the number of columns field.</p>
|
|
|
|
<p><strong>Note:</strong> For system initiated requests, the translation table
|
|
name and the library can be set to the special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*UNKNOWN</em></td>
|
|
<td align="left" valign="top">The information is not available in a suitable
|
|
form.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Radix.</strong> whether the column precision is specified
|
|
in number of binary or decimal digits for numeric data types columns. The
|
|
possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Column precision is number of binary digits.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>10</em></td>
|
|
<td align="left" valign="top">Column precision is number of decimal
|
|
digits.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> Reserved for future use. If this field is input,
|
|
the field must be set to hexadecimal zeros.</p>
|
|
|
|
<p><strong>Reserved</strong> (in STOL0100 Output format). Structure
|
|
padding to guarantee alignment to the next four bytes boundary.</p>
|
|
|
|
<p><strong>Scale.</strong> The scale of the column for numeric data
|
|
type columns.</p>
|
|
|
|
<p><strong>SQL data type.</strong> The SQLTYPE of the column as
|
|
explained in the <a href="../db2/rbafzmst02.htm">SQL Reference</a>.</p>
|
|
|
|
<p><strong>Statistics collection name.</strong> A name unique
|
|
amongst all statistics collections for the file member.</p>
|
|
|
|
<p><strong>Time stamp of create.</strong> The time stamp, when the
|
|
statistics collection was created.</p>
|
|
|
|
<p><strong>Time stamp of last modification.</strong>
|
|
The time stamp, when the statistics collection was last modified. This includes
|
|
the initial create and any update of the statistics collection data.</p>
|
|
<p><strong>Note:</strong> Updates to just statistics collection attributes
|
|
will not be logged here.</p>
|
|
|
|
<p><strong>Total count of inserts, updates, and deletes.</strong>
|
|
The number of insert, update, and delete operations that were recorded for the file
|
|
member at the time the statistics were collected.</p>
|
|
|
|
<p><strong>Translation attribute.</strong> Indicates the type of
|
|
translation used on the combination of character columns in the statistics
|
|
collection key before the statistics were calculated. This attribute
|
|
generalizes the information given by the the single translation attribute
|
|
values returned for each column. The possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">Uniquely weighted translation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">Shared weight translation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'9'</em></td>
|
|
<td align="left" valign="top">No translation.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Translation attributes.</strong> The array of
|
|
translation attributes for the single columns in the statistics collection key
|
|
in the same order as requested. The translation attribute indicates the type of
|
|
translation used on a character column before the statistics were calculated
|
|
and generalizes the type of translation defined by the translation table
|
|
applied to this column. The possible values for each array entry are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">Uniquely weighted translation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">Shared weight translation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'9'</em></td>
|
|
<td align="left" valign="top">No translation.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User space name specified.</strong> User space name as
|
|
specified on the call of the API.</p>
|
|
|
|
<p><strong>User space library name specified.</strong> User space
|
|
library name as specified on the call of the API.</p>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<h3><a name="ErrorMsgs">Error Messages</a></h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF0623 E</td>
|
|
<td align="left" valign="top">Field &1 not found in record format &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF1866 E</td>
|
|
<td align="left" valign="top">Value &1 for number of fields to return not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2105 E</td>
|
|
<td align="left" valign="top">Object &1 in &2 type *&3 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2113 E</td>
|
|
<td align="left" valign="top">Cannot allocate library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2173 E</td>
|
|
<td align="left" valign="top">Value for ASPDEV not valid with special value for library.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF218C E</td>
|
|
<td align="left" valign="top">&1 not a primary or secondary ASP.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3141 E</td>
|
|
<td align="left" valign="top">Member &2 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF34C0 E</td>
|
|
<td align="left" valign="top">Value &1 for number of fields to return parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C07 E</td>
|
|
<td align="left" valign="top">Error occurred while retrieving information from object &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C1D E</td>
|
|
<td align="left" valign="top">Length specified in parameter &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C29 E</td>
|
|
<td align="left" valign="top">Object name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C36 E</td>
|
|
<td align="left" valign="top">Number of parameters, &1, entered for this API was not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C39 E</td>
|
|
<td align="left" valign="top">Value for reserved field not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C3B E</td>
|
|
<td align="left" valign="top">Value for parameter &2 for API &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C82 E</td>
|
|
<td align="left" valign="top">Key &1 not valid for API &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C89 E</td>
|
|
<td align="left" valign="top">Key &1 specified more than once.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CE2 E</td>
|
|
<td align="left" valign="top">Continuation handle not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF4268 E</td>
|
|
<td align="left" valign="top">Object &1 in &2 type *&3 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9802 E</td>
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9803 E</td>
|
|
<td align="left" valign="top">Cannot allocate object &2 in library &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9804 E</td>
|
|
<td align="left" valign="top">Object &2 in library &3 damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF980B E</td>
|
|
<td align="left" valign="top">Object &1 in library &2 not available.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9810 E</td>
|
|
<td align="left" valign="top">Library &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9812 E</td>
|
|
<td align="left" valign="top">File &1 in library &2 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9814 E</td>
|
|
<td align="left" valign="top">Device &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9820 E</td>
|
|
<td align="left" valign="top">Not authorized to use library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9822 E</td>
|
|
<td align="left" valign="top">Not authorized to file &1 in library &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9825 E</td>
|
|
<td align="left" valign="top">Not authorized to device &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9826 E</td>
|
|
<td align="left" valign="top">Cannot allocate file &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9830 E</td>
|
|
<td align="left" valign="top">Cannot assign library &1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library &2 ended. Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB401 E</td>
|
|
<td align="left" valign="top">API &3 failed with reason code &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8ED E</td>
|
|
<td align="left" valign="top">Device description &1 not correct for operation.</td>
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<h3><a name="RelInfo">Related Information</a></h3>
|
|
<ul>
|
|
<li>the <<strong>qdbst.h</strong>> include file in library QSYSINC,
|
|
for API-related structure declarations and special value declarations.<br><br></li>
|
|
|
|
<li>the <<strong>qdbstmgr.h</strong>> include file in library QSYSINC,
|
|
for the QdbstListStatistics API prototype.<br><br></li>
|
|
|
|
<li>the <<strong>qdbstls.h</strong>> include file in library QSYSINC,
|
|
for the QDBSTLS API prototype.<br><br></li>
|
|
|
|
<li><a href="qdbstcancelrequestedstatistics.htm">Cancel Requested Statistics
|
|
Collections</a> (QDBSTCRS, QdbstCancelRequestedStatistics) API<br><br></li>
|
|
|
|
<li><a href="qdbstdeletestatistics.htm">Delete Statistics Collections</a>
|
|
(QDBSTDS, QdbstDeleteStatistics) API<br><br></li>
|
|
|
|
<li><a href="qdbstlistrequestedstatistics.htm">List Requested Statistics
|
|
Collections</a> (QDBSTLRS, QdbstListRequestedStatistics) API<br><br></li>
|
|
|
|
<li><a href="qdbstlistdetailstatistics.htm">List Statistics Collection Details</a>
|
|
(QDBSTLDS, QdbstListDetailStatistics) API<br><br></li>
|
|
|
|
<li><a href="qdbstrequeststatistics.htm">Request Statistics Collections</a>
|
|
(QDBSTRS, QdbstRequestStatistics) API<br><br></li>
|
|
|
|
<li><a href="qdbstupdatestatistics.htm">Update Statistics Collections</a>
|
|
(QDBSTUS, QdbstUpdateStatistics) API</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V5R2
|
|
|
|
<hr>
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center">
|
|
<a href="#Top_Of_Page">Top</a> |
|
|
<a href="file1.htm">Database and File APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|