3 AdminClient Command Line Interface Commands

Learn how to use the Oracle GoldenGate Microservices Architecture AdminClient commands, options, and review examples.

Topics:

3.1 ADD CREDENTIALS

The ADD CREDENTIALS command adds a new username and password to an Oracle wallet that resides on the same system where the Admin Client is running. The username and password are referenced using a credential name.

Syntax:

ADD CREDENTIALS credentials-name | USER username | [ PASSWORD password ]

Example:

OGG (not connected) 1> ADD CREDENTIALS admin USER oggadmin PASSWORD oggadmin-A1
2019-02-14T00:19:13Z  INFO OGG-15114  Credential store altered.
OGG (not connected)2>

In this example, a credential called admin is added with a username oggadmin and a password of oggadmin-A1. If the password is not specified in the ADD CREDENTIALS command, you will be prompted to enter the password interactively, where the password is not displayed on the terminal.

3.2 ADD DISTPATH

Use ADD DISTPATH to create a distribution path.

Syntax

 ADD DISTPATH <path-name>
          SOURCE source-uri 
          TARGET target-uri|
         [TARGETTYPE ( MANAGER | COLLECTOR | RECVSRVR ) ]|                 [
          ENCRYPTIONPROFILE encryption-profile-name ]
path-name

The unique name of the distribution path you want to add.

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 Distribution Server, and location of the source trail files.

target-uri

Specifies the target URI after the target keyword to indicate where the data will be sent to. The format of this URI is:

a supported protocol, udt, ogg, web socket ws, or secure web socket wss

a hostname,

the port number of the Receiver Server,

and the location of the target trail files.

TARGETTYPE

Specifies the target type in case the distribution path uses the legacy protocol. This argument is only valid if the target URI schema is ogg://.

Choose MANAGER if the target is a legacy deployment with a manager running.

Choose COLLECTOR if the target is a legacy deployment with a static collector running.

Choose RECVSRVR if the target is an Microservices Architecture deployment with a Receiver Server running.

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

Examples

ADD DISTPATH path1  SOURCE trail://localhost:9002/services/v2/sources?trail=a1 
                    TARGET wss://localhost:9003/services/v2/targets?trail=t1 

The target trail must specify the directory that contains your trail files. The default dirdat directory is used in this example.

ADD DISTPATH path1  SOURCE trail://localhost:9002/services/v2/sources?trail=a1 
                    TARGET ogg://localhost:9003/services/v2/targets?trail=dirdat/t1 
                    TARGETTYPE MANAGER

A fully-qualified alias.

ws://domain+alias@host:port 

An alias from a default domain.

ws://default_alias+OracleGoldenGate@host:port

A credential store is not used; DS base64-encode user:password into the Authorization header.

ws://user:passwd@host:port

3.3 ADD ENCRYPTIONPROFILE

Use ADD ENCRYPTIONPROFILE to add an encryption profile for Oracle Key Vault using Oracle GoldenGate.

Syntax

ADD ENCRYPTIONPROFILE encryption-profile-name    
                      OKV
                      OKVPATH dir-path       
                      [KEYNAMEATTRIBUTE key-name-attribute]       
                      [KEYVERSIONATTRIBUTE key-version-attribute]       
                      MASTERKEY NAME masterkey-name         
                      [VERSION masterkey-version]         
                      [ TTL ttl]       
                      [ DEFAULT [ YES | NO ]]
 
OKVPATH
Specifies the directory where Oracle Key Vault client is installed.
KEYNAMEATTRIBUTE

Custom attribute used in Oracle Key Vault server to specify the masterkey name

KEYVERSIONATTRIBUTE

Custom attribute used in Oracle Key Vault server to specify the masterkey version.

MASTERKEY [NAME]
Name of the master key. This value must match the key name in the KMS parameter in Oracle GoldenGate and cannot be changed once replication has started.
MASTERKEY [VERSION]
Version of the master key. This must be a numeric value.
DEFAULT
Specifies the current encryption profile. If you set DEFAULT YES then the encryption profile is set to be the current encryption profile. If you set DEFAULT NO then the encryption profile is removed. If there is no explicitly defined current encryption profile (you set as DEFAULT NO to the previously current one) then the implicitly default profile is LocalWallet.

Note:

Do not upload keys with duplicate values of KeyName and KeyVersion. At the time of startup, restart, or rollover, Oracle GoldenGate processes retrieve the highest KeyVersion value.

