Clear SQL Database Monitor Statistics (QQQCSDBM) API
Required Parameter Group:
1 | Memory handle to clear | Input | Char(10) |
2 | Job or memory handle name | Input | Char(26) |
3 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The Clear SQL Database Monitor Statistics (QQQCSDBM) API clears and frees the associated memory area of the database monitor statistics. Associated APIs include the following:
- Dump SQL Database Monitor (QQQDSDBM)
- End SQL Database Monitor (QQQESDBM)
- Query SQL Database Monitor (QQQQSDBM)
- Start SQL Database Monitor (QQQSSDBM)
Authorities and Locks
- Current User Profile
- *JOBCTL
Required Parameter Group
- Memory area to clear
- INPUT; CHAR(10)
The memory area to be cleared or freed. The possible values are:
*ALL Clear the monitor data associated with the *ALL monitor (the monitor started against ALL jobs). Memory areas associated with QQQSSDBM started on individual jobs will not be cleared. No storage is freed. *NAMED Clear the memory handle specified by the job or memory handle name parameter (and matches the name of a memory handle specified on the QQQSSDBM API). No storage is freed. Only the first 6 characters will be used for naming the memory handle. *JOB Clear the job specific data associated with the job name specified in the job or memory handle name parameter. No storage is freed. *RESET Clear and free all memory associated with all active or inactive database monitors. The *RESET option cannot be specified on a specific job or memory handle. - Job or memory handle name
- INPUT; CHAR(26)
This parameter depends on the value specified for the memory area to clear parameter. If the value is:
*ALL This parameter must be set to blanks. *RESET This parameter must be set to blanks. *NAMED The CHAR(10) name of a memory handle whose data is to be cleared. Only the first 6 characters will be used for naming the memory handle, with the remaining characters set to blanks. *JOB The CHAR(26) qualified job name of a job-specific monitor to dump.
The qualified job name has three parts:
Job Name CHAR(10). A specific job name, a generic name, or one of the following special values: * or *CURRENT Only the job that this program is running in. The rest of the qualified job name parameter must be blank. *ALL All jobs. The rest of the job name parameter must be blank. User Name CHAR(10). A specific user profile name. Job Number CHAR(6). A specific job number. - Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
Message ID | Error Message Text |
---|---|
CPD0172 D | Error Parameters passed on CALL do ot match those required. |
CPF222E E | &1 special authority required. |
CPF3CF1 E | Error code parameter not valid. |
API introduced: V4R3
[ Back to top | Database and File APIs | APIs by category ]