Nonstop Database, HiRDB Version 9 UAP Development Guide

[Contents][Index][Back][Next]

18.10 Supported client environment definitions

The table below lists the client environment definitions that can be specified with the JDBC driver. The numbers in the list correspond to the numbers of the individual environment variables in 6.6.4 Environment definition information.

Table 18-81 Client environment variables that can be specified with the JDBC driver

No. Environment variable name Corresponding system property#1 Function Environment variable type
1 PDHOST HiRDB_for_Java_PDHOST Specifies the host name of the HiRDB server to be connected. System configuration
2 PDNAMEPORT HiRDB_for_Java_PDNAMEPORT Specifies the port number of the HiRDB server.
3 PDFESHOST HiRDB_for_Java_PDFESHOST Specifies the host name of the front-end server.
4 PDSERVICEGRP HiRDB_for_Java_PDSERVICEGRP Specifies the server name of the single server or front-end server.
5 PDSRVTYPE HiRDB_for_Java_PDSRVTYPE Specifies the HiRDB server type.
6 PDSERVICEPORT HiRDB_for_Java_PDSERVICEPORT Specifies the port number for high-speed connection.
7 PDFESGRP HiRDB_for_Java_PDFESGRP Specifies a FES group to be connected when high-speed connection is used.
8 PDCLTRCVPORT HiRDB_for_Java_PDCLTRCVPORT Specifies the client receive port number.
9 PDCLTRCVADDR HiRDB_for_Java_PDCLTRCVADDR Specifies the IP address or host name of the client.
20 PDUSER HiRDB_for_Java_PDUSER Specifies the authorization identifier and password. In UNIX, this environment variable can be omitted. User execution environment
21 PDCLTAPNAME HiRDB_for_Java_PDCLTAPNAME Specifies UAP identification information (UAP identifier) of the UAP that accesses the HiRDB server.
24 PDDBLOG HiRDB_for_Java_PDDBLOG Specifies whether or not the database update log is to be retrieved when the UAP is executed.
25 PDEXWARN HiRDB_for_Java_PDEXWARN Specifies whether return codes with warnings are to be accepted from the server.
26 PDSUBSTRLEN HiRDB_for_Java_PDSUBSTRLEN Specifies the maximum number of bytes representing one character.
30 PDCLTGRP HiRDB_for_Java_PDCLTGRP Specifies a client group name when the connection frame guarantee facility for client groups is used.
32 PDAUTORECONNECT HiRDB_for_Java_PDAUTORECONNECT Specifies whether or not the automatic reconnect facility is to be used.
33 PDRCCOUNT HiRDB_for_Java_PDRCCOUNT Specifies the number of times the CONNECT statement is retried by the automatic reconnect facility.
34 PDRCINTERVAL HiRDB_for_Java_PDRCINTERVAL Specifies the CONNECT retry interval at which the automatic reconnect facility executes reconnect processing.
35 PDUAPENVFILE HiRDB_for_Java_PDUAPENVFILE Specifies the UAP environment definition file that defines the execution environment if the UAP is to be executed in a separate environment.
36 PDDBBUFLRU HiRDB_for_Java_PDDBBUFLRU Specifies whether the LRU method is to be applied to processing when a page accessed by the UAP is cached to the global buffer.
37 PDHATRNQUEUING HiRDB_for_Java_PDHATRNQUEUING Specifies that the client does not use the transaction queuing facility.
38 PDCLTBINDLOOPBACKADDR HiRDB_for_Java_PDCLTBINDLOOPBACKADDR Specifies whether bind() is to be executed at a loopback address when a receive port to be used for communication with the HiRDB server is created.
48 PDCWAITTIME HiRDB_for_Java_PDCWAITTIME Specifies the maximum time that the HiRDB client waits for a response from the HiRDB server after sending a request to the HiRDB server. System monitoring
49 PDSWAITTIME HiRDB_for_Java_PDSWAITTIME Specifies the maximum time that the HiRDB server waits for the next request from the HiRDB client to arrive after returning a response to the previous request from the HiRDB client.
This function monitors the time during transaction processing.
50 PDSWATCHTIME HiRDB_for_Java_PDSWATCHTIME Specifies the maximum time that the HiRDB server waits for the next request from the HiRDB server to arrive after returning a response to the previous request from the HiRDB client.
This function monitors the time other than the transaction processing time.
51 PDCWAITTIMEWRNPNT HiRDB_for_Java_PDCWAITTIMEWRNPNT Specifies the output timing of the SQL runtime warning information file when the SQL runtime warning output facility is used. The output timing is specified as a percentage of the maximum time that the HiRDB client waits, or as an amount of time.
55 PDNBLOCKWAITTIME HiRDB_for_Java_PDNBLOCKWAITTIME Specifies the connection establishment monitoring time in nonblock mode when monitoring is performed for completion of the connection between the HiRDB server and the client.
56 PDCONNECTWAITTIME HiRDB_for_Java_PDCONNECTWAITTIME Specifies the maximum time that the HiRDB client waits for a response from the HiRDB server when it connects with the HiRDB server.
57 PDCLTPATH HiRDB_for_Java_PDCLTPATH Specifies the storage directory for the SQL trace file and client error log file created by the HiRDB client. Troubleshooting
58 PDSQLTRACE#2 HiRDB_for_Java_PDSQLTRACE Specifies the size (bytes) of the SQL trace file into which SQL trace information for the UAP is to be output.
61 PDPRMTRC HiRDB_for_Java_PDPRMTRC Specifies whether parameter information and retrieval data are to be output in the SQL trace information.
62 PDPRMTRCSIZE HiRDB_for_Java_PDPRMTRCSIZE Specifies the maximum data length of the parameter information and retrieval data to be output in the SQL trace information.
64 PDUAPREPLVL HiRDB_for_Java_PDUAPREPLVL Specifies output information for UAP statistical reports.
65 PDREPPATH HiRDB_for_Java_PDREPPATH Specifies whether UAP statistical report files are to be output to a different directory from the directory specified by PDCLTPATH.
66 PDTRCPATH HiRDB_for_Java_PDTRCPATH Specifies the storage directory for dynamic SQL trace files.
68 PDSQLTEXTSIZE HiRDB_for_Java_PDSQLTEXTSIZE Specifies the size of the SQL statement to be output to the SQL trace.
70 PDRCTRACE HiRDB_for_Java_PDRCTRACE Specifies the size of the output file for the UAP reconnect trace information.
71 PDWRTLNPATH HiRDB_for_Java_PDWRTLNPATH Specifies the storage directory for files to which value expression values of WRITE LINE statements are to be output.
72 PDWRTLNFILSZ HiRDB_for_Java_PDWRTLNFILSZ Specifies the maximum size of the files to which value expression values of WRITE LINE statements are to be output.
73 PDWRTLNCOMSZ HiRDB_for_Java_PDWRTLNCOMSZ Specifies the total size of the value expression values in WRITE LINE statements.
78 PDVWOPTMODE HiRDB_for_Java_PDVWOPTMODE Specifies whether the access path information file is to be retrieved. Access path information file for the access path display utility
82 PDSTJTRNOUT HiRDB_for_Java_PDSTJTRNOUT Specifies whether UAP statistical information is to be output to a statistical log file for each transaction. Output unit for UAP statistical information
83 PDLOCKLIMIT HiRDB_for_Java_PDLOCKLIMIT Specifies the maximum number of lock requests that a UAP can issue to one server. Lock
84 PDDLKPRIO HiRDB_for_Java_PDDLKPRIO Specifies the deadlock priority value of the UAP.
85 PDLOCKSKIP HiRDB_for_Java_PDLOCKSKIP Specifies whether an unlocked conditional search is to be performed.
86 PDFORUPDATEEXLOCK HiRDB_for_Java_PDFORUPDATEEXLOCK Specifies whether WITH EXCLUSIVE LOCK is to be applied to the lock option of SQL statements in which the FOR UPDATE clause is specified (or assumed).
87 PDISLLVL HiRDB_for_Java_PDISLLVL Specifies the data guarantee level of an SQL statement SQL-related
88 PDSQLOPTLVL HiRDB_for_Java_PDSQLOPTLVL Specifies optimization methods (SQL optimization options) for determining the most efficient access path by taking the database status into consideration.
89 PDADDITIONALOPTLVL HiRDB_for_Java_PDADDITIONALOPTLVL Specifies optimization methods (SQL extension optimizing methods) for determining the most efficient access path by taking the database status into consideration.
90 PDHASHTBLSIZE HiRDB_for_Java_PDHASHTBLSIZE Specifies the hash table size when hash join, subquery hash execution is applied in SQL optimization.
91 PDDFLNVAL HiRDB_for_Java_PDDFLNVAL Specifies whether a default value is to be set into an embedded variable when table data is to be fetched into the embedded variable and the fetched value is a null value.
92 PDAGGR HiRDB_for_Java_PDAGGR Specifies the maximum number of groups allowed in each server so that the memory size used in GROUP BY processing can be determined.
93 PDCMMTBFDDL HiRDB_for_Java_PDCMMTBFDDL When a definition SQL is to be executed in a transaction that is executing a data manipulation SQL, specifies whether the transaction is to be committed automatically before the definition SQL is executed.
94 PDPRPCRCLS HiRDB_for_Java_PDPRPCRCLS Specifies whether an open cursor is to be closed automatically if a PREPARE statement reuses the SQL identifier that is using that open cursor.
96 PDDDLDEAPRPEXE HiRDB_for_Java_PDDDLDEAPRPEXE Ignores the preceding transaction's preprocessing results and executes definition transactions.
97 PDDDLDEAPRP HiRDB_for_Java_PDDDLDEAPRP Specifies whether definition information of a table being used by a closed holdable cursor can be changed by another UAP between transactions.
98 PDLCKWAITTIME HiRDB_for_Java_PDLCKWAITTIME Specifies the maximum amount of time the HiRDB client is to monitor for release of a lock request, beginning when the lock request is placed in wait status.
100 PDDELRSVWDFILE HiRDB_for_Java_PDDELRSVWDFILE Specifies the name of the SQL reserved word deletion file when the SQL reserved word deletion facility is used.
101 PDHJHASHINGMODE HiRDB_for_Java_PDHJHASHINGMODE Specifies the hashing method when application of hash join, subquery hash execution is selected as the SQL extension optimizing option.
102 PDCALCMDWAITTIME HiRDB_for_Java_PDCALCMDWAITTIME Specifies the maximum amount of time the HiRDB client is to wait for termination of a command executed by the CALL COMMAND statement or a utility, beginning when command execution starts.
103 PDSTANDARDSQLSTATE HiRDB_for_Java_PDSTANDARDSQLSTATE Specifies whether the details of the SQLSTATE value are to be displayed.
104 PDBLKF HiRDB_for_Java_PDBLKF Specifies the number of rows to be sent in one transfer when the HiRDB server transfers retrieval results to the HiRDB client. Block transfer facility
105 PDBINARYBLKF HiRDB_for_Java_PDBINARYBLKF Specifies whether the block transfer facility is to be applied when a table with a BINARY-type selection expression with a defined length exceeding 32,00 bytes is searched.
106 PDBLKBUFFSIZE HiRDB_for_Java_PDBLKBUFFSIZE Specifies the size of the server-client communication buffer used by the block transfer facility.
113 PDDBACCS HiRDB_for_Java_PDDBACCS When the inner replica facility is being used and an RDAREA that is not the current RDAREA is to be accessed, specifies that RDAREA's generation number. Inner replica facility
114 PDDBORGUAP HiRDB_for_Java_PDDBORGUAP Specifies whether to execute a UAP on the original RDAREA that is in online reorganization hold status. Updatable online reorganization
115 PDSPACELVL HiRDB_for_Java_PDSPACELVL Specifies the space conversion level for data storage, comparison, and search processing. Data space conversion
116 PDCLTRDNODE HiRDB_for_Java_PDCLTRDNODE Specifies the identifier of the XDM/RD E2 database to be connected when the XDM/RD E2 connection facility is used. XDM/RD E2 connection facility
119 PDCNSTRNTNAME HiRDB_for_Java_PDCNSTRNTNAME Specifies the position of the constraint name definition when a referential or check constraint is defined. Referential and check constraints
120 PDBESCONHOLD HiRDB_for_Java_PDBESCONHOLD Specifies whether the BES connection holding facility is to be used. BES connection holding facility
121 PDBESCONHTI HiRDB_for_Java_PDBESCONHTI Specifies the BES connection holding period when the BES connection holding facility is used.
129 PDPLGIXMK HiRDB_for_Java_PDPLGIXMK Specifies whether delayed batch creation of plug-in indexes is to be used. Plug-ins
130 PDPLUGINNSUB HiRDB_for_Java_PDPLUGINNSUB For details, see the manual for the target plug-in.
131 PDPLGPFSZ HiRDB_for_Java_PDPLGPFSZ Specifies the initial size of the index information file for delayed batch creation of plug-ins.
132 PDPLGPFSZEXP HiRDB_for_Java_PDPLGPFSZEXP Specifies the extension size of the index information file for delayed batch creation of plug-ins.
133 PDJDBFILEDIR -- Specifies the log file output destination for Exception trace logs in the Type4 JDBC driver. JDBC driver
134 PDJDBFILEOUTNUM -- Specifies the number of Exception trace logs that the Type4 JDBC driver outputs to the log file.
135 PDJDBONMEMNUM -- Specifies the number of Exception trace logs acquired in memory by the Type4 JDBC driver.
136 PDJDBTRACELEVEL -- Specifies the trace acquisition level for Exception trace logs in the Type4 JDBC driver.
137 PDXDSHOST -- Specifies the host name of the XDS to be connected. XDS client only
138 PDXDSPORT -- Specifies the port number of the XDS to be connected.
139 PDXVWOPT -- Specifies whether the access path of the SQL statement used to access a table to be expanded to the memory database is to be output.

