1. Command Line Interface Reference for Oracle GoldenGate
  2. GGSCI Command Line Interface Commands
  3. ALTER REPLICAT

ALTER REPLICAT

Use ALTER REPLICAT to change the attributes of a Replicat group that was created with the ADD REPLICAT command. Before using this command, stop Replicat by issuing the STOP REPLICAT command. If this is a coordinated Replicat group, the ALTER takes effect for all threads unless the threadID option is used.

For example, if you create a coordinated Replicat RCORD, it may spawn threads RCORD001, RCORD002, RCORD003, and so on. With GGSCI, you can run a command like ALTER REPLICAT RCORD002 and change just a single thread.

Note:

ALTER REPLICAT does not support switching from regular Replicat mode to coordinated mode. You must stop processes, make certain all of the en route data is applied to the target, roll the trail to a new trail, drop and recreate the Replicat group in coordinated mode, and then start the processes again.

Syntax

 ALTER REPLICAT
          group-name|
          [, PARALLEL [, INTEGRATED] | INTEGRATED | COORDINATED [MAXTHREADS number]]
           ]|
          option [, . . .]
          {, SPECIALRUN                   |                 
          EXTFILE         file-name  |                 
          EXTTRAIL        trail-name }                
         [, PARAMS file_name]
         [, REPORT file_name]
         [, BEGIN           {NOW | yyyy-mm-dd[ hh:mi:[ss[.cccccc]]]}]                 
         [, EXTSEQNO        trail-sequence-number, EXTRBA trail-offset-number ]
         [, DESC            description ]|
         [, ENCRYPTIONPROFILE encryption-profile-name ]|
         [, CRITICAL        [ YES | NO ]  ]|
         [, PROFILE         profile-name|
         [, AUTOSTART       [ YES | NO ]|
         [, DELAY           delay-number ] ]|                
         [, AUTORESTART     [ YES | NO ]|                  
         [, RETRIES          retries-number ]|           
         [, WAITSECONDS      wait-number    ]|           
         [, RESETSECONDS     reset-number   ]|                  
         [, DISABLEONFAILURE [ YES | NO ]     ] ] ] 
}
group_name[threadID]

The name of the Replicat group or a thread of a coordinated Replicat that is to be altered. To specify a thread, use the full thread name, such as ALTER REPLICAT exte, EXTSEQNO 53.

If a thread ID is not specified, the ALTER takes effect for all threads of the Replicat group.

option [, . . .]

Use this to change any description or service option that was configured with the ADD REPLICAT command, except for the CHECKPOINTTABLE and NODBCHECKPOINT options.

There is no option to alter a Replicat with CHECKPOINTTABLE to replicate with or without CHECKPOINTTABLE. However, if you are switching from integrated to nonintegrated Replicat, you can use a nonintegrated Replicat without a checkpoint table, as shown in the following example:
ADD REPLICAT repe, INTEGRATED, EXTTRAIL ea, ggadmin.ggs_checkpoint
ALTER REPLICAT repe, NONINTEGRATED, CHECKPOINTTABLE ggadmin.ggs_checkpoint
PARALLEL

Oracle only.

Adds the Replicat in parallel mode. In this mode, Replicat applies transactions in parallel to improve the performance. It takes into account dependencies between transactions. PARALLEL INTEGRATED Replicat is valid for Oracle only. It adds the parallel Replicat in integrated mode, which like Integrated Replicat leverages the apply processing functionality that is available within the Oracle Database.

INTEGRATED

Switches Replicat from non-integrated mode to integrated mode. Transactions currently in process are applied before the switch is made, see Switching Replicat from Integrated Mode to Nonintegrated Mode.

NONINTEGRATED, CHECKPOINTTABLE owner.table

(Oracle) Switches Replicat from integrated mode to non-integrated mode.

For CHECKPOINTTABLE, specify the owner and name of a checkpoint table. This table must be created with the ADD CHECKPOINTTABLE command before issuing ALTER EXTRACT with NONINTEGRATED, see Deciding Which Apply Method to Use for more information about integrated Replicat.

SPECIALRUN

Creates a Replicat special run as a task. Either SPECIALRUN, EXTFILE, or EXTTRAIL is required. When Extract is in SPECIALRUN mode, do not start Replicat with the START REPLICAT command. Do not use this option with the INTEGRATED or COORDINATED option.

EXTFILE file_name

Specifies the relative or fully qualified name of an extract file that is specified with RMTFILE in the Extract parameter file. Do not use this option with the INTEGRATED option.

EXTTRAIL trail_name

Specifies the relative or fully qualified name of a trail that was created with the ADD RMTTRAIL or ADD EXTTRAIL command.

BEGIN {NOW | yyyy-mm-dd[ hh:mm[:ss[.cccccc]]]}

Defines an initial checkpoint in the trail.

NOW

Begins replicating changes from the time when the group is created.

yyyy-mm-dd[ hh:mm[:ss[.cccccc]]]

Begins extracting changes from a specific time.

EXTSEQNO sequence_number

Specifies the sequence number of the file in a trail in which to begin processing data. Specify the sequence number, but not any zeroes used for padding. For example, if the trail file is \aa000000026, you would specify EXTSEQNO 26. If not specified, the default value is zero.

By default, processing begins at the beginning of a trail unless this option is used. To use EXTSEQNO, you must also use EXTRBA. Contact Oracle Support before using this option.

EXTRBA rba

Specifies the relative byte address within the trail file that is specified by EXTSEQNO. Contact Oracle Support before using this option.

PARAMS file_name

Specifies a parameter file in a location other than the default of dirprm within the Oracle GoldenGate directory. Specify the fully qualified path name.

REPORT file_name

Specifies the full path name of a process report file in a location other than the default of dirrpt within the Oracle GoldenGate directory.

DESC 'description'

Specifies a description of the group, such as 'Loads account_tab on Serv2'. Enclose the description within quotes. You can use either the abbreviated keyword DESC or the full word DESCRIPTION.

ENCRYPTIONPROFILE
Specifies the name of the encryption profile for the Replicat.
CRITICAL

Indicates if the process is critical for the deployment.

PROFILE

There are options to select the Default or Custom profiles, if you've created one using the Profile page in Distribution Service.

AUTOSTART

Select this option to start the process when starts.

DELAY

Time to wait in seconds before starting the process.

AUTORESTART

Controls how the process will be restarted if it terminates.

RETRIES

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

WAITSECONDS
Specifies the time to wait before performing the retries.
RESETSECONDS
Resets the time for waiting.for retries.
DISABLEONFAILURE

If this option is enabled, then the task is disabled when the number of retries is exhausted.

Examples

ALTER REPLICAT repe, EXTSEQNO 53
ALTER REPLICAT repe, EXTRBA 0
ALTER REPLICAT repe, BEGIN 2011-01-07 08:00:00
ALTER REPLICAT repe, INTEGRATED
ALTER REPLICAT repe, NONINTEGRATED, CHECKPOINTTABLE ggadmin.ggs_checkpoint
ALTER REPLICAT repw, EXTSEQNO 53