1.2 Descriptive notation
(1) Format
This manual explains messages in the following format:
KFPX1 n1 n2 n3 n4 n5 -I Y TYPEx
message-text
- Explanation of the message:
S: Action taken by HiRDB once the message has been issued.
P: Action that should be taken by the programmer.
O: Action that should be taken by the operator. - Action
- Action that should be taken by the HiRDB administrator.
- Note
- The phrase Contact the customer support center in a message explanation means that the system administrator needs to contact a Hitachi customer service representative.
(2) Message ID codes
The following explains the codes used in the message ID:
- KFP: Code indicating that the message was issued by the HiRDB system.
- X1: Code identifying the message management source:
- A: Message concerning an SQL statement (this message is also output following the execution of a utility or command)
- C: Windows-specific message
- D: Dictionary manager message
- H: Database-related message
- I: HiRDB file system message
- J: JDBC drive message
- K: Utility-related message (statistics analysis utility or database condition analysis utility)
- L: Utility-related message (database load utility or database reorganization utility)
- M: MIB-related message
- N: Utility-related message (optimization or JP1/NETM/Audit Log Output)
- O: OS library message
- R: Utility-related message (database recovery utility)
- S: System manager message
- T: Updatable online reorganization messages
- U: Utility-related message (any utility)
- X: Utility-related message (environment definition)
- Y: Plug-in related message
- Z: Client message
- n1 to n5: Message number
- i: Message severity code:
- E: Error message (indicates that the error disabled a function)
- W: Warning message (indicates a warning concerning resource utilization status, etc., or indicates that a command specification error was detected but processing continued using the default value)
- I: Information message (indicates an operating status that does not apply to E or W)
- Q: Response request message (indicates that the system is waiting for the user's response to the displayed message)
- Y: Message output destination
- If a message has multiple output destinations, all the destinations to which output may be directed are shown, separated by the plus sign (+). L denotes output to the standard output device when the pdcat command or the real-time output function is used.
- KFPJ messages are collected into getMessage(), which is an SQLException object of JDBC driver.
- A: SQLCA (SQL communication area)#1
- D: Message dialog
- E: Standard error output#6
- J: JP1 event database#2
- L: Message log file and event log (in UNIX, syslogfile)#3, #4, #5
- P: XDS message log file
- R: Error log file and client error log file#7
- S: Standard output#6
- #1
- The output destination of KFPA messages output when a utility or a command is executed is E or L.
- #2
- This is output when the system is linked to JP1.
- #3
- In the following situations, either no message is output or the message is output to the event log in the host where the message output source unit is located (in UNIX, to syslogfile). The message might also be output to the standard error output of the host where the message output source unit is located.
- When an error occurs on a single server or on a unit with a system manager
- After abnormal termination and before restart of the message log server
- When a standby system is used
- When HiRDB is starting
- #4
- Messages output by operation commands or utilities are output only to the event log (syslogfile in UNIX) of the host where the message output source unit is located, and are not output to the message log file.
- #5
- Messages output by XDS are output to the following output destinations, instead of the message log file:
- syslogfile
- XDS message log file
- However, note that while XDS is starting, messages might not be output to syslogfile or the XDS message log file.
- #6
- Messages output by XDS are output to the following output destinations, instead of standard error output or standard output:
- XDS log file
- XDS message log file
- However, note that while XDS is starting, messages might not be output to the XDS message log file.
- #7
- Messages output by XDS that include KFPZ in their message ID are output to the following output destinations, instead of the error log file and the client error log file:
- XDS log file
- syslogfile
- XDS message log file
- However, note that while XDS is starting, messages might not be output to syslogfile or the XDS message log file.
- TYPEx:
- Message KFPJ can include two types of messages sharing the same message ID: Type 2 JDBC driver messages and Type 4 JDBC driver messages. If a message contains both Type 2 and Type 4 messages, both messages are listed. When two types of messages exist, and only when two types exist, the messages are represented as follows so that they can be distinguished:
- TYPE2: Indicates a Type 2 JDBC driver message.
- TYPE4: Indicates a Type 4 JDBC driver message.
- In a Type 4 JDBC driver message, the message text can be followed by the name of the class that generated the message, and the name of the method by which the message was generated, in the following format:
KFPxn1n2n3n4n5-i message-text [aa....aa.bb....bb]
- aa....aa: Name of the class that generated the message
- bb....bb: Name of the method by which the message was output
(3) Explanation of message text
The message text explains the message or event, as well as embedded characters.
- The following notations are used in message text:
- { }: Only one of the text items enclosed in braces is displayed; the text items are delimited by the vertical bar (|).
Example: {authorization-identifier|password}
- [ ]: A text item enclosed in square brackets may not be displayed.
(4) Notes on messages
- Relationships between message IDs and SQLCODE codes
The following table shows the relationships between message IDs and the SQLCODE codes in the SQL Communications Area (SQLCA) used by the UAP:
Message ID | SQLCODE |
---|
KFPA11nnn | -nnn |
KFPA19nnn | -1nnn |
KFPA12nnn | +nnn |
- Notes on the UNIX edition
For the following return code, the HiRDB system does not output a message; only the error code is returned to SQLCODE:
The SQLCODE description is set at the message ID location.
- About query numbers
The term query number is used in the message descriptions.
A query number is a number assigned to each query specification, or subquery, appearing in an SQL statement, and serves to identify each query by number in the SQL statement. Within a subquery, the query number will be 2 or greater. Parts of the statement that are not contained in a query specification, or subquery, will have a query number of 1.