1.17 Miscellaneous commands

The following commands control various other aspects of Oracle GoldenGate.

1.17.1 ! command

Use the ! command to run a previous GGSCI command without modifications. To modify a command before reexecuting it, use the FC command. To display a list of previous commands, use the HISTORY command.

Issuing the ! command without arguments reexecutes the most recently used command. By using options, you can reexecute a specific command by specifying its line number or a text substring.

Syntax

! [number | -number | string]
number

Reexecutes the command on the specified GGSCI line. Each GGSCI command line is sequenced, beginning with 1 at the start of the session.

-number

Reexecutes the command issued number lines before the current line.

string

Reexecutes the last command that starts with the specified text string.

Examples

Example 1   
! 9
Example 2   
! -3
Example 3   
! sta

1.17.2 ENV

Use ENV to return information about the current run-time environment. This is based on the current settings for the GLOBALS parameters.

Syntax

ENV 

Example

The following display illustrates the information returned for the ENV request.

Version                       192.0.2.2 H06 2010/05/14
Prefix                        $GG
System                        \NY
Programs                      \NY.$DATA1.GGS1040
Params                        \NY.$DATA1.GGSPARM
Report                        \NY.$DATA1.GGSRPT
LogFileOpens                  1
Manager Mandatory             Yes
Hometerm messages             Yes
SWAPVOL                       $DATA1
Reply timeout                 3000
TMF Refresh Interval          900
Current defines
=GGS_AUDCFG             CLASS MAP, FILE \NY.$DATA1.GGS.HHCFG
=GGS_PREFIX             CLASS MAP, FILE \NY.$GG
=_DEFAULTS CLASS DEFAULTS, VOLUME \NY.$DATA1.GGS8040

1.17.3 FC

Use FC to edit a previously issued GGSCI command and then reexecute it. Previous commands are stored in the memory buffer and you can display them by issuing the HISTORY command. The FC command is the same as standard NonStop FIX command functionality.

Issuing FC without arguments retrieves the most recently used command. By using options, you can retrieve a specific command by specifying its line number or a text substring. Previous commands can only be edited for the current command-line session, because command history is not maintained from session to session.

Using the editor

The FC command displays the specified command and then opens an editor with a prompt containing a blank line starting with two dots. Use the space bar to position the cursor beneath the character in the displayed command where you want to begin editing, and then enter one of the following arguments. Arguments are not case-sensitive and can be combined.

Table 1-1 FC editor commands

Argument Description
i text

Inserts text. For example:

GGSCI> fc 9
GGSCI> send mgr
GGSCI..        i childstatus
GGSCI> send mgr childstatus
r text

Replaces text. For example:

GGSCI> fc 9
GGSCI> info mgr
GGSCI..     rextract ggfin
GGSCI> info extract ggfin
d

Deletes a character. To delete multiple characters, enter a d for each one. For example:

GGSCI> fc 10
GGSCI> info extract ggfin, detail
GGSCI..                  dddddddd
GGSCI> info extract ggfin
replacement_text

Replaces the displayed command with the text that you enter on a one-for-one basis. For example:

GGSCI> fc 10
GGSCI> info mgr
GGSCI..     extract ggfin
GGSCI> info extract ggfin

To execute the command, press Enter twice, once to indicate there are no more changes and once to issue the command. To cancel an edit, type a slash (/) twice.

Syntax

FC [number | -number | string]
number

Returns the command from the specified line. Each GGSCI command line is sequenced, beginning with 1 at the start of the session.

-number

Returns the command that was issued number lines before the current line.

string

Returns the last command that starts with the specified text string.

Examples

Example 1   
FC 9
Example 2   
FC -3
Example 3   
FC sta

1.17.4 HELP

Use HELP to view information about specific commands. For example, HELP displays information about the ADD REPLICAT command.

For a summary page displaying all commands and objects, enter the single command: HELP.

Syntax

HELP command object 
command object

The command you need help with, such as ADD REPLICAT.

1.17.5 HISTORY

Use HISTORY to view a list of the commands issued in GGSCI. Previous commands are stored in GGSCIHST, an edit file located on the NonStop user's saved volume. Command history from each session of GGSCI remains available until the data is manually deleted from this file.

Note:

To clear the history, you can use TACL> WHO to find the saved volume for the user and then edit the GGSCIHST stored there.

You can use the ! command or the FC command to reexecute a command in the list. This command is the same as standard NonStop HISTORY command functionality.

Syntax

HISTORY [number]
number

Returns the last number commands, where number is any positive number.

Example

HISTORY 7

The result of this command would be similar to:

1: start manager
2: status manager
3: info manager
4: send manager childstatus
5: start extract ggfin
6: info extract ggfin
7: history

1.17.6 INFO ALL

Use INFO ALL to display a summary of the status and lag, where relevant, for each Oracle GoldenGate process. This display includes information for Manager, Extract, Replicat, Logger, and Syncfile.

