ALTER RECVPATH
Use ALTER RECVPATH to change the attributes of target-initiated distribution path in the Receiver Service.
Syntax
ALTER RECVPATH *path-name*
| ( BEGIN ( NOW
| | SEQNO *trail-sequence-number* RBA *relative-byte-address*
| | *begin-datetime* )
| | SOURCE ( URI *source-uri*
| | PROXY URI *proxy-uri* )
| | TARGET ( FORMAT ( CANONICAL | TEXT | SQL | XML )
| | SIZEMB *megabytes-number*
| | SEQLEN *sequence-length*
| TYPE ( SOCKS | HTTP )
| [ CSALIAS *credential-store-alias*
| [ CSDOMAIN *credential-store-domain* ] ]
| | ENCRYPTIONPROFILE *encryptionprofile_name*
| | COMPRESSION ( ON | OFF | THRESHOLD *compression-threshold* ) )
| | RULE ( PASSTHRU
| | FILTER [ CHUNKIDS *chunk-ids* ]
| [ OBJECTNAMES *object-names-wildcard* ]
| [ OBJECTTYPES [ DML ] [ DDL ] [ PROCEDURE ] ]
| [ 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* ]
| | AUTHENTICATION ( OAUTH
| ( CERTIFICATE *certificate-name* )
| ( USERIDALIAS *alias* [DOMAIN *domain*
| (ENCRYPTIONPROFILE *encryption-profile-name*] ) ) )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.
SOURCE URI source_uri
Specifies the source URI after the source keyword to indicate where the data is originated. The format of this URI contains the protocol (only supports trail), hostname, port number of the Receiver Service, and location of the source trail files.
PROXY URI proxy_uri
Specifies the proxy URI after the proxy keyword to indicate where the data is originated. The format of this URI contains the protocol (only supports trail), hostname, port number of the Receiver Service, and location of the source trail files.
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. Admin Client only supports a limited set of target settings and doesn’t merge target setting with previous call.
CANONICAL
Defines a single byte order, a single floating-point representation of data.
TEXT
Text data.
SQL
Valid SQL statements.
XML
XML formatted data.
FORMAT
Specifies the format of the URI of the target distribution path.
SIZEMB megabytes_number
Sets the size of the distribution path in megabytes.
SEQLEN sequence_length
Sets the sequence length of the distribution path.
TYPE
Sets the proxy type that the distribution path uses, HTTP or SOCKS.
CSALIAS credential_store_alias
Specifies your credential store alias name.
CSALIAS credential_store_domain
Specifies your credential store domain name.
AUTHENTICATION OAUTH
Use this option if you are using external Identity Provider (IDCS) authorization profile. This will set up the flow from the Distribution Service to the Receiver Service.
Note: If your deployment is enabled for IDCS, you can still choose to authentication using other authentication options.
AUTHENTICATION CERTIFICATE certificate-name
Identifier of distribution path-specific client certificate uploaded and managed in Administration Service.
AUTHENTICATION USERIDALIAS
Alternative to certificate authentication, you can associate each distribution path with a target DBLOGIN USERIDALIAS.
ENCRYPTIONPROFILE
Specifies the name of the encryption profile for the distribution path.
COMPRESSION {ON |
OFF |
THRESHOLD compression_threshold} |
Specifies whether your data is compressed or not. If set to ON, then you can specify the threshold level.
RULE
At least one RULE option must be specified. For example:
ALTER RECVPATH rcvp RULE FILTER CHUNKIDS (1, 2, 3)PASSTHRU
See [PASSTHRU \| NOPASSTHRU](/pls/topic/lookup?ctx=en/database/goldengate/core/26/gclir&id=GWURF-GUID-070B80BB-5C66-48F3-AA5A-DC21648D6BE2) in Parameters and Functions 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.
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 RECVPATH rcvp RULE FILTER OBJECTNAMES (hr.emp, pdbnorth.hr.department)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 RECVPATH rcvp 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 RECVPATH rcvp 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 RECVPATH rcvp RULE FILTER COLUMNVALUES (pdbnorth.ggadmin.hr.emp.emp_id EQ 0 BEFORE, cdbsouth.c##ggadmin.hr.emp.emp_id GT 100)OPTIONS
At least one option must be specified:
AUTORESTART {RETRIES retries |
DELAY delay} |
Specifies that the distribution path is automatically restarted, how many times to retry the start, and any delay.
CRTICAL [YES | NO]
Indicates that the distribution path is critical to the deployment. The default is NO.
EOFDELAY eofdelay
Specifies how often Extract, a data pump, or Replicat checks for new data after it has reached the end of the current data in its data source.
ENCRYPTIONPROFILE
Specifies the name of the encryption profile for the Receiver path.
Examples
ALTER RECVPATH rcvp BEGIN NOWALTER RECVPATH rcvp BEGIN SEQNO 1 RBA 10355ALTER RECVPATH rcvp OPTIONS AUTORESTART RETRIES 3ALTER RECVPATH rcvp RULE FILTER OBJECTNAMES (hr.*, sales.*) ACTION EXCLUDEALTER RECVPATH rcvp RULE FILTER TAGS (AE00, MASK AB00, FF)ALTER RECVPATH rcvp RULE FILTER COLUMNVALUES (c##ggadmin.hr.employees NE nope, c##ggadmin.hr.employees
EQ 3 AFTER, c##ggadmin.hr.employees GE 5, c##ggadmin.hr.employees GT 5 BEFORE)ALTER RECVPATH rcvp RULE FILTER OBJECTNAMES(hr.*,sales.*) RELATION AND ACTION EXCLUDE