6 Configuring Capture in Integrated Mode

This chapter contains instructions for configuring the Oracle GoldenGate capture process to capture transaction data in integrated mode.

Note:

To switch an active Extract configuration from classic to integrated mode, perform these configuration steps and then see Administering Oracle GoldenGate.

Topics:

6.1 Prerequisites for Configuring Integrated Capture

You must adhere to the guidelines provided in this topic before configuring an Extract in integrated mode.

The guidelines for configuring an Extract in integrated mode are:
  1. Preparing the Database for Oracle GoldenGate.

  2. Establishing Oracle GoldenGate Credentials.

  3. Choosing Capture and Apply Modes.

  4. Create the Oracle GoldenGate instance on the source system by configuring the Manager process. See Administering Oracle GoldenGate.

  5. Additionally, review the guidelines in Administering Oracle GoldenGate.

6.2 What to Expect from these Instructions

These instructions show you how to configure a basic Extract parameter (configuration) file for the primary Extract, which captures transaction data from the data source, and for a data-pump Extract, which propagates captured data that is stored locally in a trail from the source system to the target system.

Your business requirements probably will require a more complex topology, but this procedure forms a basis for the rest of your configuration steps.

By performing these steps, you can:

  • get the basic configuration files established.

  • build upon them later by adding more parameters as you make decisions about features or requirements that apply to your environment.

  • use copies of them to make the creation of additional parameter files faster than starting from scratch.

6.3 Configuring the Primary Extract in Integrated Capture Mode

The mining database, from which the primary Extract captures log change records from the logmining server, can be either local or downstream from the source database.

These steps configure the primary Extract to capture transaction data in integrated mode from either location. See Configuring a Downstream Mining Database and Example Downstream Mining Configuration for more information about capturing from a downstream mining database.

Note:

