Show attributes and occupancy states of ISAM pools
Component: | BS2000 |
Functional area: | File processing |
Domain: | FILE |
Privileges: | STD-PROCESSING |
Function
The SHOW-ISAM-POOL-ATTRIBUTES command returns information on ISAM pools linked to the current job, taking the links to ISAM pools on remote systems into account. The user may request information on a specific ISAM pool or on all ISAM pools and redirect the output to SYSOUT or SYSLST.
The output comprises detailed information on the pool-specific attributes of each ISAM pool (as defined in the CREATE-ISAM-POOL command). If desired, the user may also have the job numbers of all connected jobs for each ISAM pool displayed.
The user may set up a connection to an ISAM pool explicitly by using the CREATE-ISAM-POOL command, but a job may also be implicitly connected to standard pools by NK-ISAM.
The command supports structured output in S variables (see "Output in S variables").
Note on ISAM pools
As of BS2000/OSD V6.0B cross-task ISAM pools are automatically created on a file-specific basis when a file is opened in a data space. The CREATE-ISAM-POOL command with SCOPE=*USER-ID/*USER-GROUP is only supported for reasons of compatibility and has the same effect as SCOPE=*HOST-SYSTEM (for details on ISAM pools in data spaces see the “Introductory Guide to DMS” [13]).
Privileged functions
Callers who have the system privileges of TSOS or SW-MONITOR-ADMINISTRATION are not restricted to the pools to which they are connected, but can obtain information about any ISAM pools, even those to which there are no connections.
Format
SHOW-ISAM-POOL-ATTRIBUTES | |||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
Operands
POOL-NAME = *ALL / <name 1..8>(...)
Specifies whether information on all ISAM pools or only one ISAM pool is desired. Users may only obtain information on ISAM pools which are currently connected to their own jobs.
POOL-NAME = *ALL
Returns information on all ISAM pools to which the job is currently connected.
Privileged callers (TSOS or SW-MONITOR-ADMINISTRATION privilege) using SELECT=*ALL are supplied with information on all the ISAM pools which currently exist.
POOL-NAME = <name 1..8>(...)
Returns information on the specified ISAM pool. The desired ISAM pool is uniquely identified by the specified name, catalog ID (see the CAT-ID operand) and scope (see the SCOPE operand). Information is output only if the ISAM pool exists and the job is connected to it.
CAT-ID = *DEFAULT-PUBSET / <alphanum-name 1..4>
Catalog ID of the pubset to which the ISAM pool is assigned.
CAT-ID = *DEFAULT-PUBSET
The ISAM pool is assigned to the catalog that was set with the ISPLDEFC system parameter (ISAM-POOL-DEFAULT-CATID):
X’00’:
| default catalog ID from the user entry (see the SHOW-USER-ATTRIBUTES command, output field DEFAULT-PUBSET) |
X’01’: | catalog ID of the home pubset |
CAT-ID = <alphanum-name 1..4>
Catalog ID of the specified ISAM pool.
SCOPE = *TASK / *HOST-SYSTEM / *USER-ID / *USER-GROUP
Specifies the scope of the ISAM pool for which information is to be output.
SCOPE = *TASK
Returns information on the corresponding task-local ISAM pool.
SCOPE = *HOST-SYSTEM
Returns information on the corresponding cross-task ISAM pool.
SCOPE = *USER-ID / *USER-GROUP
These scopes are only supported for reasons of compatibility (refer to "Note on ISAM pools").
INFORMATION = *ATTRIBUTES / *USERS-AND-ATTRIBUTES
Defines the scope of the information to be output.
INFORMATION = *ATTRIBUTES
Displays the static attributes for each ISAM pool defined in the POOL-NAME operand. The table contains the following output columns:
Output column | Values | Meaning |
|---|---|---|
CATID | <cat-id 1..4> | Catalog ID at the local system |
<cat-id 1..4> ** | Catalog ID on the remote system | |
POOLNAME | <name 1..8> | Name of the ISAM pool |
SCOPE | TASK | Task-specific ISAM pool |
USERID=<userid> | ISAM pool for jobs of the user ID <userid> | |
USERGP=<groupid> | ISAM pool for jobs of the user group <groupid> | |
HOST | System-wide ISAM pool | |
WROUT | YES | ISAM pool created with WRITE-IMMEDIATE=*YES |
NO | ISAM pool created with WRITE-IMMEDIATE=*NO | |
SIZE | <integer 32..32767> | Size in units of 2 Kbytes; applies to an extent |
EXTENTS | --/-- | The ISAM pool consists of one extent that has not yet been formatted, since no NK-ISAM file has been processed via the pool as yet. |
2K/-- | The ISAM pool consists of one extent to process NK2 files. | |
--/4K | The ISAM pool consists of one extent to process NK4 files. | |
2K/4K | The ISAM pool consists of two extents: one to process NK2 files, and one to process NK4 files. | |
RESIDENT | YES | The ISAM pool is memory-resident. |
NO | The ISAM pool is not memory-resident. |
INFORMATION = *USERS-AND-ATTRIBUTES
Displays a table with static attributes for each ISAM pool specified in POOL-NAME. These tables have the same structure as the table for INFORMATION=*ATTRIBUTES (see above). In addition, each table is followed by a list of job numbers of all jobs connected to the corresponding ISAM pool.
SELECT = *OWN
Returns information on all ISAM pools connected to the job. The output includes ISAM pools on local and remote systems.
SELECT = *ALL
Accepted only from users with TSOS or SW-MONITOR-ADMINISTRATION privilege:
Specifies that information is to be supplied for the ISAM pool specified by the POOL-NAME operand, regardless of whether there are any existing connections to it. In conjunction with POOL-NAME = *ALL, information is supplied about all the ISAM pools which currently exist, including any which have been created on a remote system using RFA.
OUTPUT = *SYSOUT / *SYSLST(...)
Specifies the output medium to which the information is to be sent. The output is written to SYSOUT by default.
OUTPUT = *SYSOUT
The information is output to SYSOUT.
OUTPUT = *SYSLST(...)
The information is output to SYSLST.
SYSLST-NUMBER = 00 / <integer 0..99>
Number of a SYSLST file from the set SYSLST01 to SYSLST99. The value 00 (the default) corresponds to the system file SYSLST.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command executed without errors | |
32 | DMS0A52 | Internal system error | |
64 | DMS0A50 | Specified catalog ID does not exist | |
64 | DMS0A51 | Specified ISAM pool does not exist | |
64 | CMD0216 | Required privileges for call missing | |
64 | DMS0A22 | User group does not exist | |
64 | DMS0A55 | No ISAM pool exists | |
130 | DMS0A53 | Insufficient virtual memory | |
130 | DMS0A56 | Specified catalog ID not available |
Output in S variables
Output information | Name of the S variable | T | Contents | Condition |
|---|---|---|---|---|
Catalog ID of the pubset the ISAM pool is assigned to | var(*LIST).CAT-ID | S | <c-string 1..4> | |
Extent specifications | var(*LIST).EXT | S | *2K-4K-FORM | |
Name of the ISAM pool | var(*LIST).POOL-NAME | S | <c-string1..8> | |
ISAM pool is memory-resident | var(*LIST).RESID | S | *NO | |
Scope of the ISAM pool | var(*LIST).SCOPE | S | *HOST | |
Size of the ISAM pool | var(*LIST).SIZE | I | <integer 32..32767> | |
Task sequence number | var(*LIST).TSN(*LIST) | S | <c-string 1..4> | |
User group | var(*LIST).USER-GROUP | S | <c-string 1..8> | |
User ID | var(*LIST).USER-ID | S | <c-string 1..8> | |
Write back the blocks buffered in the ISAM pool | var(*LIST).WRITE | S | *NO |
Examples
See the ADD-ISAM-POOL-LINK and CREATE-ISAM-POOL commands.