3.4 ADD PROFILE

This command is used to create a profile for managed Extract, Replicat , Distribution and Receiver path processes from the Admin Client.

Syntax:
ADD PROFILE profile-name
             [ AUTOSTART        [ YES | NO ]
               [ DELAY            delay-number ]
             [ AUTORESTART      [ YES | NO ]
               [ RETRIES          retries-number]
               [ WAITSECONDS      wait-number]
               [ RESETSECONDS     reset-number]
               [ DISABLEONFAILURE [ YES | NO ] ] 
profile-name
Name of the profile for the specific managed process.
AUTOSTART
Specifies whether the managed process has to be started automatically when the Administration Server starts. The default value is YES.
DELAY
Set the delay-number to configure the delay time to automatically start the managed process.
AUTORESTART
Specifies whether the managed process has to be restarted if it stops or abends. The default value is YES.
RETRIES
Specifies the number of retries for attempting to automatically restart the managed process.
WAITSECONDS
Specifies the time to wait before attempting another retry to restart.
RESETSECONDS
Used to reset the time for the retries.
DISABLEONFAILURE
Specifies if the managed process has to be disabled if it fails to restart. The default value is NO.

Example:

OGG (https://localhost Local) 5> ADD PROFILE Critical AUTOSTART AUTORESTART RETRIES 1 WAITSECONDS 0 RESETSECONDS 0 DISABLEONFAILURE NO
Command succeeded with no output.

3.5 ADD RECVPATH

Use ADD RECVPATH to create a target-initiated distribution path in the Receiver Server.

Syntax

ADD RECVPATH path-name source-uri target-uri 
             [ENCRYPTIONPROFILE encryption-profile-name ]
path-name

The unique name of the distribution path you want to add.

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 Server, and location of the source trail files.

target-uri

Specifies the target URI after the target keyword to indicate where the data will be sent to. The format of this URI contains the protocol (only supports legacy ogg protocol, web socket ws protocol, and secure web socket wss protocol), hostname, port number of Receiver Server, and location of the target trail files.

ENCRYPTIONPROFILE
This is the name (string) of the encryption profile for the Receiver path.

Examples

ADD RECVPATH path1  SOURCE trail://localhost:9002/services/v2/sources?trail=a1 TARGET wss://localhost:9003/services/v2/targets?trail=t1 
ADD RECVPATH P1 SOURCE wss://prod1:17002/services/v2/sources?trail=a1 TARGET trail://prod2:17003/services/v2/targets?trail=x2 

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.

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)
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

3.7 ALTER ENCRYPTIONPROFILE

Use ALTER ENCRYPTIONPROIFLE to change the encryption profile name and default settings.

Syntax

ALTER ENCRYPTIONPROFILE encryption-profile-name
     DEFAULT [ YES | NO ]

Example:

ALTER ENCRYPTIONPROFILE encryptab

DEFAULT YES

3.8 ALTER RECVPATH

Use ALTER RECVPATH to change the attributes of target-initiated distribution path in the Receiver Server.

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 ] ]
  |                   | ENCRYPTION  ALGORITHM encryption-algorithm  
  |                   | 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         ]
  |         | 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.

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 Server, 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 Server, and location of the source trail files.

TARGET

At least one TARGET option must be specified.

CANONICAL
Defines a single byte order, a single floating-point representation of data.
TEXT

Text data.

SQL

Valid SQL statements.

XML
XML formatted data.
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.

ENCRYPTION ALGORITHM encryption_algorithm

Specifies a valid encryption algorithm for your database. Value could be AES 256 and so on.

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 dp1 RULE FILTER CHUNKIDS (1, 2, 3)
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.

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 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 RECVPATH 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 RECVPATH 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 RECVPATH dp1 RULE FILTER COLUMNVALUES (cdb1.user1.table1.col1 EQ 0 BEFORE, cdb2.user2.table1.col1 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 path1 BEGIN NOW
ALTER RECVPATH path1 BEGIN SEQNO 1 RBA 10355
ALTER RECVPATH path1 OPTIONS AUTORESTART RETRIES 3 
ALTER RECVPATH path1 RULE FILTER OBJECTNAMES (CUST1.*, CUST2.*) ACTION EXCLUDE
ALTER RECVPATH path1 RULE FILTER TAGS (AE00, MASK AB00, FF)
ALTER RECVPATH 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 RECVPATH path1 RULE FILTER OBJECTNAMES(CUST1.*,CUST2.*) RELATION AND ACTION EXCLUDE

3.9 DBLOGIN USERIDALIAS

Use DBLOGIN to establish a database connection through Admin Client in preparation to issue other Oracle GoldenGate commands that affect the database. The user who issues DBLOGIN should have the appropriate database privileges to perform the functions that are enacted by those commands. Any other special privileges that are required for a Admin Client command are listed with the reference documentation for that command.

Syntax

DBLOGIN USERIDALIAS alias
}
alias