One Extract group is generally sufficient to capture from a single database or multiple pluggable databases within a multitenant container database. See Configuring Oracle GoldenGate in a Multitenant Container Database.

  1. In GGSCI on the source system, create the Extract parameter file.
    EDIT PARAMS name
    

    Where: name is the name of the primary Extract.

  2. Enter the Extract parameters in the order shown, starting a new line for each parameter statement. Examples are shown for a regular database and a multitenant container database. The difference between the two is whether you must use two-part or three-part object names in the TABLE and SEQUENCE specifications. See the Basic Parameters for primary Extract (classic or integrated mode) for more information and parameter descriptions.

    Basic parameters for Extract where mining database is a downstream database and is a regular database. and is a regular database with source ADG used for FETCH

    EXTRACT financep
    USERIDALIAS tiger1
    LOGALLSUPCOLS
    UPDATERECORDFORMAT COMPACT
    DDL INCLUDE MAPPED
    ENCRYPTTRAIL AES192
    EXTTRAIL /ggs/dirdat/lt
    SEQUENCE hr.employees_seq;
    TABLE hr.*;
    

    Basic parameters for Extract where mining database is a downstream database and is a multitenant container database with source ADG used for FETCH

    EXTRACT financep
    USERIDALIAS tiger1
    LOGALLSUPCOLS
    UPDATERECORDFORMAT COMPACT
    DDL INCLUDE MAPPED SOURCECATALOG pdb1 INCLUDE MAPPED SOURCECATALOG pdb2
    ENCRYPTTRAIL AES192
    EXTTRAIL /ggs/dirdat/lt
    TABLE test.ogg.tab1;
    SOURCECATALOG pdb1
    SEQUENCE hr.employees_seq;
    TABLE hr.*;
    SOURCECATALOG pdb2
    TABLE sales.*;
    TABLE acct.*;
    

    Basic parameters for Extract where the mining database is a downstream database and is a regular database

    EXTRACT financep
    USERIDALIAS tiger1 
    TRANLOGOPTIONS MININGUSERALIAS tiger2 
    TRANLOGOPTIONS INTEGRATEDPARAMS (MAX_SGA_SIZE 164, & 
       DOWNSTREAM_REAL_TIME_MINE y)
    LOGALLSUPCOLS
    UPDATERECORDFORMAT COMPACT
    DDL INCLUDE MAPPED
    ENCRYPTTRAIL AES192
    EXTTRAIL /ggs/dirdat/lt
    SEQUENCE hr.employees_seq;
    TABLE hr.*;
    

    Basic parameters for the primary Extract where the mining database is a downstream database and is a multitenant container database

    EXTRACT financep
    USERIDALIAS tiger1 
    TRANLOGOPTIONS MININGUSERALIAS tiger2 
    TRANLOGOPTIONS INTEGRATEDPARAMS (MAX_SGA_SIZE 164, & 
       DOWNSTREAM_REAL_TIME_MINE y)
    LOGALLSUPCOLS
    UPDATERECORDFORMAT COMPACT
    DDL INCLUDE MAPPED SOURCECATALOG pdb1 INCLUDE MAPPED SOURCECATALOG pdb2
    ENCRYPTTRAIL AES192EXTTRAIL /ggs/dirdat/lt
    TABLE test.ogg.tab1;
    SOURCECATALOG pdb1
    SEQUENCE hr.employees_seq;
    TABLE hr.*;
    SOURCECATALOG pdb2
    TABLE sales.*;
    TABLE acct.*;
    
    Parameter Description
    EXTRACT group
    

    group is the name of the Extract group. For more information, see Reference for Oracle GoldenGate.

    USERIDALIAS alias
    

    Specifies the alias of the database login credential of the user that is assigned to Extract. This credential must exist in the Oracle GoldenGate credential store.

    LOGALLSUPCOLS

    Writes all supplementally logged columns to the trail, including those required for conflict detection and resolution and the scheduling columns required to support integrated Replicat. (Scheduling columns are primary key, unique index, and foreign key columns.) You configure the database to log these columns with GGSCI commands. See Establishing Oracle GoldenGate Credentials.

    UPDATERECORDFORMAT COMPACT

    Combines the before and after images of an UPDATE operation into a single record in the trail. This parameter is valid for Oracle Databases version 12c and later to support Replicat in integrated mode. Although not a required parameter, UPDATERECORDFORMAT COMPACT is a best practice and significantly improves Replicat performance. See Reference for Oracle GoldenGate for more information.

    TRANLOGOPTIONS MININGUSERALIAS alias

    Specifies connection information for the logmining server at the downstream mining database, if being used.

    MININGUSERALIAS specifies the alias of the Extract user for the downstream mining database. This is the user that you created in Configuring a Downstream Mining Database. The credential for this user must be stored in the Oracle GoldenGate credential store. See Administering Oracle GoldenGate for more information.

    Use MININGUSERALIAS only if the database logmining server is in a different database from the source database; otherwise just use USERIDALIAS. When using MININGUSERALIAS, use it in addition to USERIDALIAS, because credentials are required for both databases.

    TRANLOGOPTIONS [INTEGRATEDPARAMS (parameter[, ...])]
    

    Optional, passes parameters to the Oracle Database that contains the database logmining server. Use only to change logmining server parameters from their default settings. See Additional Parameter Options for Integrated Capture.

    TRANLOGOPTIONS CHECKPOINTRETENTIONTIME days

    Optional, controls the number of days that Extract retains checkpoints before purging them automatically. Partial days can be specified using decimal values. For example, 8.25 specifies 8 days and 6 hours. For more information, see Reference for Oracle GoldenGate.

    DDL include_clause

    Required if replicating DDL operations. See Configuring DDL Support for more information.

    ENCRYPTTRAIL algorithm
    

    Encrypts the local trail. For more information about Oracle GoldenGate trail encryption options, see Administering Oracle GoldenGate.

    EXTTRAIL pathname
    

    Specifies the path name of the local trail to which the primary Extract writes captured data. For more information, see Reference for Oracle GoldenGate

    SOURCECATALOG container

    Use this parameter when the source database is a multitenant container database. Specifies the name of a pluggable database that is to be used as the default container for all subsequent TABLE and SEQUENCE parameters that contain two-part names. This parameter enables you to use two-part object names (schema.object) rather than three-part names (container.schema.object). It remains in effect until another SOURCECATALOG parameter is encountered or a full three-part TABLE or SEQUENCE specification is encountered.

    {TABLE | SEQUENCE} [container.]schema.object;
    

    Specifies the database object for which to capture data.

    • TABLE specifies a table or a wildcarded set of tables.

    • SEQUENCE specifies a sequence or a wildcarded set of sequences.

    • container is the name of the pluggable database (PDB) that contains the object, if this database is a multitenant container database. The container part of the name is not required if this Extract group will only process data from one PDB and the default PDB is specified with the SOURCECATALOG parameter.

    • schema is the schema name or a wildcarded set of schemas.

    • object is the table or sequence name, or a wildcarded set of those objects.

    See Administering Oracle GoldenGate for information about how to specify object names with and without wildcards.

    Terminate the parameter statement with a semi-colon.

    To exclude a name from a wildcard specification, use the CATALOGEXCLUDE, SCHEMAEXCLUDE, TABLEEXCLUDE, and EXCLUDEWILDCARDOBJECTSONLY parameters as appropriate.

    For more information and for additional TABLE options that control data filtering, mapping, and manipulation, see Reference for Oracle GoldenGate.

    MAPINVISIBLECOLUMNS

    Controls whether or not Replicat includes invisible columns in Oracle target tables for default column mapping. Configure the invisible columns in your column mapping using SQL to explicitly specify column names. For example:

    CREATE TABLE tab1 (id NUMBER, data CLOB INVISIBLE);
       INSERT INTO tab1 VALUES (1, 'a');ERROR: ORA-913
       INSERT INTO tab1 (id, data) VALUES (1, 'a'); OK
    

    You can change the column visibility using ALTER TABLE. The invisible column can be part of an index, including primary key and unique index.

  3. Enter any optional Extract parameters that are recommended for your configuration. You can edit this file at any point before starting processing by using the EDIT PARAMS command in GGSCI. For more information, see the Reference for Oracle GoldenGate.
  4. Save and close the file.

