3.6 ALTER DISTPATH

Use ALTER DISTPATH to change the attributes of a distribution path.

Syntax

ALTER DISTPATH path-name
         ( BEGIN   ( NOW
                   | SEQNO trail-sequence-number RBA relative-byte-address
                   | begin-datetime )
         | TARGET  ( URI           target-uri
                   | FORMAT        ( CANONICAL | TEXT | SQL | XML )
                   | SIZEMB        megabytes-number
                   | SEQLEN        sequence-length
                   | PROXY URI     proxy-uri
                           TYPE    ( SOCKS | HTTP )
                           [ CSALIAS credential-store-alias
                             [ CSDOMAIN credential-store-domain ] ]
                   | ENCRYPTION  ALGORITHM encryption-algorithm  
                   | COMPRESSION ( ON | OFF | THRESHOLD compression-threshold ) )
         | RULE    ( PASSTHRU
                   | FILTER [ CHUNKIDS    chunk-ids ]
                            [ OBJECTNAMES object-names-wildcard ]
                            [ OBJECTTYPES [ DML ] [ DDL ] [ PROCEDURE ] [ INSERT ] [ UPDATE ] [ UPSERT ] [ DELETE ] ]
                            [ TAGS        binary-tags ]
                            [ PROCEDUREFEATURENAMES feature-names-wildcard ]
                            [ COLUMNVALUES column-values ]
                            [ PARTITIONNAMES partition-names-wildcard ] )
                   [ RELATION  ( AND | OR )]
                   [ ACTION    ( INCLUDE | EXCLUDE ) ]
         | OPTIONS [ AUTORESTART RETRIES retries [ DELAY delay ] ]
                   [ CRITICAL ( YES | NO ) ]
                   [ EOFDELAY    eofdelay
         | ENCRYPTIONPROFILE encryption-profile

path-name

The name of the distribution path you want to change.

BEGIN {NOW | SEQNO sequence-number RBA relative-byte-address | begin-datetime}

Specifies a timestamp in the data source at which to begin processing.

NOW

Specifies the time at which the ADD EXTRACT command is issued.

sequence-number relative-byte-address

The sequence number of an Oracle redo log and RBA within that log at which to begin capturing data.

begin-datetime

A date and time (timestamp) in the given form. For an Extract in integrated mode, the timestamp value must be greater than the timestamp at which the Extract was registered with the database.

TARGET

At least one TARGET option must be specified. It is treated as a complete object. If you need to specify something complicated, you need to use the REST API. AdminClient only supports a limited set of target settings and doesn't merge target setting with previous call.

URI

Specifies the URI of the target distribution path.

FORMAT

Specifies the format of the URI of the target distribution path.

SIZEMB

Specifies the size of the trail sequence.

SEQLEN

Specifies the sequence length of the trail file.

PROXY URI

Specifies the proxy URI of the target distribution path.

TYPE

Specifies the type of connection between the source and target distribution path. You can choose a SOCKS PROXY or HTTP PROXY.

CSALIAS

Credential store alias used by the encryption profile for the distribution path.

CSDOMAIN

Domain of the credential store used by the encryption profile for the distribution path.

ENCRYPTION ALGORITHM

Specify the name of the encryption algorithm such as AES 256.

COMPRESSION

Specifies if the trail sequence has to be compressed. If you set it to YES, then you need to specify the threshold for the compression.

PASSTHRU

See PASSTHRU | NOPASSTHRU in Reference for Oracle GoldenGate

FILTER

At least one FILTER option must be specified. By default the RELATION between the filters is OR and the action is KEEP.

CHUNKIDS chunk-ids

Specify a rule to filter records by their chunk ID (sharding). The list of chunk IDs must be parenthesized and comma separated.

RULE

At least one RULE option must be specified. For example:

ALTER DISTPATH dp1 RULE FILTER CHUNKIDS (1, 2, 3)

RULE is treated as a complete object. If you need to specify something complicated, you need to use REST API. AdminClient only supports a limited set of RULE settings.

OBJECTNAMES object-names

Specify a rule to filter records by their object name. The list of object names must be parenthesized and comma separated. An object name must follow the following grammar:

[cdb-name.]schema-name.table-name

For example:

ALTER DISTPATH dp1 RULE FILTER OBJECTNAMES (user1.table1, cdb1.user2.ta ble1)

OBJECTTYPES [ DML ] [ DDL ] [ PROCEDURE ]

Specify a rule to filter records by their object type. At least one object type must be specified.

TAGS binary-tags

Specify a rule to filter records by their tag. The list of tags must be parenthesized and comma separated. A tag must be a hexadecimal or binary value string and prefixed by the keywords HEXVALUE, HEXMASK, BINVALUE, and BINMASK. In case the tag is a BITMASK, the filter performs a bitwise AND operation between the mask and the tag value of an LCR record. If the result is equal to the MASK, then the action is applied.

For example:

ALTER DISTPATH dp1 RULE FILTER TAGS (hexvalue A4, hexvalue 18, hexmask F0, hexvalue F8F, binvalue 01001100, binmask 0110)

PROCEDUREFEATURENAMES feature-names

Specify a rule to filter records by procedure feature name. The list of procedure feature names must be parenthesized and comma separated. For example:

ALTER DISTPATH dp1 RULE FILTER PROCEDUREFEATURENAMES (RAS, AUTOCDR, AQ)

COLUMNVALUES column-values

Specify a rule to filter records by their column value. The filtering rules must follow this grammar and be comma separated:

[cdb-name.]schema-name.table-name.column-name ( EQ | NE | LT | GT | LE | GE ) column-value [ BEFORE | AFTER ]

EQ = equal

NE = not equal

LT = less than

GT = greater than

LE = less or equal

GE = grater or equal

For example:

ALTER DISTPATH dp1 RULE FILTER COLUMNVALUES (cdb1.user1.table1.col1 EQ 0 BEFORE, cdb2.user2.table1.col1 GT 100)

OPTIONS

At least one OPTIONS option must be specified.

AUTORESTART RETRIES

The maximum number of the task should be restarted before aborting retry efforts. This is optional.

DELAY

The number of times to pause in between discovering that a process has terminated abnormally and restarting the process.

CRITICAL

Select this option to indicate if the process is critical for the deployment.

EOFDELAY

Use the EOFDELAY option to control how often Extract or Replicat checks for new data after it has reached the end of the current data in its data source. You can reduce the system I/O overhead of these reads by increasing the value of this parameter. See EOFDELAY | EOFDELAYCSECS in Reference for Oracle GoldenGate.

ENCRYPTIONPROFILE

Specifies the name of the encryption profile for the distribution path.

Examples

ALTER DISTPATH path1 BEGIN NOW

 ALTER DISTPATH path1 BEGIN SEQNO 1 RBA 10355

ALTER DISTPATH path1 OPTIONS AUTORESTART RETRIES 3 

ALTER DISTPATH path1 RULE FILTER OBJECTNAMES (CUST1.*, CUST2.*) ACTION EXCLUDE

ALTER DISTPATH path1 RULE FILTER TAGS (AE00, MASK AB00, FF)

ALTER DISTPATH path1 RULE FILTER COLUMNVALUES (user1.t1.c1 NE nope, user1.t1.c2 
    EQ 3 AFTER, user1.t2.c1 GE 5, user1.t2.c2 GT 5 BEFORE) 

ALTER DISTPATH path1 RULE FILTER OBJECTNAMES(CUST1.*,CUST2.*) RELATION AND ACTION EXCLUDE