Add an Extract for MySQL

Extract is a process that runs agains the source data source connection and extracts, or captures, data. Learn to add an Extract for MySQL Database Server, HeatWave on OCI, Azure Database for MySQL, HeatWave on AWS, Amazon Aurora MySQL, Amazon RDS for MySQL, Amazon RDS for MariaDB, Google Cloud SQL for MySQL, SingleStoreDB, SingleStoreDB Cloud, HeatWave on AWS, and HeatWave on Azure technologies.

Before you begin

Before adding and running an Extract, ensure that you prepare and configure the system for Oracle GoldenGate.

Add a Replicat (23ai)

Before you begin

Ensure that you add a Checkpoint table for the Replicat to restart without recapturing reapplying transactions should a discruption occur.

  1. In the OCI GoldenGate deployment console, expand DB Connections, and select your target database.
  2. Click Add Checkpoint (plus icon).
  3. For Checkpoint Table, enter the target schema name, and then click Submit.
To add a Replicat for MySQL in GoldenGate 23ai:
  1. In the Administration Service navigation menu, click Replicats.
  2. On the Replicats page, click Add Replicat (plus icon).
  3. The Add Replicat form consists of four pages. Complete the form as needed:
    1. On the Replicat Information page:
      1. Select a Replicat type:
        • Classic Replicat
        • Coordinated Replicat
        • Parallel Replicat
        Note

        Learn about different Replicat types.
      2. Click Next.
    2. On the Replicat Options page:
      1. Enter the Replicat trail details:
        • Name (can only be two characters)
        • Subdirectory
      2. Select the Target Credentials:
        • Domain
        • Alias
        • Checkpoint Table
        • (Optional) When to Begin
      3. Enter the Trail Position Sequence Number and RBA Offset.
      4. Click Next.
    3. On the Managed Options page, complete the optional fields as needed:
      1. Select a Profile Name.
      2. Enable Critical to deployment health.
      3. Enable Auto Start.
      4. Enable Auto Restart.
      5. Click Next.
    4. On the Parameter File page, you can configure how the Replicat maps the source and target tables. For example:
      MAP table.*, TARGET table.*;
  4. Click Create and Run to start the Replicat. If you click Create, you can manually start the Replicat later on the Replicats page.
You return to the Replicats page, where you can select the Replicat to view its details.

Add an Extract (21c)

Before adding and running an Extract, ensure that you prepare and configure the system for Oracle GoldenGate.

To add an extract for MySQL database in Oracle GoldenGate 21c:
  1. In the OCI GoldenGate deployment console, ensure that you're on the Administration Service Overview page, and then click Add Extract (plus icon).
  2. On the Add Extract page, for Extract Type, select one of the following, and then click Next.
    • Change Data Capture
    • Initial Load
  3. On the Extract Options page, under Basic Information, complete the fields as needed:
    1. For Process Name, enter a name for the Extract process, up to 8 characters.
    2. (Optional) For Description, enter a brief description to help you distinguish this process from others.
    3. For Intent, select the option that best describes the purpose of this Extract:
      • Unidirectional (default)
      • Disaster Recovery
      • N-Way
    4. Enable Remote only if capturing data from a MySQL database that doesn't use global transaction identifiers (GTIDs).
    5. For Credential Domain, select Oracle GoldenGate.
    6. For Credential Alias, select your source MySQL connection.
    7. For Trail Name, enter a two character name for the Trail file.
    8. (Optional) For Trail Subdirectory, set a custom location for the generated Trail file.
    9. (Optional) For Trail Size, set the max size for the generated trail file.
  4. (Optional) Under Encryption Profile, enter the encryption profile description. The Local Wallet profile is selected by default if an encryption profile wasn't created.
    1. Select the profile name from the dropdown. You can select the Local Wallet or a custom profile.
    2. Select the encryption profile from the dropdown.
    3. Specify the masterkey for the encryption profile.
  5. (Optional) Under Managed Options, you can configure the following:
    • Profile Name
    • Auto Start
    • Auto Restart
    Note

    Adding a profile and configuring Auto Start and Auto Restart options enables your deployment to restart automatically after a network disruption. See Configure managed processes for more information.
  6. Click Next.
  7. On the Extract Parameters page, you can edit the parameter file in the text area to list the table details to capture. For example:
    table source.table1;
    Note

    GoldenGate uses Greenwich Mean Time (GMT) by default. Use SETENV to override the default setting for the Extract. This change applies only to the Extract process and not the deployment.
    setenv (TZ="US/Eastern")
    setenv (TZ="GMT+5")

    Learn more about SETENV.

  8. Select Register Extract in the background to register the Extract in the background asynchronously.
  9. Click Create and Run to create and start the Extract. If you click Create, then you can manually start Extract later from the Administration Service Overview page.
You're returned to the Administration Service Overview page, where you can view the status of the Extract process. Select Details from the Extract Action menu to view process information, checkpoint, statistics, paramters, and reports.

Learn more

Interested in learning more about the Extract process and capturing data? See:

Known Issues

Remote change data capture Extracts fail for GTID enabled databases

When you create a Change Data Capture Extract process with the Remote option enabled for a MySQL database that uses global transaction identifiers (GTIDs), the Extract process fails and the following error is reported:
ERROR   OGG-25192  Trail file '<trail name>' is remote. Only local trail allowed for this extract.

Workaround: On the Parameter file screen of the Change Data Capture Extract, remove the line, TRANLOGOPTIONS ALTLOGDEST REMOTE.

For more information, see Using Oracle GoldenGate for MySQL.