Specifies the alias of a database user credential that is stored in the Oracle GoldenGate credential store. To log into a pluggable database in an Oracle multitenant container database, the user must be stored as a connect string, such as OGGUSER@FINANCE. To log into the root container, the user must be stored as a common user, including the C## prefix, such as C##GGADMIN@FINANCE.

DOMAIN domain

Specifies the credential store domain for the specified alias. A valid domain entry must exist in the credential store for the specified alias. The default domain is OracleGoldenGate.

Examples

DBLOGIN USERIDALIAS alias1 
DBLOGIN USERIDALIAS alias1 DOMAIN domain1

3.10 CD

Use CD to change the Admin Client working directory.

Syntax

CD directory-name
directory-name

The name of the directory.

3.11 CLEAR INSTANTIATION CSN

Use CLEAR INSTANTIATION CSN on your target database to clear (reverse) the instantiation CSN manually. This command requires DBLOGIN where the user is the default Oracle GoldenGate schema.

Syntax

CLEAR INSTANTIATION CSN FOR [schema.]table FROM source_database_name
[schema.]table

The name of the table to clear the instantiation CSN on. If no schema is provided, the DBLOGIN user will be used.

source_database_name

The global name of the source database for which this is a target.

Example

CLEAR INSTANTIATION CSN FOR hr.employees FROM DBS1.US.COMPANY.COM

3.12 CONNECT

Use CONNECT to connect to an Oracle GoldenGate Service Manager to execute other commands. You must connect to your Service Manager before you can execute most of the Admin Client commands.

Admin client allows connections when the server uses a self-signed certificate though this is not the default. Admin Client does not allow connecting to a server through HTTPS when the self-signed certificate is invalid. To override this behavior, use the ! modifier with the CONNECT command.

For example, when using the Admin Client to connect to the Oracle GoldenGate Microservices Architecture services that are secured with a self-signed SSL certificate, you must use a command with the ! modifier:

CONNECT https://myserver.example.org as oggadmin !

Syntax

CONNECT server-url deployment-name proxy-uri user-name password
server-url

The URL of the Service Manager that you want to connect to.

deployment-name

The name of the deployment that you want to connect to on the specified Service Manager. If only one deployment (except for Service Manager) is defined, that deployment is the default. Otherwise, there is not a default deployment and the DEPLOYMENT deployment-name option must be used.

proxy-uri

The URI of your proxy server in the schema://hostname[:port-number] format.

user-name

The user name for the specified Service Manager.

password

The password for the specified user name. If you do not specify the password, you are prompted for it.

Example

CONNECT http://prodserver.mysite.com:9700 deployment Atlanta_1 as oggadmin password welcome1

3.13 DELETE CREDENTIALS

To remove a credential from the local wallet, use the DELETE CREDENTIALS command.

Syntax:

DELETE CREDENTIALS credential-name

credential-name is the name of the credential being deleted.

Example:

OGG (not connected) 1> DELETE CREDENTIALS admin
2019-02-14T00:31:36Z  INFO    OGG-15114  Credential store altered. 

OGG (not connected) 2>

In this example, the admin user credential is deleted.

3.14 DELETE DISTPATH

Use DELETE DISTPATH to remove a distribution path.

Syntax

DELETE DISTPATH path-name

The name of the distribution path.

Example

DELETE DISTPATH path1

3.15 DELETE ENCRYPTIONPROFILE

Use DELETE ENCRYPTIONPROFILE to remove an encryption profile.

Syntax

DELETE ENCRYPTIONPROFILE encryption-profile-name

3.16 DELETE PROFILE

This command removes a managed process profile.

Syntax:

DELETE PROFILE profile-name

profile-name is the name of the profile being removed.