6.4 Configuring the Data Pump Extract

A data pump can perform data filtering, mapping, and conversion, or it can be configured in pass-through mode, where data is passively transferred as-is, without manipulation.

These steps configure the data pump that reads the local trail and sends the data across the network to a remote trail. The data pump is optional, but recommended.

  1. In GGSCI on the source system, create the data-pump parameter file.
    EDIT PARAMS name
    

    Where: name is the name of the data pump Extract.

  2. Enter the data-pump parameters in the order shown, starting a new line for each parameter statement. Your input variables will be different.

    Basic parameters for the data-pump Extract group using two-part object names:

    EXTRACT extpump
    USERIDALIAS tiger1
    RMTHOST fin1, MGRPORT 7809 ENCRYPT AES192, KEYNAME securekey2
    RMTTRAIL /ggs/dirdat/rt
    SEQUENCE hr.employees_seq;
    TABLE hr.*;
    

    Basic parameters for the data-pump Extract group using three-part object names (including a pluggable database):

    EXTRACT extpump
    USERIDALIAS tiger1
    RMTHOST fin1, MGRPORT 7809 ENCRYPT AES192, KEYNAME securekey2
    RMTTRAIL /ggs/dirdat/rt
    TABLE test.ogg.tab1;
    SOURCECATALOG pdb1
    SEQUENCE hr.employees_seq;
    TABLE hr.*;
    SOURCECATALOG pdb2
    TABLE sales.*;
    TABLE acct.*;
    
    Parameter Description
    EXTRACT group
    

    group is the name of the data pump Extract. For more information, see Reference for Oracle GoldenGate.

    USERIDALIAS alias
    

    Specifies the alias of the database login credential of the user that is assigned to Extract. This credential must exist in the Oracle GoldenGate credential store.

    RMTHOST hostname,
    MGRPORT portnumber,
    [, ENCRYPT algorithm
    KEYNAME keyname]
    
    • RMTHOST specifies the name or IP address of the target system.

    • MGRPORT specifies the port number where Manager is running on the target.

    • ENCRYPT specifies optional encryption of data across TCP/IP.

    For additional options and encryption details, see Reference for Oracle GoldenGate.

    RMTTRAIL pathname
    

    Specifies the path name of the remote trail. For more information, see Reference for Oracle GoldenGate.

    SOURCECATALOG container

    Use this parameter when the source database is a multitenant container database. Specifies the name of a pluggable database that is to be used as the default container for all subsequent TABLE and SEQUENCE parameters that contain two-part names. This parameter enables you to use two-part object names (schema.object) rather than three-part names (container.schema.object). It remains in effect until another SOURCECATALOG parameter is encountered or a full three-part TABLE or SEQUENCE specification is encountered. Use this parameter when the source database is a multitenant container database. See Reference for Oracle GoldenGate for more information about SOURCECATALOG.

    {TABLE | SEQUENCE} [container.]schema.object;
    

    Specifies a table or sequence, or multiple objects specified with a wildcard. In most cases, this listing will be the same as that in the primary Extract parameter file.

    • TABLE specifies a table or a wildcarded set of tables.

    • SEQUENCE specifies a sequence or a wildcarded set of sequences.

    • container is the name of the root container or pluggable database that contains the table or sequence, if this source database is a multitenant container database. See the SOURCECATALOG description in this table.

    • schema is the schema name or a wildcarded set of schemas.

    • object is the name of a table or sequence, or a wildcarded set of those objects.

    See Administering Oracle GoldenGate for information about how to specify object names with and without wildcards.

    Terminate this parameter statement with a semi-colon.

    To exclude tables or sequences from a wildcard specification, use the TABLEEXCLUDE or SEQUENCEEXCLUDE parameter after the TABLE statement.

    For more information and for additional TABLE options that control data filtering, mapping, and manipulation, see Reference for Oracle GoldenGate.

  3. Enter any optional Extract parameters that are recommended for your configuration. You can edit this file at any point before starting processing by using the EDIT PARAMS command in GGSCI.
  4. Save and close the file.

6.5 Next Steps

A parameter file is a plain text file that is read by an associated Oracle GoldenGate process. Oracle GoldenGate uses two types of parameter files: a GLOBALS file and runtime parameter files.