Nonstop Database, HiRDB Version 9 UAP Development Guide
The table below lists the client environment definitions. The numbers in the list correspond to the individual environment definition numbers used in 6.6.4 Environment definition information.
Table 6-26 Client environment definitions
No. | Environment variable | Function | Category |
---|---|---|---|
1 | PDHOST | Specifies the host name of the HiRDB system to be connected. | System configuration#3 |
2 | PDNAMEPORT | Specifies the port number of the HiRDB system. | |
3 | PDFESHOST | Specifies the host name of the front-end server. | |
4 | PDSERVICEGRP | Specifies the server name of the single server or front-end server. | |
5 | PDSRVTYPE | Specifies the HiRDB server type. | |
6 | PDSERVICEPORT | Specifies the port number for high-speed connection. | |
7 | PDFESGRP | Specifies the FES group to which connection is to be established when a high-speed connection is used. | |
8 | PDCLTRCVPORT | Specifies the receive port number of the client. | |
9 | PDCLTRCVADDR | Specifies the IP address or host name of the client. | |
10 | PDTMID | Specifies a unique identifier for each OLTP when multiple OLTPs access one HiRDB server. | Clients that use an X/Open-compliant API in an OLTP environment#1 |
11 | PDXAMODE | Specifies whether the transaction transfer function is to be used when the HiRDB client is linked with an OLTP system. | |
12 | PDTXACANUM | Specifies the maximum number of transactions to be executed simultaneously from a UAP that uses an X/Open-compliant API. | |
13 | PDXARCVWTIME | Specifies the wait time if a transaction cannot be recovered. | |
14 | PDXATRCFILEMODE | Specifies the format of each trace file name in the connection mode that uses the X/Open-compliant API. | |
15 | PDXAAUTORECONNECT | Specifies whether connection is to be re-established automatically when TP1/EE is linked. | |
16 | HiRDB_PDHOST | Specifies the host name of the HiRDB server to be connected. | |
17 | HiRDB_PDNAMEPORT | Specifies the port number of the HiRDB server. | |
18 | HiRDB_PDTMID | Specifies a unique identifier for each OLTP when multiple OLTPs access one HiRDB server. | |
19 | HiRDB_PDXAMODE | Specifies whether the transaction transfer function is to be used when the HiRDB client is linked with an OLTP system. | |
20 | PDUSER#4 | Specifies the authorization identifier and password. This environment variable can be omitted in the UNIX environment. | User execution environment |
21 | PDCLTAPNAME | Specifies UAP identification information (UAP identifier) for accessing the HiRDB server. | |
22 | PDCLTLANG | Specifies the character code classification used in the descriptions of UAPs to be processed by the preprocessor. | |
23 | PDLANG | Specifies that the character code used when the UAP is executed is either Unicode or EUC Chinese kanji code. In the Linux edition, specifies that SJIS is used as the character code. | |
24 | PDDBLOG | Specifies whether the database update log is to be collected when a UAP is executed. | |
25 | PDEXWARN | Specifies whether return codes with warnings are to be accepted from the server. | |
26 | PDSUBSTRLEN | Specifies the maximum number of bytes used to represent one character. | |
27 | PDCLTCNVMODE | Specifies whether character codes are to be converted if the HiRDB server and the HiRDB client use different character code classifications. | |
28 | PDCLTGAIJIDLL | Specifies the name of the user-defined external character conversion DLL file. | |
29 | PDCLTGAIJIFUNC | Specifies the name of the user-defined external character conversion function. | |
30 | PDCLTGRP | Specifies a client group name when the connection frame guarantee facility for client groups is used. | |
31 | PDTCPCONOPT | Specifies that the number of TCP ports used in server connection processing is to be reduced when the client connects to a HiRDB server with a version of 06-02 or later. | |
32 | PDAUTORECONNECT | Specifies whether the automatic reconnect facility is to be used. | |
33 | PDRCCOUNT | Specifies the number of times the CONNECT statement is to be retried by the automatic reconnect facility. | |
34 | PDRCINTERVAL | Specifies the retry interval for CONNECT statement execution by the automatic reconnect facility. | |
35 | 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 | Specifies whether the LRU method is used for caching in global buffer pages accessed by the UAP. | |
37 | PDHATRNQUEUING | Specifies that the client is not using the transaction queuing facility. | |
38 | PDCLTBINDLOOPBACKADDR | Specifies whether a loopback address is to be used for bind() when the receive port used for communication with the HiRDB server is created. | |
39 | PDASTHOST | Specifies the host name of HiRDB Control Manager - Agent to be connected when the UAP is executed. | Command execution from a UAP |
40 | PDASTPORT | Specifies the port number of Control Manager - Agent to be connected when the UAP is executed. | |
41 | PDSYSTEMID | Specifies the HiRDB identifier of the HiRDB server managed by HiRDB Control Manager - Agent to be connected when the UAP is executed. | |
42 | PDASTUSER | Specifies the user name and password for the OS that will run commands. | |
43 | PDCMDWAITTIME | Specifies the maximum time the client is to wait from the time it sends a request to HiRDB Control Manager - Agent until a response is returned. | |
44 | PDCMDTRACE | Specifies the size of the command trace file when a file is output during UAP execution. | |
45 | PDIPC | Specifies the communication method between processes. | Inter-process memory communication facility |
46 | PDSENDMEMSIZE | Specifies the data storage area size when the client sends data to the server while the inter-process memory communication facility is used. | |
47 | PDRECVMEMSIZE | Specifies the data storage area size when the client receives data from the server while the inter-process memory communication facility is used. | |
48 | PDCWAITTIME#4 | Specifies the maximum time that the HiRDB client waits for a response to be returned after issuing a request to the HiRDB server. | System monitoring |
49 | PDSWAITTIME#4 | 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 | 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 outside transaction processing. | |
51 | PDCWAITTIMEWRNPNT | Specifies the output timing of the SQL runtime warning information file when the SQL runtime running output facility is used. The output timing is specified as a percentage of the maximum wait time of the HiRDB client or as a time. | |
52 | PDKALVL | Specifies whether the facility that sends packets regularly from the HiRDB client to the HiRDB server is to be used. | |
53 | PDKATIME | Specifies the interval for sending packets regularly from the HiRDB client to the HiRDB server. | |
54 | PDTIMEDOUTRETRY | Specifies the number of times the connect() system call is to be retried if an error occurs in the connect() system call executed when the HiRDB client connects with the HiRDB server. | |
55 | PDNBLOCKWAITTIME | Specifies the connection establishment monitoring time in nonblock mode when completion of the connection between the HiRDB server and client is monitored. | |
56 | PDCONNECTWAITTIME | Specifies the maximum wait time that the HiRDB client waits from a response from the HiRDB server during connection with the HiRDB server. | |
57 | PDCLTPATH | Specifies the storage directory for the SQL trace file and client error log file created by the HiRDB client. | Trouble-shooting |
58 | PDSQLTRACE | Specifies the size of the SQL trace file (in byte units) into which the SQL trace of the UAP is to be output. | |
59 | PDUAPERLOG | Specifies the size of the client error log file (in bytes) to which UAP error logs are to be output. | |
60 | PDERRSKIPCODE | Specifies specific client error logs that are not to be output. | |
61 | PDPRMTRC | Specifies whether parameter information and retrieval data is to be output to the SQL trace information. | |
62 | PDPRMTRCSIZE | Specifies the maximum length of the parameter information and retrieval data to be output to the SQL trace information. | |
63 | PDTRCMODE | Specifies whether troubleshooting information other than SQL trace information is to be output. | |
64 | PDUAPREPLVL | Specifies output information for UAP statistical reports. | |
65 | PDREPPATH | Specifies the output directory for UAP statistical reports when these files are to be created in a directory different from the one specified by PDCLTPATH. | |
66 | PDTRCPATH | Specifies the storage directory for dynamic SQL trace files. | |
67 | PDSQLTRCOPENMODE | Specifies the open mode for the SQL trace file when PDREPPATH is specified. | |
68 | PDSQLTEXTSIZE | Specifies the size of the SQL statement to be output to the SQL trace information. | |
69 | PDSQLEXECTIME | Specifies whether the SQL runtime is to be output to the SQL trace information. | |
70 | PDRCTRACE | Specifies the size of the file that outputs the UAP reconnect trace. | |
71 | PDWRTLNPATH | Specifies the storage directory for files to which value expression values of WRITE LINE statements are to be output. | |
72 | PDWRTLNFILSZ | Specifies the maximum size of the files to which value expression values of WRITE LINE statements are to be output. | |
73 | PDWRTLNCOMSZ | Specifies the total size of the value expression values in WRITE LINE statements. | |
74 | PDUAPEXERLOGUSE | Specifies whether the facility for output of extended SQL error information is to be used. | |
75 | PDUAPEXERLOGPRMSZ | Specifies the maximum data length for the parameter information to be output to the client error log file and to the SQL error report file when the facility for output of extended SQL error information is used. | |
76 | PDARYERRPOS | Specifies whether the value indicating an erroneous array element is to be set in the SQL Communications Area when update processing using arrays results in an error. | |
77 | PDDNDPTRACE | Specifies the file size for method traces output by the HiRDB.NET data provider supporting ADO.NET 2.0. | |
78 | PDVWOPTMODE | Specifies whether or not the access path information file is to be obtained. | Access path display utility |
79 | PDTAAPINFPATH | Specifies the output destination directory when the access path information file is output to the HiRDB client side. The file is not output without this specification. | Access path information file for HiRDB SQL Tuning Advisor |
80 | PDTAAPINFMODE | Specifies the file name format of the access path information file when it is output to the HiRDB client side. | |
81 | PDTAAPINFSIZE | Specifies the file size of the access path information file when it is output to the HiRDB client side. | |
82 | PDSTJTRNOUT | Specifies whether UAP statistical information is to be output to the client side. | Output unit of UAP statistical information |
83 | PDLOCKLIMIT | Specifies the maximum number of lock requests that a UAP can issue to one server. | Lock control |
84 | PDDLKPRIO | Specifies the deadlock priority value of a UAP. | |
85 | PDLOCKSKIP | Specifies whether search using condition evaluation with no lock is to be performed. | |
86 | PDFORUPDATEEXLOCK | Specifies whether WITH EXCLUSIVE LOCK is to be applied to the lock option of the SQL statement in which the FOR UPDATE clause was specified (or assumed). | |
87 | PDISLLVL | Specifies the data guarantee level for SQL statements. | SQL-related |
88 | PDSQLOPTLVL | Specifies the optimization method (SQL optimization option) for determining the most efficient access path in consideration of the database status. | |
89 | PDADDITIONALOPTLVL | Specifies the optimization method (SQL extension optimizing option) for determining the most efficient access path in consideration of the database status. | |
90 | PDHASHTBLSIZE | Specifies the hash table size to be used when hash join or subquery hash execution is applied in SQL optimization. | |
91 | PDDFLNVAL | When table data is to be fetched into an embedded variable, specifies whether a default value is to be set into the embedded variable if the fetched value is a null value. | |
92 | 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 | Specifies whether a transaction that has that executed a data manipulation SQL statement must execute commit processing automatically before it executes a definition SQL statement. | |
94 | PDPRPCRCLS | Specifies whether an open cursor is to be closed automatically if the SQL identifier being used by the open cursor is used again by the PREPARE statement. | |
95 | PDAUTOCONNECT | Specifies whether autoconnection is to be executed if an SQL statement is executed while the client is not connected to HiRDB. | |
96 | PDDDLDEAPRPEXE | Specifies that the preceding transaction's preprocessing results are to be ignored and the definition transaction is to be executed. | |
97 | PDDDLDEAPRP | Specifies whether the definition information of a table being used by a closed holdable cursor can be changed by another UAP between transactions. | |
98 | PDLCKWAITTIME | Specifies the maximum amount of time the HiRDB client is to monitor a lock request for the lock to be released, beginning when the lock request is placed on wait status. | |
99 | PDCURSORLVL | Specifies whether an open/close cursor request is to be sent automatically to the HiRDB server when a search is performed using the cursor. | |
100 | PDDELRSVWDFILE | Specifies the name of the SQL reserved word deletion file when the SQL reserved word deletion file is used. | |
101 | PDHJHASHINGMODE | Specifies the hashing method when Apply hash join, subquery hash execution is selected as the SQL extension optimizing option. | |
102 | 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 the command's execution starts. | |
103 | PDSTANDARDSQLSTATE | Specifies whether the details of the SQLSTATE value are to be displayed. | |
104 | PDBLKF | Specifies the number of rows to be sent by a single transfer process when the HiRDB server transfers search results to the HiRDB client. | Block transfer facility |
105 | PDBINARYBLKF | Specifies whether the block transfer facility is to be applied when a table having a selection expression for BINARY-type data with a defined length of 32,001 bytes or more is searched. | |
106 | PDBLKBUFFSIZE | Specifies the size of the server-client communication buffer used by the block transfer facility. | |
107 | PDBLKFUPD | Specifies whether the block transfer facility is to be suppressed when an extended cursor is used for retrieval for a query with FOR UPDATE specified. | |
108 | PDBLKFERRBREAK | Specifies when an error is to be returned to the UAP if an implicit rollback occurs while multiple rows are being acquired by the block transfer facility. | |
109 | PDNODELAYACK | Specifies whether immediate acknowledgement is to be used. This environment variable is limited to the AIX version. | HiRDB communication processing |
110 | PDBINDRETRYCOUNT | Specifies the retries count when EADDRINUSE is returned for a bind system call in a UNIX domain. | |
111 | PDBINDRETRYINTERVAL | Specifies the retry interval when EADDRINUSE is returned for a bind system call in a UNIX domain. | |
112 | PDCLTSIGPIPE | Specifies whether the HiRDB client's signal handler is to be set for the SIGPIPE signal. | |
113 | PDDBACCS | Specifies the generation number of an RDAREA if an RDAREA that is not the current RDAREA is to be accessed while the inner replica facility is being used. | Inner replica facility |
114 | PDDBORGUAP | Specifies that the UAP is to be executed for the original RDAREA for online reorganization hold. | Updatable online reorganization |
115 | PDSPACELVL | Specifies the space conversion level for data storage, comparison, and retrieval. | Space conversion for data |
116 | 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 |
117 | PDTP1SERVICE | Specifies whether OpenTP1 service names are to be reported to XDM/RD E2 when the XDM/RD E2 connection facility is used. | |
118 | PDRDCLTCODE | Specifies the character code classification that the client uses when the XDM/RD E2 connection facility is used. | |
119 | PDCNSTRNTNAME | Specifies the position of the constraint name definition when a referential or check constraint is defined. | Referential or check constraint |
120 | PDBESCONHOLD | Specifies whether the BES connection holding facility is to be used. | BES connection holding facility |
121 | PDBESCONHTI | Specifies the BES connection holding period when the BES connection holding facility is used. | |
122 | PDODBSTATCACHE | Specifies whether column information or index information that is collected the first time an ODBC function (SQLColumns() or SQLStatistics()) is issued is to be cached. | ODBC functions |
123 | PDODBESCAPE | Specifies whether the & ESCAPE character is to be specified for the pattern character string in a retrieval that uses a cataloging ODBC function. | |
124 | PDGDATAOPT | Specifies that the SQLGetData function of ODBC is to fetch data from columns, even if the data has already been fetched from those columns. | |
125 | PDODBLOCATOR | Specifies whether the locator facility is to be used to partition and retrieve data when a database access tool is used to retrieve BLOB-type or BINARY-type column data. The database access tools are the ODBC driver, the OLE DB provider, and the HiRDB.NET data provider. | |
126 | PDODBSPLITSIZE | Specifies the partition acquisition size when PDODBLOCATOR=YES is specified. | |
127 | PDODBCWRNSKIP | Specifies whether warnings are to be skipped when an ODBC connection is used. | |
128 | PDJETCOMPATIBLE | Specifies whether the ODBC 3.5 driver is to be operated in a mode that is compatible with Microsoft Access, rather than operating on the basis of the ODBC 3.5 specification. | |
129 | PDPLGIXMK | Specifies whether delayed batch creation of plug-in indexes is to be used. | Plug-ins |
130 | PDPLUGINNSUB#2 | For details, see the manual for the target plug-in. | |
131 | PDPLGPFSZ | Specifies the initial size of the index information file for delayed batch creation of plug-ins. | |
132 | PDPLGPFSZEXP | Specifies the extension size of the index information file for delayed batch creation of plug-ins. | |
133 | PDJDBFILEDIR | Specifies the file output destination of the Exception trace log using the Type4 JDBC driver. | JDBC driver |
134 | PDJDBFILEOUTNUM | Specifies the number of outputs to the Exception trace log file using the Type4 JDBC driver. | |
135 | PDJDBONMEMNUM | Specifies the number of acquired information items in the Exception trace log memory using the Type4 JDBC driver. | |
136 | PDJDBTRACELEVEL | Specifies the trace acquisition level of the Exception trace log using 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. |
All Rights Reserved. Copyright (C) 2011, Hitachi, Ltd.