Coordinator commands

Use Coordinator commands to establish a Coordinator group to monitor distributed network transactions. COORD is an alias for COORDINATOR in these commands.

ADD COORDINATOR

Use ADD COORDINATOR to add the process that will communicate with each node's Reader and Replicat processes to coordinate the application of distributed network transactions.

Syntax

ADD COORDINATOR group_name
[, CPU primary_cpu] 
[, BACKUPCPU cpu] 
[, PRI priority]
[, PROCESS process_name] 
[, PARAMS param_file_name] 
[, PROGRAM program_name] 
[, REPORT report_name] 
[, DESC "text"]
group_name

The group name.

CPU primary_cpu

The primary CPU on which Coordinator runs. The default is the CPU on which Manager runs.

BACKUPCPU cpu

An alternative CPU on which Coordinator runs if the primary CPU becomes unavailable.

PRI priority

The NonStop priority for the process. This defaults to the NonStop priority assigned to the TACL process underlying the ADD.

PROCESS process_name

The default process name is $GGCnn, where nn represents the sequence of the process. Oracle GoldenGate recommends that you use the default, however, if you must specify an alternative process, you can do so with the PROCESS process_name option.

PARAMS param_file_name

Specifies the alternative parameter file name to be used. Enter the fully qualified path name for the parameter file.

PROGRAM program_name

Specifies the name of the program that Manager assigns when starting the process. Typically this is not entered, and Manager uses the default $GGCnn name. The HOST parameter in the GLOBALS file determines the location of the default program.

REPORT report_name

Supplies an alternative report file name. The default report file name is install_volume.GGSRPT.rpt_name, where rpt_name represents the group name, such as FINANCE. Oracle GoldenGate creates an entry-sequenced file to hold each group's run results, and by default, the report name is the same as the group name.

DESC "text"

Describes the Coordinator group.

Example

ADD COORDINATOR TRXCO, CPU 2, PRI 150, DESC "Network transaction coordinator for NY, FL, and LA"

ALTER COORDINATOR

Use ALTER COORDINATOR to change the checkpoints for an or to change the properties of an existing Coordinator group. You can use ALTER COORDINATOR to change the attribute of any option that you specified with ADD COORDINATOR.

Syntax

ALTER COORDINATOR group_name
[ trail_name
{BEGIN time |, EXTSEQNO seq_number, EXTRBA rba}]
[, options]
group_name

The group name.

| SOURCE {BEGIN time | , EXTSEQNO seq_number , EXTRBA rba}

Specifies the starting point in the Oracle GoldenGate trail as a beginning time, transaction sequence, or relative byte address. The specified must match one of the trails defined in the Coordinator parameter file.

options

The ADD COODINATOR options can be altered with this command. See ADD COORDINATOR for details.

Example

ALTER COORDINATOR TRXCO, CPU 1, PRI 180

DELETE COORDINATOR

Use DELETE COORDINATOR to remove a stopped Coordinator process from the system. DELETE COORDINATOR group_name removes the group and all checkpoints. Using the trail_name option deletes only the trail checkpoints, not the group.

Syntax

DELETE COORDINATOR group_name
[ trail_name]
group_name

The group name. Using this option without the deletes the group and all trail checkpoints.

trail_name

Deletes only the checkpoint.

Example

DELETE COORDINATOR TRXCO

INFO COORDINATOR

Use INFO COORDINATOR to display information on the attributes of the Coordinator.

Syntax

INFO COORDINATOR group_name
[, DETAIL]
[, SHOWCH]
[, PROGRAM]
group_name

The group name.

DETAIL

Reports Coordinator process run history, which includes starting and stopping points within the trail expressed as a time and the process parameters established by the ADD COORDINATOR command.

The default is to report the status of the Coordinator process (STARTING, RUNNING, STOPPED or ABENDED).

SHOWCH

Shows detailed historical checkpoints.

PROGRAM

Displays the name and location of the object that is running.

Example

The following is displayed from the command INFO COORD TRXCO 

Coord   TRXCO         Last Started 2010-12-01 15:59  Status RUNNING
Process  $GGC00       Checkpoint Lag: unknown
Checkpoints:
    Trail                  Time                         Seqno         RBA
\NY.$DATA1.GGSDAT.Z1    Updated at 2010-12-01 16:00:22.950722
                          2010-11-17 12:22:46.657637       0            0
                          2010-11-17 12:22:46.657637       0         1779
\LA.$DATA1.GGSDAT.EX    Updated at 2010-12-01 16:00:22.950722
                          2010-12-01 15:55:39.664490       0            0
                          2010-12-01 16:00:11.437578       3    148578373

SEND COORDINATOR

