There are three levels of parameters that can be modified for the Log Reader Capture agents. In each case these modifications can be staged and then applied when ready.
Syntax
sqdconf modify <cab_file_name>
[[--log-point | --lsn | --rba | --scn]=<number>]
[--user=<name>]
[--password=<value>]
[--passcmd=<filename>]
[--plan=<sqdata_plan>]
[--retry=<number> | --noretry]
[[--add-excluded-<type> | --remove-excluded-<type>]=<excluded_value>]
[--dict-from-redo-logs]
[--dict-from-online-catalog]
[--disable-continuous-mining]
[--encryption | --no-encryption]
[--auth-keys-list=<name>]
[[--block-refresh | --allow-refresh --target=<engine_name>]
[--allow-refresh --target=DB2TOORA]
[--work-storage=/home/sqdata/db2cdc/refreshdata]
[--small-stall=<nnnn>]
[--large-stall=<nnnn>]
Keyword and Parameter Descriptions
| Keyword | Description |
|---|---|
| <cab_file_name> | Must be specified and must match the name specified in the previous create command. |
| [--log-point | --lsn | --rba | --scn]=<number> | This specifies a point in time to start capture, using the native database's system for uniquely identifying such points. This log point indicates that any transaction committed prior to or at this log point is deemed already captured. Zero means current (Db2 SSID level only). This LSN is often referred to as the Global LSN because it positions the Capture at the specified LSN in the database log for capture regardless of the last LSN required by subscribing Engines. See section on Subscription Level LSN parameters below. |
| [--user=<name> | -u <name>] | User name/id required to connect to the underlying database. This user must have the authority to perform log capture/log mining on the underlying database. |
| [--password=<value> | -p <value>] |
Plain text passwords are exposed in the cab file. DO NOT use plain text passwords. Precisely highly recommends using |
| [--passcmd='./getpassword.sh'] | A script that will return the user password. |
| [--retry=<number> | --noretry] | Number of seconds to wait before re-attempting to write to the transient data store (zLog, or CDCSTORE). When a write to fails due to a Full condition, the capture agent will wait the specified number of seconds before re-attempting the write. If the second write fails the agent stops and reports an error, otherwise processing will continue normally. This allows for throttling the output rate. A negative or null value disables the retry mechanism. In the case of CDCSTORE, the retry mechanism is used to deal with the situation where the storage agent is full. In this case ONLY, the capture agent will wait the specified number of seconds and retry indefinitely, until some space becomes available in the storage agent or the capture agent is Stopped. |
| [--add-excluded-<type>=<value>] | Exclude from capture records associated with <type> and value where <type> may be "user", "plan" or "correlation-id", depending on the specific type of source datastore. By default, no activity is excluded based on the initiating user. See the RDBMS specific Capture Reference for supported types. Note, when Connect CDC SQData is configured for Active/Active replication, the Engine itself must be excluded from capture to avoid cyclic transactions. Transactions should be captured from System A and applied to System B but not recaptured on System B. This filtering is possible if the user running the Engine on System B is excluded in System B´s capture. It is important not to use this user for any other purpose that generates changes that need to be replicated to System A. See the RDBMS specific Capture Reference for requirements. This parameter will apply to transactions that begin on or after the restart point of the capture. |
| [--remove-excluded-<type>=<value>] | Begin capturing transactions associated with <type> and value that were previously excluded. This parameter will apply to transactions that begin on or after the restart point of the capture. See --excluded-<type>=<value>. |
| [--dict-from-redo-logs] | Oracle only. Indicate that the Dictionary should be tracked based on the redo-logs content. This requires that the Oracle dictionary is periodically dumped into the redo logs. |
| [--dict-from-online-catalog] | Oracle only. Indicate that the Dictionary should be tracked using the online dictionary. This is the default for backward compatibility. |
| [--disable-continuous-mining] | Oracle RAC capture only. This option must be specified when capturing Oracle 11 or 12 on a RAC system. It instructs the Capture Agent not to use the Oracle LogMiner CONTINUOUS_MINE option. The --disable-continuous-mining option is the default for Oracle version 19 on both RAC and non-RAC systems. |
| [--encryption | --no-encryption] | Enables or disables NaCL encryption of the published CDC record payload. On z/OS Precisely recommends zIIP processors be used to enhance CPU cycle efficiency and reduce CPU cost associated with NaCL software encryption. |
| [--auth-keys-list="<name>"] | Required for NaCL software encrypted CDC record payload. File name must be enclosed in quotes and must contain public key(s) of only the subscribing Engines requiring encryption of the CDC record payload. See --encryption option. |
| [--block-refresh | --allow-refresh --target=<engine_name>] | Db2/z only. Block or Un-Block the the data from a capture based refresh from being published to a specific target subscription (Engine). |
| [--work-storage=<value>] | Db2/z Connect CDC SQData V4.1+ only, The path and directory created for the Dynamic Refresh transient data. |
| [--small-stall=<nnnn>] | Oracle Only, default is 250ms. Controls the first wait interval following an "all caught up" scenario. The parm become effective immediately following sqdconf stop and sqdconf start sequence. NO apply is required. |
| [--large-stall=<nnnn>] | Oracle only, default is 1000ms (one second). Controls subsequent wait intervals following a "first wait interval" that returned no changed data. The parm become effective immediately following sqdconf stop and sqdconf start sequence. NO apply is required. |
Source Tables and Engine Descriptions
Modify the list of source tables to be captured in the Capture Configuration (.cab) file. The schema and the table names themselves cannot be modified but they are required to change a table entry. Remember, even sources marked active will not be captured until changes to the configuration file are applied.
Syntax
sqdconf modify <cab_file_name>
(--schema=<name> --table=<name>) | --key=<name>
[--datastore=<datastore_url> | --add-datastore=<datastore_url> | --remove-datastore=<datastore_url>]
[--active | --inactive | --pending]| Keyword | Description |
|---|---|
| <cab_file_name> | Path and name of the Capture/Publisher Configuration (.cab) file. In a windows environment .cfg may be substituted for .cab since those files have special meaning in windows. |
| --schema=<name> | Schema name, owner, or qualifier of a table. Different databases use different semantics, but a table is usually uniquely identified as S.T where S is referenced here as schema. This parameter cannot be specified with --key. |
| --table=<name> | A qualified table name in the form of schema.name that identifies the source. This may be used in place of two parameters, --schema and --table. Both cannot be specified. |
| --key=<name> | A qualified name in the form of schema.name that identifies the source. This may be used in place of two parameters, --schema and --table. Both cannot be specified. |
| [--add-datastore=<datastore_url> | --datastore=<datastore_url> | -d <datastore_url>] | See add (Capture). |
| [--remove-datastore=<datastore_url> | -r <datastore_url>] | Remove a URL identifying a target datastore from the target list of the associated entry. |
| [--active | --inactive] | Mark a table as active or in-active for capture. The table will remain in the current state until the Capture is stopped, applied and re-started. |
| [--pending] | This parameter allows a table to be changed to Pending status allowing it to be removed from the database catalog. |
Subscription level LSN parameters
The Last acknowledged LSN previously published to a subscribing Engine is always maintained in the Capture Configuration (.cab) file. That is the principal reason the configuration file should not be deleted and recreated without careful consideration of the impact on downstream targets. Normally the LSN of a specific subscription will only be modified when recapturing previously processed relational database logs.
Note: Remember, LSN modifications will not be effective until changes to the configuration file are applied.
Syntax
sqdconf modify <cab_file_name>
[--target=<datastore_url>
[[--log-point | --lsn | --rba | --scn]=<number>]Keyword and Parameter Descriptions
| Keyword | Description |
|---|---|
| <cab_file_name> | Path and name of the Capture/Publisher Configuration (.cab) file. In a windows environment .cfg may be substituted for .cab since those files have special meaning in windows. |
| [--target=<datastore_url> | URL identifying a subscribing Engine AKA target datastore. While --target seems to be only an alias for --datastore, it is not. The value of the <datastore_url> must match an existing --datastore value but a different parameter name has been used to ensure it is only used in conjunction with a modified --lsn (see parameter below). |
| [--log-point | --lsn | --rba | --scn]=<number> | This specifies a point in time from which captured data will be published to a subscribing Engine using the native database's system for uniquely identifying such points. This log point indicates that any transaction committed prior to or at this log point is deemed already captured. Zero means current (Db2 SSID level only). Modification of the subscription level LSN is normally used only when the Capture level LSN has also been repositioned, see above, for Recapture/remining purposes. |