2.45 pdlistls (Display list definition information)

Organization of this section
(1) Function
(2) Executor
(3) Format
(4) Options
(5) Rules
(6) Notes
(7) Output format

(1) Function

The pdlistls command displays the list definition information.

(2) Executor

HiRDB administrator

(3) Format

pdlistls [-d {1|2}]
       [-u list-owner's-name]
       [-t list-base-table-owner's-name,list-base-table-name]
        [-W execution-monitoring-interval]

(4) Options

(a) -d {1|2}

Specifies the list definition information to be displayed.

-d optionInformation to be displayed
Values of system definitions#List owner's nameName of listNumber of listsBase table's owner's nameName of base table
1DD--D----
2DDD--DD
Legend:
D: Displayed
--: Not displayed
#: Indicates the values of the pd_max_list_users and pd_max_list_count operands.
(b) -u list-owner's-name ~ <identifier> ((1-30))

To display only the specified list owner's list definition information, specify the name of the list owner with this option. If this option is omitted, the system assumes all list owners.

If the list owner's name is not enclosed between double quotation marks ("), it is treated as all uppercase letters.

(c) -t list-base-table-owner's-name, list-base-table-name

To display only the specified list base table's list definition information, specify the list base table's owner's name and list base table's name with this option.

A list base table's owner's name can be expressed as 1 to 30 characters and a list base table's name can be expressed as an identifier consisting of 1-30 characters. If the list base table owner's name or the list base table name is not enclosed between double quotation marks ("), it is treated as all uppercase letters. If it contains a space, enclose the entire character string between double quotation marks (").

(d) -W execution-monitoring-interval ~<unsigned integer> ((0 to 3600))

Specifies (in minutes) the monitoring interval when the execution time of the pdlistls command is to be monitored. For guidelines on the value to specify and details about the resulting operation, see the description of the pd_cmd_exec_time operand in the system common definition in the manual HiRDB Version 9 System Definition.

If 0 is specified in this option, the command's execution time is not monitored.

If this option is omitted, the value of the pd_cmd_exec_time operand in the system common definition takes effect.

(5) Rules

  1. You can execute the pdlistls command only when HiRDB is active.
  2. Execute the pdlistls command on the server machine containing the single server or the server machine where the system manager is located.

(6) Notes

  1. Return code 0 for the pdlistls command indicates normal termination, and return code 8 indicates abnormal termination.

(7) Output format

(a) -d 1 specified

STATE OD LIST  DEFINITION
#        OWNER NAME    LIST COUNT
[aa...a  bb...b        cc...c]
          :
[NOT FOUND dd...d]
pd_max_list_users : ee...e
pd_max_list_count : ff...f

Explanation
aa...a
Sequence number displayed
bb...b
List owner's name
cc...c
Number of segments in the list
dd...d
Information that was not found
-t option specified: TABLE
-u option specified: USER
ee...e
Value of the pd_max_list_users operand in the system definitions (for the single server or dictionary server)
ff...f
Value of the pd_max_list_count operand in the system definitions (for the single server or dictionary server)
(b) -d 2 specified

STATE OD LIST  DEFINITION
#        OWNER NAME  LIST NAME  BASE TABLE OWNER  BASE TABLE NAME
[aa...a  bb...b      cc...c     dd...d            ee...e]
          :
[NOT FOUND ff...f]
pd_max_list_users : gg...g
pd_max_list_count : hh...h

Explanation
aa...a
Sequence number displayed
bb...b
List owner's name
cc...c
Name of the list
dd...d
List base table's owner's name
ee...e
List base table's name
ff...f
information that was not found
-t option specified: TABLE
-u option specified: USER
gg...g
Value of the pd_max_list_users operand in the system definitions (for the single server or dictionary server)
hh...h
Value of the pd_max_list_count operand in the system definitions (for the single server or dictionary server)