Legend:
--: Not applicable

#1
You can use the system properties to specify the same connection information as in the client environment definitions. For details about the specification priorities, see 18.11 Connection information priorities. For details about the system property settings for connection information related to trace logs, see 18.15.1(2) Setup for acquisition of the Exception trace log.
Note that for an internal driver, system property specifications are ignored.

#2
The name of the SQL trace file is pdjsqlxxxxxxxx_ppppp_1.trc or pdjsqlxxxxxxxx_ppppp_2.trc.
xxxxxxxx: Name of connected server (up to eight characters)
ppppp: Receive port number (5 characters) at the client side
This format is used even when the SQL trace file is acquired by the UAP statistical report facility (PDREPPATH specification) or by the SQL trace dynamic acquisition facility (PDTRCPATH specification). However, if the SQL trace file is acquired before connection to the FES or SDS, the file name becomes pdjsql1.trc or pdjsql2.trc.

Using a HiRDB.INI file to enable client environment variables
Client environment variables defined in a HiRDB.INI file (that is stored in any desired directory) can be applied in any of the following cases:
  • HiRDB_for_Java_HiRDB_INI is specified in the Properties argument of DriverManager.getConnection.
  • HiRDB_INI is specified in the URL of DriverManager.getConnection.
  • The absolute path of the HiRDB_INI file is specified in the setHiRDBINI method of a DataSource interface.
For details about the specification priorities, see 18.11 Connection information priorities.
Note that for an internal driver, specifications in the HiRDB.INI file are ignored.