Delete Statistics Collections (QDBSTDS, QdbstDeleteStatistics) API
Required Parameter Group:
| 1 | Input data | Input | Char(*) |
| 2 | Length of input data | Input | Binary(4) |
| 3 | Format of input data | Input | Char(8) |
| 4 | Feedback area | Output | Char(*) |
| 5 | Length of feedback area | Input | Binary(4) |
| 6 | Feedback keys | Input | Array(*) of Binary(4) |
| 7 | Number of feedback keys | Input | Binary(4) |
| 8 | Error code | I/O | Char(*) |
Service Program Name: QDBSTMGR
Default Public Authority: *USE
Threadsafe: Yes
The Delete Statistics Collections (QDBSTDS, QdbstDeleteStatistics) API deletes existing, completed statistics collections for a database file member.
Section overview
- Authorities and Locks
- Required Parameter Group
- STID0100 Input Format
- STID0200 Input Format
- Valid Keys - Feedback
- Feedback Area Format
- Field Descriptions
- Error Messages
- Related Information
Authorities and Locks
- ASP Device Authority
- *EXECUTE
- File Authority
- *OBJALTER, *OBJOPR
- File Library Authority
- *EXECUTE
- File Lock
- *SHRRD
Required Parameter Group
- Input data
- INPUT; CHAR(*)
The buffer containing the input parameters according to the format of input data parameter. The buffer content has to start at a 4-byte boundary.
- Length of input data
- INPUT; BINARY(4)
The length of the input data buffer provided.
- Format of input data
- INPUT; CHAR(8)
The format of the input data. Possible values are:
STID0100 Delete Statistics Collections input parameters using internal statistics ID. STID0200 Delete Statistics Collections input parameters using detailed statistics description. Refer to STID0100 Input Format and STID0200 Input Format for more information.
- Feedback area
- OUTPUT; CHAR(*)
The buffer to receive feedback data. See Feedback Area Format for more information. The buffer content has to start at a 4-byte boundary.
- Length of feedback area
- INPUT; BINARY(4)
The length of the feedback area buffer provided. The required minimum length is 16, to fit the feedback area header (see Feedback Area Format).
- Feedback keys
- INPUT; ARRAY(*) OF BINARY(4)
The list of fields to return in the feedback area. For a list of valid keys, see Valid Keys - Feedback.
- Number of feedback keys
- INPUT; BINARY(4)
The number of fields to return in the feedback area. If zero is specified, all other feedback area parameters (Feedback area, Length of feedback area, and Feedback keys) are ignored.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
STID0100 Input Format
Delete statistics collections input parameters using internal statistics ID. See Field Descriptions for details of the fields listed.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | ASP device name |
| 10 | A | CHAR(10) | File name |
| 20 | 14 | CHAR(10) | File library name |
| 30 | 1E | CHAR(10) | File member name |
| 40 | 28 | CHAR(16) | Internal statistics ID |
| 56 | 38 | CHAR(*) | Reserved |
STID0200 Input Format
Delete statistics collections input parameters using detailed statistics description. See Field Descriptions for details of the fields listed.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | ASP device name |
| 10 | A | CHAR(10) | File name |
| 20 | 14 | CHAR(10) | File library name |
| 30 | 1E | CHAR(10) | File member name |
| 40 | 28 | BINARY(4) | Offset to columns |
| 44 | 2C | BINARY(4) | Number of columns |
| 48 | 30 | CHAR(*) | Reserved |
| These fields repeat, in the order listed, for each column, starting at the given offset. | BINARY(4) | Length of column definition | |
| CHAR(10) | Column name | ||
| CHAR(10) | Translation table name | ||
| CHAR(10) | Translation table library name | ||
| CHAR(2) | Reserved | ||
| CHAR(*) | Reserved | ||
Valid Keys - Feedback
Use the following keys to specify the fields to be returned in the feedback area. Each key can only be specified once. See Field Descriptions for details of the fields listed.
| Key | Type | Description |
|---|---|---|
| 1 | CHAR(10) | ASP device name used |
| 3 | CHAR(10) | File library name used |
| 4 | CHAR(10) | File member name used |
| 20 | BINARY(4) | Number of statistics collections deleted. |
Feedback Area Format
The fields returned in the feedback area are returned in the order requested. See Field Descriptions for details of the fields listed.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of bytes returned |
| 4 | 4 | BINARY(4) | Number of bytes available |
| 8 | 8 | BINARY(4) | Number of key fields returned |
| 12 | C | BINARY(4) | Number of key fields available |
| These fields repeat, in the order listed, for each key selected. | BINARY(4) | Length of field information returned | |
| BINARY(4) | Key identifier | ||
| BINARY(4) | Length of data | ||
| CHAR(*) | Data | ||
| CHAR(*) | Reserved (padding to the next 4-byte boundary) | ||
Field Descriptions
ASP device name. 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:
| * | Locate the library and file in the name space for the current thread. |
| *SYSBAS | Locate the library and file in the system ASP (ASP number 1) and all basic ASPs (ASP numbers 2 through 32). |
ASP device name used. The actual auxiliary storage pool device name used, after possible resolution of special values.
Column name. The name of a single column within the statistics collection definition.
Data.; The data returned for the key identifier.
File library name. Where the file for which statistics collections are to be deleted is located. You can use these special values for the library name, if the ASP Device Name is *:
| *CURLIB | The job's current library or QGPL if the current library is not set. |
| *LIBL | The library list. |
| *USRLIBL | Libraries listed in the user portion of the library list. |
File library name used. The actual file library name used, after possible resolution of special values.
File member name. The name of the file member to be used for the delete statistics collections request. This value can be a specific file member name or one of the following special values:
| *FIRST | The first member (in the order created) in the specified file. |
| *LAST | The last member (in the order created) in the specified file. |
File member name used. The actual file member name used, after possible resolution of special values.
File name. The name of the file for which statistics collections are to be deleted. The file has to be an existing local, single format, physical file.
Internal statistics ID. Together with the qualified file name and member name, this represents a unique ID for the statistics collection to be deleted. See List Statistics Collections (QDBSTLS, QdbstListStatistics) API for additional information.
Note: If set to all X'00', all statistics collections for the file member are deleted.
Key identifier. The field returned. For a list of valid keys see Valid Keys - Feedback.
Length of column definition. The length of this column definition.
Length of data. The length of the data returned for the field.
Length of field information returned. The total number of bytes returned for this field in the feedback area.
Number of bytes available. The number of bytes that could be returned in the feedback area.
Number of bytes returned. The number of bytes returned in the feedback area.
Number of columns. The number of columns within the single statistics collection definition. The maximum value for this number is 1. If set to zero, all statistics collections for the file member are deleted.
Number of key fields available.The number of fields that can be returned in the feedback area.
Number of key fields returned. The number of fields returned in the feedback area.
Number of statistics collections deleted. The number of actually deleted statistics collections.
Offset to columns. The offset to the start of the list of column definitions.
Reserved. Reserved for future use. If this field is input, the field must be set to hexadecimal zeros.
Reserved (in feedback area format). Structure padding to guarantee alignment to the next four-byte boundary.
Translation table name. The name of the translation table that was specified, when the statistics collection was requested. The translation table does not necessarily have to exist anymore. The name is used for identification purposes only. The Translation table name can also have the following special values: *JOB indicates the value is retrieved from the job; *LANGIDUNQ indicates the unique weight table that corresponds to the LANGID specified in the Translation table library name field is used; *LANGIDSHR indicates the shared weight table that corresponds to the LANGID specified in the Translation table library name field is used; *NONE indicates a translate table is not used.
Translation table library name. The actual name of the translation table library that was used, when the statistics collection was requested. The translation table library does not necessarily have to exist anymore. The name is used for identification purposes only. If the Translation table name field contains the special value of *LANGIDUNQ or *LANGIDSHR, then the Translation table library name field must contain a corresponding language identifier (LANGID).
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF0623 E | Field &1 not found in record format &2. |
| CPF1866 E | Value &1 for number of fields to return not valid. |
| CPF2105 E | Object &1 in &2 type *&3 not found. |
| CPF2113 E | Cannot allocate library &1. |
| CPF2173 E | Value for ASPDEV not valid with special value for library. |
| CPF218C E | &1 not a primary or secondary ASP. |
| CPF3141 E | Member &2 not found. |
| CPF34C0 E | Value &1 for number of fields to return parameter not valid. |
| CPF3C07 E | Error occurred while retrieving information from object &1. |
| CPF3C1D E | Length specified in parameter &1 not valid. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C29 E | Object name &1 is not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C39 E | Value for reserved field not valid. |
| CPF3C3B E | Value for parameter &2 for API &1 not valid. |
| CPF3C82 E | Key &1 not valid for API &2. |
| CPF3C89 E | Key &1 specified more than once. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF4268 E | Object &1 in &2 type *&3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9804 E | Object &2 in library &3 damaged. |
| CPF980B E | Object &1 in library &2 not available. |
| CPF9810 E | Library &1 not found. |
| CPF9812 E | File &1 in library &2 not found. |
| CPF9814 E | Device &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9822 E | Not authorized to file &1 in library &2. |
| CPF9825 E | Not authorized to device &1. |
| CPF9826 E | Cannot allocate file &2. |
| CPF9830 E | Cannot assign library &1 |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFB401 E | API &3 failed with reason code &1. |
| CPFB8ED E | Device description &1 not correct for operation. |
Related Information
- the <qdbst.h> include file in library QSYSINC, for API
related structure declarations and special value declarations
- the <qdbstmgr.h> include file in library QSYSINC, for
the QdbstDeleteStatistics API prototype
- the <qdbstds.h> include file in library QSYSINC, for
the QDBSTDS API prototype
- Cancel Requested Statistics
Collections (QDBSTCRS, QdbstCancelRequestedStatistics) API
- List Requested Statistics
Collections (QDBSTLRS, QdbstListRequestedStatistics) API
- List Statistics Collection
Details (QDBSTLDS, QdbstListDetailStatistics) API
- List Statistics Collections (QDBSTLS,
QdbstListStatistics) API
- Request Statistics Collections
(QDBSTRS, QdbstRequestStatistics) API
- Update Statistics Collections (QDBSTUS, QdbstUpdateStatistics) API
API introduced: V5R2