Oracle Cloud Infrastructure Documentation

Add an Extract for Microsoft SQL Server

Extract is a process that runs agains the source data source connection and extracts, or captures, data. Learn to add an Extract for SQL Server technologies, such as Microsoft SQL Server, Azure SQL Managed Instance, Azure SQL Database, Amazon RDS for SQL Server, and Google Cloud SQL for SQL Server.

Add an Extract in Oracle GoldenGate 23ai

Before you add and run an Extract, ensure that you prepare your database for Oracle GoldenGate.
To add an Extract in Oracle GoldenGate 23ai:
  1. In the Administration Service navigation menu, click Extracts.
  2. On the Extracts page, click Add Extract (plus icon).
  3. The Add Extract form consists of four pages. Complete the Add Extract form as needed:
    1. On the Extract Information page:
      1. Select an Extract type:
        • Change Data Capture Extract
        • Initial Load Extract
      2. Enter a Process Name.
      3. (Optional) Enter a Description.
      4. Click Next.
    2. On the Extract Options page:
      1. Select when to Begin:
        • Now
        • Custom time
        • Position in Log
        • End of Log
      2. Enter the Extract Trail details:
        • Name (can only be two characters.)
        • Subdirectory
        • Trail Size
        • Trail Sequence
        • Trail offset
      3. Select the Source Credentials Domain and Alias from the dropdowns.
      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, 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")
  4. Click Create and Run to start the Extract. If you click Create, you can manually start the Extract later from the Extracts page.
You return to the Extracts page, where you can select the Extract process to view its details.

Add an Extract for Microsoft SQL Server in Oracle GoldenGate 21c

Before adding and running an extract, ensure that you prepare and configure your database for Oracle GoldenGate.
To add an extract for Microsoft SQL Server database:
  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 Credential Domain, select Oracle GoldenGate.
    4. For Intent, select the option that best describes the purpose of this Extract:
      • Unidirectional (default)
      • Disaster Recovery
      • N-Way
    5. For Credential Alias, select your source Microsoft SQL Server connection.
    6. For Trail Name, enter a two character name for the Trail file.
    7. (Optional) For Trail Subdirectory, set a custom location for the generated Trail file.
    8. (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.