Preface

The Oracle GoldenGate Microservices Documentation contains the Oracle GoldenGate Microservices concepts, tasks, advance tasks, security, and other reference information.

Audience

This guide is intended for system administrators and database users to learn about Oracle GoldenGate Microservices. It is assumed that readers are familiar with web technologies and have a general understanding of Windows and UNIX platforms.

Related Information

The Oracle GoldenGate Product Documentation is available from the following location:

Oracle GoldenGate Documentation

Oracle GoldenGate for Distributed Applications and Analytics

Oracle GoldenGate for Distributed Applications and Analytics

For OCI GoldenGate, refer to:

OCI GoldenGate

For details on Oracle Database High Availability, see:

Oracle Database High Availability

Conventions

The following text conventions are used in this document:

Convention Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, such as "From the File menu, select Save." Boldface also is used for terms defined in text or in the glossary.

italic

italic

Italic type indicates placeholder variables for which you supply particular values, such as in the parameter statement: TABLE table_name. Italic type also is used for book titles and emphasis.

monospace

MONOSPACE

Monospace type indicates code components such as user exits and scripts; the names of files and database objects; URL paths; and input and output text that appears on the screen. Uppercase monospace type is generally used to represent the names of Oracle GoldenGate parameters, commands, and user-configurable functions, as well as SQL commands and keywords.

UPPERCASE

Uppercase in the regular text font indicates the name of a process or utility unless the name is intended to be a specific case. Keywords in upper case (ADD EXTRACT, ADD EXTTRAIL, FORMAT RELEASE).

LOWERCASE

Names of processes to be written in lower case. Examples: ADD EXTRACT exte, ADD EXTRAIL ea.

{ }

Braces within syntax enclose a set of options that are separated by pipe symbols, one of which must be selected, for example: {option1 | option2 | option3}.

[ ]

Brackets within syntax indicate an optional element. For example in this syntax, the SAVE clause is optional: CLEANUP REPLICAT group_name [, SAVE count]. Multiple options within an optional element are separated by a pipe symbol, for example: [option1 | option2].

Sample Locations

Compass directions such as east, west, north, south to be used for demonstrating Extract and Replicat locations.

Datacenters names to use the standard similar to dc1, dc2.

Group names

Prefixes for each process, as follows:
  • Extract: ext. Usage with location: extn, where n indicates 'north' compass direction.

  • Replicat: rep. Usage with location: repn, where n indicates 'north' compass direction.

  • Distribution Path: dp. Usage with location: dpn, where n indicates 'north' compass direction.

  • Checkpoint table: ggs_checkpointtable

  • Trail file names: e or d depending on whether the trail file is for the Extract or distribution path. Suffix derived in alphabetical order. Usage for an Extract trail file: ea, eb, ec.

  • Trail file subdirectory: The name will use compass directions to refer to the trail subdirectories. Example for trail subdirectory name would be /east, /west, /north, /south.