HiRDB Datareplicator Version 8 Description, User's Guide and Operator's Guide
![[Contents]](FIGURE/CONTENT.GIF)
![[Glossary]](FIGURE/GLOSS.GIF)
![[Index]](FIGURE/INDEX.GIF)
![[Back]](FIGURE/FRONT.GIF)
5.8.3 Explanation of the operands
- hdsid=source-Datareplicator-identifier
~ <hexadecimal> ((00-FF)) <<00>>
If there are multiple target Datareplicators, specify the identifier of a target Datareplicator. You can omit this operand if there is only one target Datareplicator.
- hirdbusr=HiRDB-connection-authorization-identifier[/password]
<<value of the target HiRDB's PDUSER environment variable>>
Specify the authorization identifier and password to be used to establish connection with the target HiRDB.
- HiRDB-connection-authorization-identifier ~ <identifier of 1-8 characters>
Specify the authorization identifier to be used to establish connection with the target HiRDB. An attempt to establish connection by specifying an invalid authorization identifier will result in an error.
- /password ~ <symbolic name of 1-28 character>
Specify the password to be used to establish connection with the target HiRDB. An attempt to establish connection by specifying an invalid password will result in an error. If you omit /password, Datareplicator will establish connection with the target HiRDB without requiring a password.
In the UNIX edition, if you specify the asterisk (*) for the password, the target Datareplicator will issue to the standard input during startup a request for entry of a password; the entered password will be used to establish connection with the target HiRDB.
In the Windows edition, if you specify the asterisk (*) for the password, Datareplicator will establish connection with the target HiRDB without requiring a password.
It is not appropriate to enclose this operand's value in double quotation marks in order to make it case sensitive. When a value is enclosed in double quotation marks, an error results because each double quotation mark is handled as a part of the user ID or password.
- protocol1=tcp|osi
Specify the communications protocol to be used with the source system.
- tcp
- Use the TCP/IP protocol for communication.
- osi
- Use the OSI protocol for communication.
This operand is applicable only to the HP-UX edition of Datareplicator (excluding the IPF version).
- protocol2=tcp|osi
Specify a second communications protocol to be used with the source system. Datareplicator ignores this operand if the specified protocol is the same protocol specified in the protocol1 operand.
- tcp
- Use the TCP/IP protocol for communications.
- osi
- Use the OSI protocol for communications.
This operand is applicable only to the HP-UX edition of Datareplicator (excluding the IPF version).
- dsid001=data-linkage-identifier... dsid128=data-linkage-identifier
~ <hexadecimal ((00-FF)) or **>
Specify the source system data linkage identifiers that are to be subject to import processing. These data linkage identifiers must be unique in the import system definition.
If multiple data linkage identifiers are subject to data linkage, specify the dsid001 to dsid128 operands consecutively in ascending order beginning with dsid001. If they are not consecutive or in ascending order, Datareplicator uses only those operands that are specified consecutively in ascending order from the beginning.
When you specify ** in place of a data linkage identifier, Datareplicator assumes an absent number, in which case no data linkage occurs (no startup of a reception process or definition server process). You can specify ** in place of any number of data linkage identifiers; if you specify ** for all data linkage identifiers, Datareplicator assumes that no data linkage identifiers at all are specified.
In the case of the Windows Datareplicator, you can specify a maximum of 63 data linkage identifiers corresponding to import environment definition files. You cannot specify any of the dsid064 to dsid128 operands; specifying these operands will result in an error.
- refenv001="import-environment-definition-filename"... refenv128="import-environment-definition-filename"
~ <[pathname/]filename of 1-64 bytes>
Specify the filenames of the import environment definitions that define operating environments for import processing, as absolute or relative pathnames. If you specify a relative pathname, Datareplicator assumes $HDSPATH/relative-pathname as the absolute pathname. In this case, specify the pathname so that the final absolute pathname will not exceed 125 characters.
You must specify the refenv001 to refenv128 operands so that they correspond to the dsid001 to dsid128 operands. If there is no refenvxxx operand corresponding to a dsidxxx operand, an error results. On the other hand, if there is a refenvxxx operand but no corresponding dsidxxx operand, Datareplicator ignores that refenvxxx operand.
In the case of Windows Datareplicator, you can specify a maximum of 63 data linkage identifiers and corresponding import environment definition files. You cannot specify any of the refenv064 to refenv128 operands; specifying any of these operands will result in an error.
- hdsservice=service-name
~ <identifier of 1-64 characters> <<hirdbds>>
Specify the service name that was used to add the target Datareplicator's communication entry to the services file.
- reflect_tselector=T-selector
~ <even number of hexadecimal digits with a length of 2-64 digits>
This operand is required if you specify osi in the protocol1 or protocol2 operand. Specify the T-selector assigned to the source and target Datareplicators. You must specify the same T-selector at both the source and target systems. If the T-selector specified at the source system is a character string, specify its hexadecimal representation. This operand is applicable only to the HP-UX edition of Datareplicator (excluding the IPF version).
- hirdb_audit_trail=all | uoc | none_cont | none_stop
Specify whether an audit trail is to be collected if an operation subject to audit trail collection (audit event) occurs.
The import definition server process, import SQL process, and import UOC processes other than the CONNECT process are subject to collection of audit events. For import UOC processes, this operand is applicable only to an import information editing UOC routine that accesses HiRDB. If you use an import information editing UOC routine but do not collect an audit trail, make sure that you see 8.1.6(7) Notes when not collecting an import processing-related audit trail.
- all
- Collect an audit trail on the import Datareplicator's processing.
- uoc
- Collect an audit trail on the import information editing UOC routine's processing.
- none_cont
- Do not collect an audit trail. If the KFRB00864-W or KFRB03094-W message is issued from an import information editing UOC routine, resume processing with audit trail collection activated.
- none_stop
- Do not collect an audit trail. If the KFRB00865-E or KFRB03094-W message is issued from an import information editing UOC routine, stop the processing.
If you want to minimize the overhead of having import Datareplicator processing collect an audit trail, we recommend that you specify none_cont or none_stop.
- keepalive=true|false
Specify whether the keepalive option can be specified for the socket.
- true
- Specify the keepalive option.
- false
- Do not specify the keepalive option.
The keepalive operand is not applicable when osi is specified in the protocol1 or protocol2 operand.
- errfilesz=import-error-information-file-size
~ <unsigned integer> ((1-32767)) <<16>> (KB)
Specify the maximum size of an import error information file.
- syslogout=true|false
Specify whether the information in the import error information files is to be output also to the syslog file. If you are using JP1, you must output this information to the syslog file to implement automatic operation.
- true
- Output the information in the import error information files also to the syslog file.
- false
- Do not output the information in the import error information files to the syslog file.
- Note that the KFRB00501-I and FRB00505-I messages are still output to the syslog file even when false is specified.
- syslog_message_suppress=message-number[,message-number] ...
Specify the numbers of the messages whose output to the syslog file (event log for Windows) is to be suppressed.
- Specify a maximum of 64 message numbers.
- If you specify the same message number more than once, only the first specification of the number is effective.
- Datareplicator does not output any message specified in this operand, regardless of its significance level (E, W, I, or Q).
- Messages that are output only to the syslog file (or event log) are always output regardless of whether you specify this operand.
- dblocale={ sjis|euc|utf-8|unknown }
Specify the character code system to be used when update information sent from the source system is converted to the target system's storage character codes. During analysis of the import definition, Datareplicator assumes that the import definition is coded in the code system specified in this operand.
- sjis
- Use the JIS8/Shift JIS code system.
- euc
- Use the EUC code system.
- utf-8
- Convert data to the utf-8 character code system.
- unknown
- Do not change the character code system. You specify this option when a UOC routine will be used to convert character codes. During analysis of the import definition when unknown is specified, Datareplicator interprets the import definition on the basis of the specification of the LANG environment variable, as follows:
- LANG=ja_JP.SJIS: JIS8/Shift JIS code system
- LANG=other: EUC code system
The default value for this operand depends on the OS in use. Check the following table to determine the default value:
| OS |
Default value |
| HP-UX |
sjis |
| AIX |
| Windows |
| Solaris |
euc |
| Linux |
In the case of Windows Datareplicator, you must specify sjis, utf-8, or unknown, because the source Datareplicator supports only the JIS8/Shift JIS and Unicode systems. Specification of any other value in the dblocate operand will result in an error.
- msglocale={ english|sjis-japanese|euc-japanese }
Specify the character code set to be used for messages issued by the source Datareplicator.
For Windows Datareplicator, specify either english or sjis-japanese; specifying euc-japanese will result in an error.
- english
- Output messages in English.
- sjis-japanese
- Output messages in Japanese using the JIS8/Shift JIS code system.
- euc-japanese
- Output messages in Japanese using the EUC code system. This option is not available to Windows Datareplicator.
- discintvl=disconnect-issuance-interval
~ <unsigned integer> ((0-65535)) <<180>> (seconds)
Specify the interval after which the target Datareplicator is to issue disconnect to the target HiRDB once it detects the end of the update information in the import information queue file during import processing. If you specify 0, Datareplicator does not issue disconnect to the target HiRDB when the end of the update information is detected during import processing. The disconnect issuance timing is the same as with the commit_wait_time operand.
- info_message_out=nosuppress|suppress
Specify whether output of information-only messages to the syslog file (event log for Windows) and error information files is to be suppressed.
- nosuppress
- Do not suppress output of information-only messages.
- suppress
- Suppress output of information-only messages. The following message numbers are subject to this operand's specification:
- 00100, 00103, 00104, 02019, 02020, 02021, 02022, 03001, 03002, 03008, 03009, 03011, 03012, 03013, 03022, 03201, 03202, 03204, 03209, 03028, 03058, 03301, 03302
- except_suppress=message-number[,message-number] ...
~ <5-digit unsigned integer>
From among the messages whose output is suppressed because info_message_out=suppress is specified, specify the numbers of the messages whose output suppression is to be cancelled and which are to be output to the syslog and error information files. You can specify a maximum of 63 message numbers.
Datareplicator ignores specification of a message number if it is not subject to output suppression (specifying such a message number serves no purposes). If you specify the same message number more than once, only the first specification is effective.
This operand is applicable only when suppress is specified in the info_message_out operand.
- commitment_method=fxa_none|fxa_sqle
Specify the synchronization point processing method for import processing (single-phase commit method or double-phase commit method). For details about the synchronization point processing method for import processing, see 3.3.12 Specifying the synchronization point processing for import processing.
When you have changed this operand, execute an initial start of the target Datareplicator.
- fxa_none
- Use the single-phase commit method to execute synchronization point processing. If the target RDBMS is not HiRDB, Datareplicator assumes this value and executes synchronization point processing using the single-phase commit method. To use the import information editing UOC routine, specify fxa_none.
- fxa_sqle
- Use the double-phase commit method to execute synchronization point processing with the import SQL process. However, note that the import UOC process uses the single-phase commit method to execute synchronization point processing.
- If you use the import transaction synchronization facility (syncgroup001 operand specified), specify fxa_sqle.
- Also specify fxa_sqle if the target columns include repetition columns.
- If you are using multiple target Datareplicators for a single HiRDB to import data using the double-phase commit method, the target Datareplicator identifiers cannot be the same. If data is imported into a single HiRDB, synchronization point processing cannot be executed correctly.
- Important
- If you specify fxa_sqle in this operand, make sure before you initialize the target Datareplicator that no undetermined transactions remain in the target HiRDB.
- If any undetermined transactions remain, first use the pdcmt or pdrbk command to determine the transactions, and then initialize the target Datareplicator.
- int_trc_lvl=activity-trace-collection-level[,activity-trace-collection-range]
To change the items to be collected in the activity trace files (import trace files), specify the appropriate value shown in the table below. If you omit this operand, Datareplicator collects only the information common to all facilities (the minimum requirement).
If you specify na for the activity trace collection level, Datareplicator will not collect activity trace information and will ignore any value specified for the activity trace collection range (however, Datareplicator still checks for syntax and range errors).
- Value for the activity trace collection level
| Value |
Information to be collected |
| Common information |
Overview of performance |
Details about performance |
| p1 |
Y |
Y |
-- |
| p2 |
Y |
Y |
Y |
| na |
-- |
-- |
-- |
| int_trc_lvl operand omitted |
Y |
-- |
-- |
- Y: Collected.
- --: Not collected.
- Common information: Collective name for the general checkpoint information that indicates a point of change in start/termination information, error information, or process level.
- Note:
- When you specify p2, you must provide sufficient space for the activity trace files. Otherwise, important information might be deleted by the wraparound feature; in addition, trace collection might result in a large overhead workload.
- Value for the activity trace collection range
| Value |
Information to be collected |
| MST (control) |
RCV (reception) |
RFC (import) |
SQE
(SQL execution) |
| c1 |
Y |
Y |
Y |
-- |
| c2 |
Y |
Y |
-- |
Y |
| c3 |
Y |
Y |
-- |
-- |
| c4 |
Y |
-- |
Y |
Y |
| c5 |
Y |
-- |
Y |
-- |
| c6 |
Y |
-- |
-- |
Y |
| c7 |
Y |
-- |
-- |
-- |
| nc |
Y |
# |
# |
# |
| int_trc_lvl operand or activity-trace-collection-range omitted |
Y |
Y |
Y |
Y |
- Y: Collected.
- --: Not collected.
- #: Even if you specify nc in the import system definition, you can still collect activity trace information individually by specifying the int_trc_getl operand in the import environment definition.
- Guidelines for the int_trc_lvl operand specification:
- We recommend that you specify the int_trc_lvl operand as follows:
- Production run
For actual operations, we recommend that you omit the int_trc_lvl operand. If you cannot obtain reasonable performance with specification of the operand omitted, specify collection of activity trace information temporarily so that you can evaluate performance. In this case, specify p1 or p2 in the first parameter of the int_trc_lvl operand, nc in the second parameter, and the int_trc_getl or int_trc_getv operand in the specific facility (the one exhibiting low performance). If you specify p2 in the first parameter of the int_trc_lvl operand, specify a sufficient value in the int_trc_filesz operand.
- Test run
At the test stage, we recommend that you specify p1 in the first parameter of the int_trc_lvl operand and omit the second parameter. This enables you to execute the hdstrcedit command to view activity trace information in the event of a problem with performance. Use the command's execution results to tune the HiRDB table definitions and the number of import groups.
If you need more detailed information (such as the unit price of SQL executions), change the second parameter to p2 in the int_trc_lvl operand. When you specify p2, specify a sufficient value in the int_trc_filesz operand (at least 1MB).
- int_trc_filesz=activity-trace-file-size
~ <unsigned integer> ((32-1048576)) <<128>> (KB)
Specify the maximum storage size for an activity trace file (import trace file). Datareplicator ignores this operand when na is specified in the int_trc_lvl operand.
We recommend that you specify a value that is a multiple of 32. Otherwise, Datareplicator rounds up the specified value to the nearest multiple of 32KB and uses that value as the maximum size for an activity trace file.
In the target system, Datareplicator creates the activity trace files under the following names in the $HDSPATH directory (Datareplicator uses dual files with swapping and wrapping):
- Import trace files
- $HDSPATH/reftrc.trc1 and $HDSPATH/reftrc.trc2
- int_trc_rintvl=activity-trace-information-collection-interval
~ <unsigned integer> ((5-30000)) <<50>> (milliseconds)
Specify the interval at which activity trace information is to be collected. If na is specified in the int_trc_lvl operand, Datareplicator ignores this operand if it is specified.
You can minimize the amount of missed activity trace information by specifying a short activity trace information collection interval (specify a small value), but the number of monitorings per second increases, resulting in a higher CPU utilization factor. Specify a small activity trace information collection interval in the following cases:
- There are missing entries in the activity trace information.
- The specified activity trace collection level indicates a high level of collection information.
- The frequency of Datareplicator activity is high (there is a large amount of import data).
On the other hand, specify a large activity trace information collection interval in the following case:
- The frequency of Datareplicator activity is low (there is a small amount of import data) and a reduction of CPU utilization by Datareplicator is desired.
- use_convertlib=true|false
Specify whether the code conversion facility is to be used to convert character codes.
- true
- Use the code conversion facility to convert character codes. This value is applicable only when the following character encoding is used at the source database:
EBCDIK/KEIS78
EBCDIK/KEIS83
SJIS
- If the code conversion facility is not installed, Datareplicator ignores true if it is specified.
- false
- Do not use the code conversion facility to convert character codes. In this case, all Gaiji codes will be converted to spaces. To convert Gaiji characters, use the hdsccnvedt command to change the Gaiji conversion method.
- For details about the hdsccnvedt command, see the hdsccnvedt command in 7. Command Syntax.
The use_convertlib operand is applicable only to Windows Datareplicator. Do not specify this operand for UNIX Datareplicator.
- ref_wait_interval=import-process's-import-information-queue-file-read -interval
~ <unsigned integer> ((100-60000)) <<5000>> (milliseconds)
Specify the interval after which Datareplicator is to restart the next read operation once the import process detects the end of the import information queue file.
By specifying a small value in this operand, you can improve the spontaneity of import processing because of the brief wait time after the end of the import information queue file is detected. However, this might have an adverse effect on performance because the CPU utilization factor increases. You must take into account the frequency of update processing and CPU performance in specifying this value.
- commit_wait_time=COMMIT-issuance-interval
~ <unsigned integer> ((0-300)) <<30>> (seconds)
Specify the interval after which Datareplicator is to issue COMMIT to the target HiRDB once the import process detects the end of the import information queue file. If you specify 0, Datareplicator issues COMMIT as soon as the end of the import information queue file is detected. Whether you specify or omit this operand, Datareplicator reads the import information queue file at the interval specified in the ref_wait_interval operand; it issues a COMMIT on the basis of the passage of the amount of time specified in this operand. Therefore, depending on the ref_wait_interval operand's value, COMMIT might not be issued exactly as specified by this operand.
If the end of the import information queue file is detected but no update information has been stored in the import information queue file since the previous issuance of COMMIT, Datareplicator does not issue a COMMIT even though the amount of time specified with this operand has elapsed.
If a large value is specified in this operand, the longer will be the interval from the detection of the end of the import information queue file to the issuance of COMMIT, and, except for the time the search with no lock is conducted, there will be less time to reference data.
If a smaller value is specified in this operand, the shorter will be the interval from the detection to the issuance of COMMIT, so there will be more time to reference the data. However, depending on the specified transmission interval, Datareplicator might need to receive and import the next data immediately after issuing a COMMIT.
As a result, Datareplicator issues COMMIT more frequently, thereby reducing throughput. Therefore, if the transmission interval is less than one minute, we recommend that you specify half the transmission interval in this operand; if the transmission interval is one minute or more, we recommend that you specify the default value. If the transmission interval is 0, specify this operand taking into account the average of the actual transmission intervals.
If you increase the value of this operand, check that the value of the environment variable associated with HiRDB client monitoring is still greater than this operand's value. If this operand's value becomes greater than the discintvl operand's value, Datareplicator issues a COMMIT when the discintvl operand's value is reached, in which case specifying this operand serves no purposes. When you specify this operand, check that its value is smaller than the discintvl operand's value. Even if this operand's value is greater than the discintvl operand's value, Datareplicator will not detect an error.
- file_dupenv=duplexing-definition-file-name
~ <filename of 1 to 125 bytes>
Specify the absolute or relative path name of the duplexing definition file. If a relative path is specified, the system assumes that the path is relative to the target Datareplicator directory.
If the file_dupenv operand is omitted, Datareplicator assumes that the duplexing function is not used.
- syncgroup001=synchronous-import-group-name,data-linkage-identifier[{,data-linkage-identifier}]...
Specify this operand in order to use the import transaction synchronization facility.
When you specify this operand, specify fxa_sqle in the commitment_method operand (sets the two-phase commit method as the synchronization point processing method for import processing).
- synchronous-import-group-name
- ~ <symbolic name of 1-8 characters>
- Specify the name to be assigned to a synchronous import group.
- data-linkage-identifier
- Specify a data linkage identifier that was specified in the dsidxxx operand. An error results if a specified data linkage identifier is not specified in the dsidxxx operand or if ** is specified.
- Each specified data linkage identifier must be unique.
- The maximum number of data linkage identifiers that can be specified per synchronous import group is 128 for UNIX Datareplicator and 63 for Windows Datareplicator. For Windows Datareplicator, operands dsid064 through dsid128 cannot be specified; specifying any of these operands results in an error.
Regarding the data linkage identifiers specified in this operand, there are limitations to some of the operands. For details, see 3.7.5 Synchronous import group.
- syncgrp_discintvl =disconnect-issuance-wait-time
<unsigned integer> ((0-65535)) <<180>> (seconds)
Specify the wait time before disconnect is issued when the import transaction synchronization facility is used.
If there is no update information to be imported before the specified wait time elapses after commit was issued, Datareplicator issues disconnect to the target HiRDB.
If a value of 0 is specified, Datareplicator will not issue disconnect to the target HiRDB even when the end of update information is detected during import processing.
This operand is applicable only to the data linkage identifiers that are specified for the synchronous import group.
- syncwait_limit_tran_count=maximum-number-of-transactions-to-wait-for-until-synchronization
<unsigned integer> ((2-65535)) <<4096>>
Specify the number of extraction transactions that can be processed as a single import transaction by each import process with the data linkage identifiers specified in the synchronous import group.
This operand value must be small enough for the target HiRDB's system log file even when the import transaction rolls back, and the number of locked resources used by the import transaction must be within the target HiRDB's lock pool size.
If no synchronous event is executed within the operand value range, the KFRB03303-E message is output and the synchronous import processing terminates with an error.
- syncwait_limit_time=maximum-time-to-wait-until synchronization
<unsigned integer> ((1-65535)) <<180>> (seconds)
For each import process of the data linkage identifiers specified in the synchronous import group, this operand specifies the maximum amount of time from when the end of the import information queue file is detected prior to detection of a synchronous event during import transaction processing, until the time at which the next update information is received.
This operand's value must be greater than the interval in which the hdeevent command is executed at the source HiRDB.
If no synchronous event is executed within the time specified in this operand, the KFRB03303-E message is output and the synchronous import processing terminates with an error.
- reflect_counter_reset= true|false
Specify whether the import processing count is to be reset when the target system starts.
- true
- Reset the import processing count when the target system starts.
- false
- Do not reset the import processing count when the target system starts.
- Note:
- If the import method used during restart of the target Datareplicator differs from the method used during the previous termination, the import processing count is reset even if false is specified. The following table shows whether the count is reset depending on the import method used during the previous termination and the import method used during restart of the target system:
| Import method used during previous termination |
Import method used during restart |
Whether the count is reset |
| Transaction-based |
Transaction-based |
N |
| Table-based |
Y |
| Table-based |
Transaction-based |
Y |
| Table-based |
N# |
- Legend:
- Y: Reset
- N: Not reset
- #: If there is a difference in any of the following items between the previous termination and the restart of Datareplicator, the import processing count is reset:
-
Import group name
-
Number of SQL processes
-
Partitioning method (key range partitioning, hash partitioning)
-
For key range partitioning, the number of key range groups
-
For hash partitioning, the number of RDAREAs for the hash row-partitioned table
- The following are the conditions under which the import processing count is reset other than during restart:
-
The import method was changed by an event.
-
The definition information was changed, and then the import process was restarted.
- resource_chk_err=continue | stop
Specify the action to be taken if an error is detected when the target Datareplicator checks file integrity and file sizes during initialization or start processing.
If you always perform initialization or start processing when no change has been made to the data linkage environment or operands, we recommend that you specify stop.
- continue
- Continue with the initialization or start processing if it's possible for data linkage to be resumed or if the user changed operands intentionally.
- stop
- Stop the initialization or start processing regardless of the nature of the error.
All rights reserved. Copyright (C) 2007, 2013, Hitachi, Ltd.