Use SEND COORDINATOR to send a command to a running Coordinator process. Using SEND COORDINATOR you can perform the operations summarized in the table below.

Syntax

SEND COORDINATOR group_name {
GETREADERINFO | 
GETTRANSINFO |
FORCECOMMIT transaction_id |
STATUS |
STOP}
group_name

The group name.

GETREADERINFO

Displays information about the Reader processes and the trails being read.

GETTRANSINFO

Displays information on pending transactions.

FORCECOMMIT transaction_id

Allows the transaction to be committed even though not all required trails have received the entire transaction. If a network connection is lost, for example, the parts of the transaction that are available can be committed.

Note: The ramifications of committing the partial transaction should be considered carefully before using FORCECOMMIT.

STATUS

Displays the current status of the Coordinator process.

STOP

Terminates the run gracefully. This command is preferable to stopping from TACL, which results in an ABEND status.

Examples

Example 1   

An example of a display from SEND COORD TRXCO GETTRANSINFO: 

  279: 0 TransID 7926335489872297987  2010/11/17 12:22:47.068460
     Pending, Needed 2, Found 1, RefCount 1
     Bitmap 8000 0000 0000
  813: 0 TransID 7926335489872232451  2010/11/17 12:22:46.947382
     Pending, Needed 2, Found 1, RefCount 1
     Bitmap 8000 0000 0000
  825: 0 TransID 7926335489872363523  2010/11/17 12:22:47.317281
     Pending, Needed 2, Found 1, RefCount 1
     Bitmap 8000 0000 0000
  909: 0 TransID 7926335489872166915  2010/11/17 12:22:46.769463
     Pending, Needed 2, Found 1, RefCount 1
     Bitmap 8000 0000 0000
 1701: 0 TransID 7926335489872101379  2010/11/17 12:22:46.657637
     Pending, Needed 2, Found 1, RefCount 1
     Bitmap 8000 0000 0000
Example 2   

An example of a display from SEND COORD TRXCO GETREADERINFO: 

Reader Information
 0 : \NY.$DATA1.GGSDAT.Z1, \NY.$ZRDR1, Node 109, POS 0,1779
     FastReads  Retries 0
     Current Transactions 5
     Oldest 7926335489872101379  2010/11/17 12:22:46.657637  0,1779
     Newest 7926335489872363523  2010/11/17 12:22:47.317281  0,4280
CurTransCount      5, LastRec 2010/12/01 16:01:34.104281
 Records           14, Bytes          924, Transactions           5
 1 : \LA.$DATA1.GGSDAT.EX, \LA.$ZRDR2, Node 109, POS 4,218437395
     FastReads  Retries 0
     No Current Transactions
CurTransCount      0, LastRec 2010/12/01 16:01:36.233081
 Records           11, Bytes          704, Transactions            0
Totals
Reader Requests           21, Records           25
Commit Requests            0
Force Commit 0
Example 3   

An example of a display from SEND COORD TRXCO FORCECOMMIT 7926335489872297987: 

TransID '7926335489872297987' set committable

START COORDINATOR

Use START COORDINATOR to start the Coordinator process. GGSCI routes the START request to Manager to start and monitor the process.

START COORDINATOR uses the READER option in Coordinator parameter file to identify the Reader processes that must be started and the trails that will be monitored. The following is an example of such a file. 

COORDINATOR TRXCO
FASTREADS
READER  \NY.$DATA5.GGSDAT.AA, PROCESS $GGRD1, CPU 1, PRI 180
READER  \LA.$DATA01.GGSDAT.BB, PROCESS $GGRD2
READER  \FL.$DATA2.GGSDAT.CC, CPU 1, PRI 170

In this example, starting the TRXCO Coordinator will start three Reader processes, each monitoring a trail on one of the three nodes, \NY, \LA, and \FL.

Syntax

START COORDINATOR group_name
group_name

The group name. You can use wildcards to specify a set of group names, such as, * or TRX*.

Example

START COORD TRXCO

STATUS COORDINATOR

Use STATUS COORDINATOR to determine if the Coordinator is running. A report displays to the Coordinator process's home terminal.

Syntax

STATUS COORDINATOR group_name [, DETAIL]
group_name

The group name. You can use wildcards to specify a set of group names, such as, * or TRX*.

DETAIL

When you specify DETAIL, (STATUS COORD *, DETAIL) checkpoint details are displayed. The default is to display the group_name, the status of the process and the process name.

Example

The following is an example display resulting from the command STATUS COORD TRXCO. 

COORD    TRXCO      RUNNING (\NY.$GGC00)    ( 0,616 )  (140)

STOP COORDINATOR

Use STOP COORDINATOR to stop the Coordinator process gracefully.

Syntax

STOP COORDINATOR group_name
group_name

The group name.