Use INFO ALL to show the status of all active tasks and processes in the system. Use the SYSTEM command to address multiple systems at the same time.

Syntax

INFO ALL, [DETAIL | TASKS | ALLPROCESSES]
DETAIL

Reports process run history.

TASKS | ALLPROCESSES

Shows either tasks or all processes that are running. Specify either TASKS or ALLPROCESSES.

1.17.7 LOG

Using the LOG command, you can save the results of your GGSCI session to an output file. Use LOG to identify where to direct the session output. You can direct output to an edit file, spooler file, or a process name. Any new output will be appended to the file if it already exists.

Syntax

LOG {file_name | process_name | spooler}
file_name

The name of the output file.

process_name

The name of the process.

spooler

The name of the spooler.

1.17.8 LOG STOP

Use the LOG STOP command to close the session output.

Syntax

LOG STOP

1.17.9 OBEY

Use OBEY to process a file that contains a list of Oracle GoldenGate commands. OBEY is useful for executing commands that are frequently used in sequence. This command provides standard NonStop OBEY file functionality.

Syntax

OBEY file_name
file_name

The name of the file containing the list of commands.

Example

OBEY $DATA01.GGSPARM.FINANCE

1.17.10 EDIT PARAMS

EDIT PARAMS launches an editor from GGSCI.

Syntax

EDIT PARAMS file_name
file_name

Specify a parameter file name. If the file name is unqualified, EDIT assumes the parameter file resides in the Oracle GoldenGate home volume: install_volume.GGSPARM.

1.17.11 VIEW PARAMS

VIEW PARAMS displays the named parameter file to your screen. Use the scrolling commands described in Table 1-2 to scroll through the file.

Syntax

VIEW PARAMS file_name
file_name

Specify a parameter file name. If the file name is unqualified, VIEW assumes the parameter file resides in the Oracle GoldenGate home volume: install_volume.GGSPARM.

Table 1-2 Scrolling commands

Command Description
return

Go to the next page.

/string

Search for next occurrence of string in file.

number

Go to line indicated by number.

l

Go to last page of file.

b

Go backward one page in file.

q

Quit display.

h

Help.

1.17.12 SYSTEM

The SYSTEM command enables you to manage Oracle GoldenGate processes from a single point of control. Use SYSTEM to switch the reference point from the local system to one or more remote systems, and then back again when needed. After making another system current, you can execute any command, subject to security constraints specified in the CMDSEC file on the remote system.

To enable the SYSTEM command, enter a HOST specification in the GLOBALS parameter file for each remote system with which you intend to communicate. The HOST entry requires the NonStop system name and GGSSUBVOL specification. These parameters identify and start GGSCI sessions on the remote systems.

Syntax

SYSTEM {system [, system] | ALL}
system

The NonStop system to make current. Omitting a system name defaults to the local system.

ALL

Makes all systems current.

Example

If Extract is running on the local system and Replicat is running on the remote system, the following commands would obtain information on each running process.

  1. Get information about all Extract processes at \LA:

    GGSCI (\LA) > INFO EXTRACT *
    
  2. Switch to \NY:

    GGSCI (\LA) > SYSTEM \NY
    
  3. Get information about Replicats at \NY:

    GGSCI (\NY) > INFO REPLICAT *
    
  4. Switch back to \LA (omitting system name defaults to local system):

    GGSCI (\NY) > SYSTEM
    

Example

You can address multiple systems at the same time:

  1. Make the current systems \LA and \NY:

    GGSCI (\NY) > SYSTEM \LA, \NY
    
  2. Get information about Extract and Replicat processes on both systems:

    GGSCI (\LA, \NY) > INFO ER *
    

1.17.13 VIEW GGSEVT

This command enables you to scroll through the Oracle GoldenGate event file (LOGGGS). This file contains event timestamps, text, program names and processes in chronological sequence.The LOGGGS file also includes a history of commands entered through GGSCI. Although this information is also recorded in the HP NonStop Event Management System (EMS), using VIEW GGSEVT is sometimes more convenient.

Syntax

VIEW GGSEVT 
[, ASC | DESC] 
[, TIME timestamp]
[, program] 
[, event] [, SEARCH string]
ASC | DESC

ASC sorts the log in ascending order by time. DESC, the default, sorts entries in descending order.

TIME timestamp

Provides a starting point to look for event records. timestamp is expressed as yyyy-mm-dd hh:mi (for example 2014-03-31 12:30).

program

Specify a program name to filter for events related only to that program: EXTRACT, REPLICAT, LOGGER, SYNCFILE, MANAGER, or GGSCI.

event

Specify one of: START, STOP (includes ABEND events), or ABEND.

SEARCH string

Searches for string in the log message. string must not contain spaces or be enclosed in quotes. You can specify multiple SEARCH string entries. If any string is found, the record is displayed.

GGSCI will display the events and then prompt: enter or q?

enter

Enter additional options for another GGSEVT display.

q

Exit GGSEVT and return to GGSCI.