ADD REPLICAT
Use ADD REPLICAT
to create a Replicat group. Unless
SPECIALRUN
is specified, ADD REPLICAT
creates
an online process group that creates checkpoints so that processing continuity is
maintained from run to run.
This command cannot exceed 500 bytes in size for all keywords and input,
including any text that you enter for the DESC
option.
Oracle GoldenGate supports up to 5,000 concurrent Extract and Replicat
groups per instance of Oracle GoldenGate Service Manager. At the supported level,
all groups can be controlled and viewed in full using commands such as the
INFO
and STATUS
commands.
Oracle GoldenGate recommends keeping the number of Extract and Replicat groups (combined) at the default level of 300 or below in order to manage your environment effectively.
(Oracle) Unless the INTEGRATED
option is used, this
command creates a Replicat group in non-integrated mode.
Syntax
ADD REPLICAT group_name
[, PARALLEL [, INTEGRATED] | INTEGRATED | COORDINATED [MAXTHREADS number]]
{, SPECIALRUN |
, EXTFILE file_name |
, EXTTRAIL trail_name}
[, BEGIN {NOW | yyyy-mm-dd[ hh:mi:[ss[.cccccc]]]
}]
[, EXTRBA rba]
{, CHECKPOINTTABLE owner.table}
[, 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
-
The name of the Replicat group. If you don't specify any option, then it creates a classic Replicat. The name of a coordinated and parallel Replicat group can contain a maximum of five characters. The name of a regular Replicat group can contain up to eight characters.
-
INTEGRATED
-
(Oracle) Creates the Replicat in integrated mode. Without this option,
ADD REPLICAT
creates the Replicat in non-integrated (classic) mode. This option works for parallel Replicat too. In this mode, the Replicat process leverages the apply processing functionality that is available within the Oracle Database. In this mode, Replicat operates as follows:-
Reads the Oracle GoldenGate trail.
-
Performs data filtering, mapping, and conversion.
-
Constructs logical change records (LCR) that represent source database DML or DDL transactions (in committed order).
-
Attaches to a background process in the target database known as a database inbound server by means of a lightweight streaming interface.
-
Transmits the LCRs to the inbound server, which applies the data to the target database.
-
A Replicat in integrated mode (either normal integrated or parallel integrated) must be used if any of the following features are used:
-
Automatic conflict detection and resolution
-
Procedural replication
-
DML or DDL Handlers
-
Do not use
INTEGRATED
with theSPECIALRUN
orEXTFILE
options.INTEGRATED
must be used for an online change-synchronization Replicat that reads from a localEXTTRAIL
-specified trail.Both integrated Replicat and parallel Replicat in integrated mode maintain the checkpoint table if it exists. Also see
ADD CHECKPOINTTABLE
.TRACETABLE
is not maintained by integrated Replicat or parallel Replicat in integrated mode.When in integrated mode, Replicat does not support the following parameters:
-
BULKLOAD
(Do not use integrated Replicat as an initial-load Replicat.) -
SPECIALRUN
-
GENLOADFILES
-
SHOWSYNTAX
-
MAXTRANSOPS
(is ignored)
-
-
PARALLEL
-
Valid for Oracle, SQL Server, MySQL, Db2, TimesTen, PostgreSQL, and Teradata.
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. -
COORDINATED [MAXTHREADS number]
-
Creates the Replicat in coordinated mode. A coordinated Replicat is multithreaded to enable parallel processing. This option adds the coordinator (identified by the group name) and the maximum number of processing threads that are specified by default or with
MAXTHREADS
. Dependencies are computed and coordinated by the coordinator, and the SQL processing is performed by the threads.To create a
COORDINATED
Replicat, a checkpoint table is required.Do not use
COORDINATED
with theSPECIALRUN
orEXTFILE
options.COORDINATED
must be used for an online change-synchronization Replicat that reads from a localEXTTRAIL
-specified trail.Note:
The group name of a coordinated Replicat can contain only five characters.-
MAXTHREADS number
-
Specifies the maximum number of processing threads that this Replicat group can spawn. These threads are all created on startup, but depending on what is specified in the
MAP
statements in the parameter file, some or all of these threads will process the workload at any given time. As a general rule, specify twice the number of threads that you specify in theMAP
statements when you partition the workload. This allows you to add threads in the event that the workload increases, without having to drop and recreate the Replicat group, seeTABLE | MAP
for more information about how to partition the workload across threads.The default number of threads is 25 if
MAXTHREADS
is omitted. The maximum number of threads is 500.MAXTHREADS
has a relationship to theMAXGROUPS
parameter.MAXGROUPS
controls the maximum number of process groups (Extract and Replicat) allowed per instance of Oracle GoldenGate. Each Replicat thread is considered a Replicat group in the context ofMAXGROUPS
. Therefore, the number of Extract and Replicat groups in the Oracle GoldenGate instance, plus the value ofMAXTHREADS
, cannot exceed the value ofMAXGROUPS
, seeMAXGROUPS
-
-
SPECIALRUN
-
Creates a Replicat special run as a task. Either
SPECIALRUN
, EXTFILE
, orEXTTRAIL
is required. When Extract is inSPECIALRUN
mode, do not start Replicat with theSTART REPLICAT
command. Do not use this option with theINTEGRATED
orCOORDINATED
option.-
EXTFILE file_name
-
Specifies the relative or fully qualified name of an extract file that is specified in the Extract parameter file. Do not use this option with the
INTEGRATED
Replicat. -
EXTTRAIL trail_name
-
Specifies the relative or fully qualified name of a trail that was created with the
ADD RMTTRAIL
orADD EXTTRAIL
command.
-
-
BEGIN {NOW | yyyy-mm-ddT[ hh:mm[:ss[.cccccc]]]Z}
-
Defines an initial checkpoint in the trail.
-
EXTRBA extrba
-
Valid for Db2 z/OS.
Specifies the relative byte address within the trail file that is specified by
EXTSEQNO
. Contact Oracle Support before using this option. -
CHECKPOINTTABLE owner.table | NODBCHECKPOINT}
-
Not valid for Oracle GoldenGate Applications Adapter or Oracle GoldenGate Big Data.
NODBCHECKPOINT
is not valid for target Oracle database.Oracle strongly recommends using a checkpoint table. Parallel and coordinated Replicat in integrated and non-integrated mode require a checkpoint table.Specifies that this Replicat group will write checkpoints to the specified table in the database. Include the owner and table name, as in
ggadmin.ggs_checkpoint
. This argument overrides any defaultCHECKPOINTTABLE
specification in theGLOBALS
file. The table must first be added with theADD CHECKPOINTTABLE
command.When
NODBCHECKPOINT
is specified, the Replicat group will not write checkpoints to a checkpoint table. This argument overrides any defaultCHECKPOINTTABLE
specification in theGLOBALS
file. This argument is required if you do not want to use a checkpoint table with the Replicat group that is being created. -
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 keywordDESC
or the full wordDESCRIPTION
. -
ENCRYPTIONPROFILE
- Specifies the name of the encryption profile for the Replicat.
Examples
repe
. The output is displayed using the INFO
command.ADD REPLICAT repe, INTEGRATED, EXTTRAIL ea
2019-11-21T20:01:10Z INFO OGG-08100 REPLICAT (Integrated) added.
reps
.ADD REPLICAT repe, INTEGRATED, PARALLEL, EXTTRAIL ea, checkpointtable ggadmin.ggs_checkpoint
2019-11-21T20:07:26Z INFO OGG-08100 REPLICAT (Parallel) added.