Example:

OGG (https://localhost Local) 7> DELETE PROFILE Critical
Command succeeded with no output.

3.17 DELETE RECVPATH

Use DELETE RECVPATH to remove target-initiated distribution path in the Receiver Server.

Syntax

DELETE RECVPATH path-name

The name of the distribution path.

Example

DELETE RECVPATH path1

3.18 DISABLE SERVICE

Use DISABLE SERVICE to disable the specified Oracle GoldenGate services for any update operations by users without the Security role. You must have the Security role to use this command.

Syntax

DISABLE SERVICE service_name_wildcard

service_name_wildcare

The name of a service or a wildcard (*) to specify multiple services. Valid services are ADMINSRVR, DISTSRVR, RECVSRVR, and PMSRVR.

Example

DISABLE SERVICE ADMIN*

3.19 DISCONNECT

Use to disconnect from the Service Manager. It is not necessary to disconnect from one Service Manager connection to connect to another Service Manager. Use the CONNECT command to establish a connection to a Service Manager.

Syntax

DISCONNECT

3.20 EDIT ENCKEYS

Use EDIT ENCKEYS to open the ENCKEYS file for editing in the default text editor.

Syntax

EDIT ENCKEYS

3.21 EDIT GLOBALS

Use this to open the GLOBALS parameter file for editing in the default text editor. The default text editor is set using the SET EDITOR command.

Syntax

EDIT GLOBALS

3.22 ENABLE SERVICE

Use ENABLE SERVICE to enable the specified Oracle GoldenGate services. You must have the Security role to use this command.

Syntax

ENABLE SERVICE service_name_wildcard
service_name_wildcard

The name of a service or a wildcard (*) to specify multiple services. Valid services are ADMINSRVR, DISTSRVR, RECVSRVR, and PMSRVR.

Example

START SERVICE ADMIN*

3.23 INFO CREDENTIALS

The INFO CREDENTIALS command retrieves a list of credentials.

Example

OGG (not connected) 1> INFO CREDENTIALS * 
Credentials Name                  User Name
admin                             oggadmin  

OGG (not connected) 2> INFO CREDENTIALS a* 
Credentials Name                  User Name             
admin                             oggadmin

OGG (not connected) 3> INFO CREDENTIALS xx*
No user credentials found matching pattern, 'xx*'. 
OGG (not connected) 4>

3.24 INFO DISTPATH

Use INFO DISTPATH to return information about distribution paths.

Syntax

INFO DISTPATH ALL path-name DETAIL
ALL

Displays a list of all distribution paths with their status.

path-name

The name of the distribution path.

DETAIL
  • Displays this additional information for the requested distribution path:

  • Process and thread information.

  • Source database name where the data is originated.

  • Last started timestamp and processing lag.

  • Current and starting input and output checkpoint.

3.25 INFO ENCRYPTIONPROFILE

Use INFO ENCRYPTIONPROFILE to return information about the encryption profile.

Syntax

INFO ENCRYPTIONPROFILE encryption-profile-name-wildcard [DETAIL ]
encryption-proifle-name-wildcarded

Displays a list of all encryption profiles.

3.26 INFO PROFILE

This command returns information about managed process profiles.

Syntax:

INFO PROFILE profile-name-wildcard

Example

OGG (https://localhost Local) 4> INFO PROFILE *

                                                Wait     Reset     Disable
Name                               Retries   Seconds   Seconds  on Failure
--------------------------------  --------  --------  --------  ----------
Default                                  9         0        60         Yes

3.27 INFO RECVPATH

Use INFO RECVPATH to return information about a target-initiated distribution paths in the Receiver Server.

Syntax

INFO RECVPATH ALL path-name DETAIL
ALL

Displays a list of all distribution paths with their status.

path-name

The name of the distribution path.

DETAIL
  • Displays this additional information for the requested distribution path:

  • Process and thread information.

  • Source database name where the data is originated.

  • Last started timestamp and processing lag.

  • Current and starting input and output checkpoint.

3.28 HEALTH DEPLOYMENT

Use to display the health of the specified Oracle GoldenGate deployments.

Syntax

HEALTH DEPLOYMENT deployment-name-wildcard
deployment-name-wildcard

The name of the deployment you are interested in. You can use an asterisk (*) wildcard for any portion of the deployment name.

Example

HEALTH DEPLOYMENT Phoenix

3.29 NOALLOWNESTED

Use the NOALLOWNESTED command to disable the use of nested OBEY files. A nested OBEY file is one that references another OBEY file.

Syntax:

NOALLOWNESTED

When you exit your Admin Client session, the next Admin Client session reverts to NOALLOWNESTED. This is the default. An attempt to run a nested OBEY file in the default mode of NOALLOWNESTED causes an error that is similar to the following:

ERROR: Nested OBEY scripts not allowed. Use ALLOWNESTED to allow nested scripts.

3.30 PURGE EXTTRAIL

Syntax

Use PURGE EXTTRAIL to remove files related to a local trail from the file system. Partial files are not deletes.

PURGE EXTTRAIL trail-name | !
trail-name

The relative or fully qualified path name of the trail.

!

(Exclamation point) Use to purge a trail that is in use by an Extract.

Example:

For example, if the trails files are:

a2000000001
a2000000002
a2000000003
a2000000004

And Extract is using the a2000000004 trail,the other three trail files are not purged. You can only purge these files after the Extract is deleted and no longer using any of the files.

3.31 RESTART DEPLOYMENT

Use RESTART DEPLOYMENT to restart the specified deployment.

Syntax

RESTART DEPLOYMENT deployment-name-wildcard
deployment-name-wildcard

The name of the deployment or a wildcard (*) to specify multiple deployments. For example, P* restarts all deployments whose names begin with P.

Example

RESTART DEPLOYMENT Phoenix

3.32 RESTART ER

Use RESTART ER to stop then start the specified wildcarded groups. ER processes that are already stopped are started.

Syntax

RESTART ER group-name-wildcard

The name of the group or a wildcard (*) to specify multiple groups. For example, T* restarts all groups whose names start with T.

3.33 RESTART EXTRACT

Use RESTART EXTRACT to stop then start an Extract group.

Syntax

RESTART EXTRACT group_name [ATCSN csn | AFTERCSN csn]
group_name

The name of an Extract group or a wildcard (*) to specify multiple groups. For example, T* starts all Extract groups whose names begin with T.

ATCSN csn | AFTERCSN csn

Specifies an alternate start point.

ATCSN

Directs Extract to position its start point at the first transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.

AFTERCSN

Directs Extract to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.

csn

Specifies a CSN value. Enter the CSN value in the format that is valid for the database. Extract abends if the format is invalid and writes a message to the report file. To determine the CSN to supply after an initial load is complete, use the serial identifier at which the load utility completed. Otherwise, follow the instructions in the initial load procedure for determining when to start Extract.

The following are additional guidelines to observe when using ATCSN and AFTERCSN:

  • The CSN is stored in the file header so that it is available to downstream processes.

  • When a record that is specified with a CSN is found, Extract issues a checkpoint. The checkpoint ensures that subsequent Extract start ups begin from the requested location, and not from a point prior to the requested CSN.

  • You must establish a physical start point in the transaction log or trail for Extract with ADD EXTRACT or ALTER EXTRACT before using ATCSN or AFTERCSN. These options are intended to be an additional filter after Extract is positioned to a physical location in the data source.

Examples

RESTART EXTRACT finance
RESTART EXTRACT finance ATCSN 684993
RESTART EXTRACT finance AFTERCSN 684993

3.34 RESTART REPLICAT

Use RESTART REPLICAT to stop then start a Replicat group. To confirm that Replicat has started, use the INFO REPLICAT or STATUS REPLICAT command.

Normal Start Point

Replicat can be started at its normal start point (from initial or current checkpoints) or from an alternate, user-specified position in the trail.

RESTART REPLICAT, without any options, causes Replicat to start processing at one of the following points to maintain data integrity:

  • After graceful or abnormal termination: At the first unprocessed transaction in the trail from the previous run, as represented by the current read checkpoint.

  • First-time startup after the group was created: From the beginning of the active trail file (seqno 0, rba 0).

Alternate Start Point

The SKIPTRANSACTION, ATCSN, and AFTERCSN options of START REPLICAT cause Replicat as a whole, or specific threads of a coordinated Replicat, to begin processing at a transaction in the trail other than the normal start point. Use these options to:

  • Specify a logical recovery position when an error prevents Replicat from moving forward in the trail. Replicat can be positioned to skip the offending transaction or transactions, with the understanding that the data will not be applied to the target.

  • Skip replicated transactions that will cause duplicate-record and missing-record errors after a backup is applied to the target during an initial load. These options cause Replicat to discard transactions that occurred earlier than the most recent set of changes that were captured in the backup. You can map the value of the serial identifier that corresponds to the completion of the backup to a CSN value, and then start Replicat to begin applying transactions from the specified CSN onward.

Syntax

RESTART REPLICAT group_name_wildcard
[SKIPTRANSACTION | {ATCSN csn | AFTERCSN csn}]
[FILTERDUPTRANSACTIONS | NOFILTERDUPTRANSACTIONS]
[THREADS (threadID[, threadID][, ...][, thread_range[, thread_range][, ...])
group_name_wildcard

The name of a Replicat group or a wildcard (*) to specify multiple groups. For example, T* starts all Replicat groups whose names begin with T.

SKIPTRANSACTION

Causes Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded.

If the MAXTRANSOPS parameter is also being used for this Replicat, it is possible that the process will start to read the trail file from somewhere in the middle of a transaction. In that case, the remainder of the partial transaction is skipped, and Replicat resumes normal processing from the next begin-transaction record in the file. The skipped records are written to the discard file if the DISCARDFILE parameter is being used; otherwise, a message is written to the report file that is similar to:

User requested START SKIPTRANSACTION. The current transaction will be skipped. Transaction ID txid, position Seqno seqno, RBA rba

SKIPTRANSACTION is valid only when the trail that Replicat is reading is part of an online change synchronization configuration (with checkpoints). Not valid for task-type initial loads (where SPECIALRUN is used with ADD REPLICAT).

ATCSN csn | AFTERCSN csn

Sets a user-defined start point at a specific CSN. When ATCSN or AFTERCSN is used, a message similar to one of the following is written to the report file:

User requested start at commit sequence number (CSN) csn-string
User requested start after commit sequence number (CSN) csn-string

General information about these options:

  • Valid only when the trail that Replicat is reading is part of an online change synchronization configuration (with checkpoints). Not valid for task-type initial loads (where SPECIALRUN is used with ADD REPLICAT).

  • To support starting at, or after, a CSN, the trail must be of Oracle GoldenGate version 10.0.0 or later, because the CSN is stored in the first trail record of each transaction. If Replicat is started with AFTERCSN against an earlier trail version, Replicat will abend and write an error to the report stating that the trail format is not supported.

    ATCSN

    Causes Replicat to start processing at the transaction that has the specified CSN. Any transactions in the trail that have CSN values that are less than the specified one are skipped.

    AFTERCSN

    Causes Replicat to start processing at the transaction that occurred after the one with the specified CSN. Any transactions in the trail that have CSN values that are less than, or equal to, the specified one are skipped.

    csn

    Specifies a CSN value. Enter the CSN value in the format that is valid for the database. See Administering Oracle GoldenGate for CSN formats and descriptions. Replicat abends if the format is invalid and writes a message to the report file. To determine the CSN to supply after an initial load is complete, use the commit identifier at which the load utility completed the load. Otherwise, follow the instructions in the initial load procedure for determining when to start Replicat.

FILTERDUPTRANSACTIONS | NOFILTERDUPTRANSACTIONS

Causes Replicat to ignore transactions that it has already processed. Use when Extract was repositioned to a new start point (see the ATCSN or AFTERCSN option of "START EXTRACT") and you are confident that there are duplicate transactions in the trail that could cause Replicat to abend. This option requires the use of a checkpoint table. If the database is Oracle, this option is valid only for Replicat in nonintegrated mode. In case of Integrated mode and automatic target trail file regeneration, the Integrated mode handles the duplicate transactions transparently. The default is FILTERDUPTRANSACTIONS.

THREADS thread_list

Valid for SKIPTRANSACTION, ATCSN, and AFTERCSN when Replicat is in coordinated mode. Not valid for RESTART REPLICAT without those options. Starts the specified Replicat thread or threads at the specified location.

thread_list

A comma-delimited list of ranges in the format of threadIDlow-threadIDhigh, threadIDlow-threadIDhigh.

!

(Exclamation point) Restarts Replicat immediately. The transaction is stopped.

Examples

RESTART REPLICAT finance

The following starts Replicat at a-specific CSN.

RESTART REPLICAT finance, ATCSN 6488359

The following causes threads 4 and 5 of a coordinated Replicat to skip the first transaction after their last checkpoint when Replicat is started. If this were a 10-thread coordinated Replicat, threads 0-3 and 6-10 would all start at the normal start point, that of their last checkpoint.

RESTART REPLICAT fin SKIPTRANSACTION THREADS(4-5)

The following example causes threads 1-3 of a coordinated Replicat to start at CSN 6488359, threads 9-10 to start after CSN 6488360, and threads 7 and 8 to skip the first transaction after its last checkpoint.

RESTART REPLICAT fin ATCSN 6488359 THREADS(1-3), AFTERCSN 6488360 THREADS(9-10), SKIPTRANSACTION THREADS(7,8)

3.35 RESTART SERVICE

Use RESTART SERVICE to restart the specified Oracle GoldenGate services.

Syntax

RESTART SERVICE service-name-wildcard
service-name-wildcard

The name of an service or a wildcard (*) to specify multiple services. Valid services are ADMINSRVR, DISTSRVR, RECVSRVR, and PMSRVR.

Example

RESTART SERVICE ADMIN*

3.36 SET COLOR

This commands allows you to enable or disable colored text in the Admin Client.

Syntax

SET COLOR ( ON | OFF )

3.37 SET DEBUG

Use SET DEBUG to enable or disable debugging mode for the Admin Client. By default, this is set by the value of the environment variable, ADMINCLIENT_DEBUG. Use the SHOW command to see the value of the SET DEBUG variable.

Syntax

SET DEBUG ON | OFF
ON

Debugging mode is enabled.

OFF

Debugging mode is disabled.

3.38 SET INSTANTIATION CSN

Use SET INSTANTIATION CSN on your target database to set the instantiation CSN manually. This command requires DBLOGIN. It enables a Replicat with the DBOPTIONS ENABLE_INSTANTIATION_FILTERING option to filter out records below the specified CSN for any object without Oracle data pump import instantiation information. It is an alternative to specifying @FILTER(@GETENV('TRANSACTION','CSN').

To enable instantiation SCN filtering, you must do the following:

  1. Your Replicat parameter file must contain DBOPTIONS ENABLE_INSTANTIATION_FILTERING.

  2. The instantiation SCNs must be set at the target database for each table.

    You can do this using one of the following two methods:

    Automatically set the source SCN by the Oracle data pump upon import if the tables were prepared at the source database using ADD TRANDATA PREPARECSN or ADD SCHEMATRANDATA PREPARECSN prior to the Oracle data pump export.

    or

    Manually set the instantiation source SCN at the target database using this command.

Syntax

SET INSTANTIATION CSN csn FOR [schema.]table FROM source_database_name
csn

The CSN number that instantiation will begin.

[schema.]table

The name of the table to set the instantiation CSN on. If no schema is provided, the DBLOGIN user is used.

source_database_name

The global name of the source database for which this is a target.

Example

SET INSTANTIATION CSN 12345678 FOR hr.employees FROM DBS1.US.COMPANY.COM

3.39 SET PAGER

Use SET PAGER to set the default text viewer program for viewing parameter and report files. By default, this is set by the value of the environment variable, PAGER, On UNIX and Linux it defaults to less and to more on Windows.

Use the SHOW command to see the value of the SET PAGER variable.

Syntax

SET PAGER command
command

Any text viewer.

Example

SET PAGER wordpad 

3.40 SET VERBOSE

This command allows you to enable or disable verbose command result output.

Syntax

SET VERBOSE (ON | OFF)

3.41 START DEPLOYMENT

Use START DEPLOYMENT to start the specified deployment.

Syntax

START DEPLOYMENT deployment-name-wildcard
deployment-name-wildcard

The name of the deployment or a wildcard (*) to specify multiple deployments. For example, T* sends the command to all deployments whose group names begin with T.

Example

START DEPLOYMENT production

3.42 START DISTPATH

Use START DISTPATH to start a distribution path. To confirm that the distribution path has started, use the INFO DISTPATH command. To change the distribution path start point, use the ALTER DISTPATH command.

Syntax

START DISTPATH path-name
path-name

The name of the distribution path.

3.43 START RECVPATH

Use START RECVPATH to start a target-initiated distribution path in the Receiver Server. To confirm that the distribution path has started, use the INFO RECVPATH command. To change the distribution path start point, use the ALTER RECVPATH command.

Syntax

START RECVPATH path-name
path-name

The name of the distribution path.

3.44 START SERVICE

Use START SERVICE to start the specified Oracle GoldenGate services.

Syntax

START SERVICE service-name-wildcard
service-name-wildcard

The name of an service or a wildcard (*) to specify multiple services. Valid services are ADMINSRVR, DISTSRVR, RECVSRVR, and PMSRVR.

Example

START SERVICE ADMIN*

3.45 STATUS DEPLOYMENT

Use STATUS DEPLOYMENT to see the status of the specified deployment.

Syntax

STATUS DEPLOYMENT deployment-name-wildcard
deployment-name-wildcard

The name of the deployment or a wildcard (*) to specify multiple deployments. For example, T* sends the command to all deployments whose group names begin with T.

Example

STATUS DEPLOYMENT production

3.46 STATS DISTPATH

Use the STATS DISTPATH command to get the statistics for a distribution paths.

Syntax

STATS DISTPATH path-name
path-name

The name of the distribution path.

3.47 STATS RECVPATH

Use the STATS RECVPATH command to get the statistics for a target-initiated distribution path in the Receiver Server.

Syntax

STATS RECVPATH path-name
path-name

The name of the target-initiated distribution path.

3.48 STATUS SERVICE

Use STATUS SERVICE to display status of the specified Oracle GoldenGate services.

Syntax

STATUS SERVICE service-name-wildcard
service-name-wildcard

The name of an service or a wildcard (*) to specify multiple services. For example, T* statuses all services whose names begin with T.

3.49 STOP DEPLOYMENT

Use STOP DEPLOYMENT to stop one or more deployments.

Syntax

STOP DEPLOYMENT deployment_name_wildcard [!]
deployment_name_wildcard

The name of the deployment or a wildcard (*) to specify multiple deployments. For example, P* sends the command to all deployments whose group names begin with P.

!

(Exclamation point) Stops the deployment immediately. The transaction is aborted and the process terminates.

Example

STOP DEPLOYMENT production

3.50 STOP DISTPATH

Use STOP DISTPATH to start a distribution path and attempt to cleanup the resource. To confirm that the distribution path has stopped, use the INFO DISTPATH command. To change the distribution path start point, use the ALTER DISTPATH command.

Syntax

STOP DISTPATH path_name [ALL | !]
path_name

The name of the deployment or a wildcard (*) to specify multiple deployments. For example, P* sends the command to all deployments whose group names begin with P.

ALL

Use to stop all distribution paths.

!

(Exclamation point) Bypasses the prompt that confirms the intent to stop the Performance Metrics Server.

3.51 STOP RECVPATH

Use STOP RECVPATH to stop a target-initiated distribution path in the Receiver Server. To confirm that the distribution path has stopped, use the INFO RECVPATH command. To change the distribution path start point, use the ALTER RECVPATH command.

Syntax

STOP RECVPATH path_name [ALL | !]
path_name

The name of the deployment or a wildcard (*) to specify multiple deployments. For example, P* sends the command to all deployments whose group names begin with P.

ALL

Use to stop all target-initiated distribution paths.

!

(Exclamation point) Stops a target-initiated distribution path immediately. The transaction is aborted and the process terminates.

3.52 STOP SERVICE

Use STATUS SERVICE to stop the specified Oracle GoldenGate services.

Syntax

STOP SERVICE service_name_wildcard
service_name_wildcard

The name of an service or a wildcard (*) to specify multiple services. For example, T* statuses all services whose names begin with T.

3.53 VIEW DISCARD

Use VIEW DISCARD to display the discard file that is generated by Extract or Replicat. The SET PAGER value is used to determine pagination of the output.

Syntax

VIEW DISCARD report-name

report-name

The name of the report to display the discard file. For EXTRACT "EXX", these report names are valid:

  - EXX
  - EXX0
  - EXX1
  - ...
  - EXX9

No other values are valid.

3.54 VIEW GLOBALS

Use VIEW GLOBALS to display the contents of the GLOBALS parameter file in read-only mode on-screen. The SET PAGER value is used to determine pagination of the output.

Syntax

VIEW GLOBALS

3.55 VIEW MESSAGES

Use VIEW MESSAGES to display the message log file, ggserr.log. The SET PAGER value is used to determine pagination of the output.

Syntax

VIEW MESSAGES