Table of Contents

• Title and Copyright Information
• Preface
  • Audience
  • Documentation Accessibility
  • Related Information
  • Conventions
• Oracle GoldenGate 26ai: What’s New
• About Oracle GoldenGate
  • About Oracle GoldenGate Microservices Architecture
    • Features of Oracle GoldenGate Microservices Architecture
    • Access Points for Oracle GoldenGate Microservices
      • Admin Client
      • Microservices Web Interface
      • REST API
    • About Deployments
      • What is a Deployment?
      • Secure Deployment
      • Non-Secure Deployment
      • Local and Remote Deployments
  • Why Do You Need Oracle GoldenGate?
  • When Do You Use Oracle GoldenGate?
  • Real-time Access to Real-time Information
  • Topologies for Oracle GoldenGate
  • Real-time Data Integration Across the Enterprise and Cloud
  • Oracle GoldenGate Product Family
  • Components of Oracle GoldenGate Microservices Architecture
    • About Service Manager
    • About Administration Server
    • About Distribution Service
    • About Receiver Server
    • About Receiver Service Path
    • About Performance Metrics Service
  • About Data Replication Components in Oracle GoldenGate
    • Types of Data Replication Configurations
    • Oracle GoldenGate Processes
      • Extract
      • Replicat
      • Distribution Paths for Data Transport
    • Oracle GoldenGate Objects
      • Trail Files
        • Processes that Write to the Trail File
        • Processes that Read from the Trail File
        • Trail File Creation and Maintenance
      • Parameter Files
      • Checkpoint Files and Tables
        • Checkpoint Usage by Extract, Path, and Replicat
        • Path Checkpoint
        • Replicat Checkpoint
  • Directories and Variables in Microservices Architecture
    • Installation Directories and Programs in Oracle GoldenGate Microservices Architecture
    • Deployment Directories in Oracle GoldenGate Microservices Architecture
  • Oracle GoldenGate Security Features
• About Oracle GoldenGate AI Service
  • Oracle GoldenGate AI Use Cases
  • Vector Data Modeling
  • Advantages of Real-Time Vector Embedding Over Batch Processing
• Get Started
  • Download Oracle GoldenGate Software
  • Verify Certification and System Requirements
  • Operating System Requirements
    • Memory Requirements
    • Oracle GoldenGate Security Privileges
    • Disk Requirements
    • Network Requirements
    • Operating System Privileges
    • Windows Console Character Sets
  • Other Programs and Settings
  • Prerequisites for Installing Oracle GoldenGate for Db2 LUW
    • Choosing an Installation System for Db2 LUW
    • Choosing and Configuring a System for Remote Capture or Delivery
  • Prerequisites for Installing Oracle GoldenGate for Db2 for i
    • General Requirements
    • Choosing an Installation Operating System
    • Supported ODBC Driver
  • Prerequisites for Installing Oracle GoldenGate for Db2 z/Os
    • Choose an Operating System for Installing Oracle GoldenGate for Db2 z/OS Remote Capture and Delivery
  • Prerequisites for Installing Oracle GoldenGate for MySQL
    • Install OpenSSL on Linux
  • Prerequisites for Installing Oracle GoldenGate for Oracle
  • Prerequisites for Installing Oracle GoldenGate for SQL Server
  • Prerequisites for Installing Oracle GoldenGate for Sybase
  • Prerequisites for Installing Oracle GoldenGate for Teradata
  • Prerequisites for Installing Oracle GoldenGate for TimesTen
  • Prerequisites for Installing Oracle GoldenGate Remote Capture and Delivery
• Install, Patch, and Upgrade
  • Installing Oracle GoldenGate
    • Installing Oracle GoldenGate Microservices Architecture
      • Performing an Interactive Installation with OUI for MA
      • Performing a Silent Installation with OUI
    • Integrating Oracle GoldenGate Microservices Architecture into a Cluster
  • Post-installation Tasks
    • Set Environment Variables for Oracle GoldenGate for Db2 z/OS
  • Patching Oracle GoldenGate
    • Downloading Patches for Oracle GoldenGate
    • Patching Using OPatch
    • Post-Patch Installation Tasks for Non-Oracle Databases
      • Post-Patching Tasks for Oracle GoldenGate for SQL Server
    • Uninstalling Patches Using OPatch
  • Upgrade
    • Obtaining the Oracle GoldenGate Distribution
    • Prerequisites
      • Oracle GoldenGate Upgrade Considerations
        • Installation Binaries and Deployments
        • Security Considerations
        • Service Manager and Deployments
        • Extract Upgrade Considerations
        • Replicat Upgrade Considerations
          • Trail File Considerations
    • Pre-upgrade Steps
    • Upgrade Oracle GoldenGate Microservices – GUI Based
    • Upgrade Oracle GoldenGate Microservices Using REST APIs
    • Post-Upgrade Steps
  • Migrate from Classic to Microservices Architecture Using the Migration Utility
    • Prerequisites for Using the Migration Utility
      • Migration Utility Restrictions
    • Run the Migration Utility
    • Different Use Cases for Migration
      • Migrating Source from Classic to Microservices with Target as Microservices
      • Migrate Target from Classic to Microservices where Source is Microservices
      • Migrating Target from Classic to Microservices with Source as Classic
  • Uninstalling Oracle GoldenGate Microservices Architecture
    • Removing Deployments and Service Manager
      • Removing Deployments and Service Manager Using Oracle GoldenGate Configuration Assistant
      • Using Oracle GoldenGate Configuration Assistant - Silent
    • Files to be Removed Manually
    • Uninstalling Microservices Architecture with Oracle Universal Installer
    • Uninstalling Microservices Architecture Using Silent Mode
• Secure
  • Secure Deployments
    • Secure Deployments Using Certificates
      • Create RootCA and Server Certificates
        • Create Trusted RootCA Certificates
        • Create Server Certificates
      • Add External Trusted RootCA and Distribution Client Certificates
        • Create a RootCA External Certificate in the Target Deployment
        • Create a Distribution Client Certificate
    • Secure Deployment Using Reverse Proxy
      • Prerequisites for Using ReverseProxySettings
      • Run the ReverseProxySettings Utility to Configure NGINX
  • Authentication in Oracle GoldenGate
    • Authenticate Users with Credentials
    • Authenticate Users and Deployments with Certificates
      • Authenticate Users with Certificates
      • Authenticate Deployments with Certificates
    • Authenticate Databases for Oracle GoldenGate
      • Configure Kerberos Authentication
  • Authorization in Oracle GoldenGate
    • Grant User Roles for Authorization
    • User Management based on User Roles
    • Delegate User Management to an External Identity Provider
      • Configure IAM for Oracle GoldenGate
        • Example: Oracle GoldenGate Authorization Profile
      • Configure OAM for Oracle GoldenGate
        • Example of OAM Application Configuration and Oracle GoldenGate Authorization Profile
          • Creating an Identity Domain
          • Create Resource Server
          • Creating an Application
          • Create an Authorization Profile in Oracle GoldenGate for the OAM Application
      • Configure Microsoft Azure EntraID for Oracle GoldenGate
        • Add Root CA Certificate for Microsoft EntraID Azure
    • Database Authentication for Oracle GoldenGate
      • Database Authentication
      • Kerberos Authentication
        • Configure Kerberos Authentication
          • Implement and Use a Kerberos Account to Access Oracle Database from Oracle GoldenGate
          • Configure Kerberos Authentication with MA
          • Example: Using USERIDALIAS in Parameter File for Kerberos Account
  • Trail File Encryption (Data at Rest)
    • Why Use KMS to Store Oracle GoldenGate Encryption Keys?
    • Encryption Support for Cached Files
    • Encryption Support for Persisted BR Files
    • Prerequisites for Setting up an Encryption Profile
    • Using the Local Wallet Encryption Profile
    • Using Oracle Key Vault Trail File Encryption in Oracle GoldenGate
      • Oracle Key Vault Capabilities
      • Prerequisites for Configuring GoldenGate Encryption Profile Using Oracle Key Vault
      • Client Behavior Against Different Key States for Oracle Key Vault
      • Apply the OKV Encryption Profile
    • Using OCI KMS Trail File Encryption in Oracle GoldenGate
      • Oracle GoldenGate with OCI KMS Workflow
      • Prerequisites for Connecting Oracle GoldenGate with OCI KMS
        • Download the CA Certificate using the Cryptographic Endpoint
        • Add the Digital CA Certificate as a Trusted CA Certificate in Oracle GoldenGate
      • Configure OCI KMS to Connect with Oracle GoldenGate
        • Create or Access the OCI Vault
        • Generate the Master Key and Download the API Private Key
      • Configure Oracle GoldenGate Processes to Enable OCI KMS Trail File Encryption
        • Create Encryption Profile in Oracle GoldenGate Processes
        • Apply the OCI KMS Encryption Profile for Extract
      • Test Data Replication with Trail File Encryption Using OCI KMS
        • Test Trail File Encryption in the Source Deployment
        • Test the Trail File Decryption on the Target Deployment
    • Using the Plugin Service for Trail File Encryption
      • Setup Plugin Service and Build the Plugin
      • Create Plugin Template in the Service Manager
      • Create the Plugin Encryption Profile from the Administration Service
  • Secure Communication Using TLS and mTLS Support (Data in Transit)
    • How Transport Layer Security Works in an Oracle Environment: The TLS Handshake
    • How Does Oracle GoldenGate Use Transport Layer Security for Authentication
    • TLS Cipher Suites
    • Target-initiated Path
  • Accountability
  • Auditing and Logging
    • Structure of the Log Files
    • Service Manager Deployment Logs
    • User Deployment Logs
  • Miscellaneous
    • FIPS 140-2
  • Implementing Security in Oracle GoldenGate
• Deploy
  • Add a Deployment
    • Before Adding a Deployment
    • Start the OGGCA Wizard
    • Select Service Manager Options
    • Service Manager Administrator Account
    • User Deployment
    • User Deployment Administrator
    • Summary
    • Configure Deployment
    • Finish
  • Add a Deployment to an Existing Service Manager
  • Add a Deployment in Silent Mode using OGGCA
  • Connect to the Deployment from the Web Interface
  • Start and Stop the Service Manager
  • Remove a Deployment
    • Before Removing the Deployment
    • Start OGGCA to Remove Deployment
  • Remove the Service Manager
    • Start OGGCA to Remove the Service Manager
    • Files to be Removed Manually After Removing Deployment
• Manage Deployments
  • Add Users to a Deployment
    • Edit Users
  • Change the Administrator User Password Registered with XAG for a Deployment
  • Manage Certificates for Deployments
    • Add Client Certificate
    • Add a CA Certificate
    • Apply Certificates to an Oracle GoldenGate Deployment
    • Check Details of Certificates Used in a Deployment
    • Replace Certificates in a Deployment
  • Create an Authorization Profile
  • Test the Authorization Profile
  • Switch Between States for a Deployment and Microservices
    • Change the State of a Deployment
    • Change the State of Microservices in a Deployment
  • Access Configuration and Log Details from the Service Manager and Microservices
  • Manage the Debug Log
    • Enable Debug Logging
    • Use the Debug Log
• Prepare
  • Prepare Databases
    • Db2 LUW
      • Prepare Database Users and Privileges for Db2 LUW
      • Prepare Database Connection, System, and Parameter Settings
      • Prepare Tables for Processing
        • Disabling Triggers and Cascade Constraints
        • Ensuring Row Uniqueness for Tables
        • Preventing Key Changes
        • Maintaining Materialized Query Tables
        • Creating a Temporal Table
          • Convert to a Temporal Table
          • Replicating with Temporal Tables
      • Configuring the Transaction Logs for Oracle GoldenGate
        • Retaining the Transaction Logs
        • Specifying the Archive Path
      • Db2 LUW: Supported Data Types, Objects, and Operations
        • Supported Db2 LUW Data Types
        • Non-Supported Db2 LUW Data Types
        • Supported Objects and Operations for Db2 LUW
        • Non-Supported Objects and Operations for Db2 LUW
        • System Schemas
        • Supported Object Names
    • Db2 for i
      • Prepare Database Users and Privileges for Db2 for i
      • Prepare Database Connection, System, and Parameter Settings
        • Enabling SSL
        • Port Requirements for Db2 for i
      • Preparing the Journals for Data Capture by Extract
        • Allocating Journals to an Extract Group
        • Setting Journal Parameters
        • Deleting Old Journal Receivers
        • Using Remote Journal
          • Preparing to Use Remote Journals
          • Adding a Remote Journal
          • What Happens During Add Remote Journal Processing?
          • Guidelines For Adding a Remote Journal
      • Prepare Tables for Processing
        • Ensuring Row Uniqueness for Tables
          • Using KEYCOLS to Specify a Custom Key
        • Preventing Key Changes
        • Disabling Constraints on the Target
        • Maintaining Materialized Query Tables
      • Db2 for i: Supported Data Types, Objects, and Operations
        • Supported Db2 for i Data Types
        • Non-Supported Db2 for i Data Types
        • Supported Objects and Operations for Db2 for i
        • Non-Supported Objects and Operations for DB2 for i
        • Oracle GoldenGate Parameters Not Supported for DB2 for i
        • Supported Object Naming Conventions
        • System Schemas for DB2 for i
        • Supported Character Sets
    • Db2 z/OS
      • Prepare Database Users and Privileges for Db2 z/OS
      • Prepare Database Connection
        • Specifying the Number of Connection Threads
        • Ensuring ODBC Connection Compatibility
      • Database Configuration
        • Install Extract Components on Db2 z/OS
        • Use Shared Memory Manager for Extract
        • Support Globalization Functions
          • Replicating From a Source that Contains Both ASCII and EBCDIC
          • Specifying Multi-Byte Characters in Object Names
      • Prepare Tables for Processing
        • Disable Triggers and Cascade Constraints
        • Ensure Row Uniqueness for Tables
          • Using KEYCOLS to Specify a Custom Key
        • Handle Tables with ROWID Columns
        • Maintaining Materialized Query Tables
      • Prepare Db2 z/OS Transaction Logs for Oracle GoldenGate
        • Enable Access to Log Records
        • Size and Retain Logs
        • Use Archive Logs on Tape
        • Control Log Flushes
      • Db2 z/OS: Supported Data Types, Objects, and Operations
        • Supported Db2 z/OS Data Types
        • Non-Supported Db2 for z/OS Data Types
        • Supported Objects and Operations for Db2 z/OS
        • Non-Supported Objects and Operations for Db2 z/OS
    • Google Spanner
    • MySQL
      • Prepare Database Users and Privileges for Oracle GoldenGate for MySQL
      • Prepare Database Connection
        • Configure a Two-way SSL Connection for MySQL Extract and Replicat
      • Database Configuration
        • Supported Databases
          • Limitations of Support
        • Database Storage Engine
        • Database Character Set
        • Set the Session Character Set
        • Transaction Log Settings and Requirements
          • Configuring Logging Properties
          • Ensuring Data Availability
          • Capturing Against a MySQL Replication Replica
        • Configure MySQL for Remote Capture
      • Prepare Tables for Processing
        • Ensure Row Uniqueness for Tables
          • Tables with a Primary Key Derived from a Unique Index
          • Specify Your Own Key for Oracle GoldenGate to Use
        • Limit Row Changes in Tables That Do Not Have a Key
        • Triggers and Cascade Constraints Considerations
          • Triggers
          • Cascade Constraints Considerations
      • MySQL: Supported Data Types, Objects, and Operations
        • Oracle GoldenGate for MySQL Supported Data Types
          • Limitations and Clarifications
        • Non-Supported MySQL Data Types
        • Supported Objects and Operations for MySQL
        • Details of Support for Objects and Operations in MySQL DDL
        • Non-Supported Objects and Operations for MySQL
        • System Schemas
    • Oracle
      • Prepare Database Users and Privileges for Oracle
        • Grant User Privileges for Oracle AI Database 26ai and Higher
        • Grant User Privileges for Oracle Database 21c and Lower
          • Privileges for Capturing from Oracle Data Vault
      • Prepare Database Connection, System, and Parameter Settings
        • Enable GoldenGate Replication and Archive Mode
        • Setting Flashback Query
        • Handling Other Database Properties
        • Configure a Multitenant Container Database
          • Flush Sequence for Multitenant Container Database
        • Configure the Auto Capture Mode for Extract
        • Managing Server Resources
        • Support for Oracle Sequences
      • Ensuring Row Uniqueness in Source and Target Table
      • Transaction Log Settings and Requirements
        • Enable Subset Database Replication Logging
        • Enable Schema-level Supplemental Logging
        • Enable Table-level Supplemental Logging
        • Enable Supplemental Logging for JSON Relational Duality Views and JSON Collection Tables
        • Remove Table-level Supplemental Logging
      • Oracle: Supported Data Types, Objects, and Operations for DDL and DML
        • Details of Support for Oracle Database Editions
        • Details of Support for Oracle Data Types and Objects
          • Handling Special Data Types
          • Non-Supported Oracle Data Types
        • Details of Support for JSON-Relational Duality Views and JSON Collection Tables
        • Details of Support for Objects and Operations in Oracle DML
          • Multitenant Container Database
          • Tables, Views, and Materialized Views
          • DML Auto Capture
          • System Partitioning
          • Sequences and Identity Columns
          • Non-supported Objects and Operations in Oracle DML
        • Details of Support for Objects and Operations in Oracle DDL
          • Supported Objects and Operations in Oracle DDL
          • Non-supported Objects and Operations in Oracle DDL
    • Oracle Autonomous AI Database
      • Prerequisites for Capturing from an Autonomous AI Database
        • Establishing Oracle GoldenGate Credentials
        • Enable Minimal Supplemental Logging in Oracle Autonomous AI Database for Oracle GoldenGate Extract
        • Next Steps After Setting Up Extract Prerequisites for Autonomous AI Database
      • Prerequisites for Applying to Oracle Autonomous AI Database
        • Unlock the Autonomous AI Database User for Oracle GoldenGate
        • Obtain the Autonomous AI Database Client Credentials
        • Next Steps After Setting Up Replicat Prerequisites for Autonomous AI Database
      • Details of Support When Using Oracle GoldenGate with Autonomous AI Databases
        • Details of Support for coexistence of Oracle GoldenGate with Transient Logical Rolling Upgrades
        • Data Type Limitations for DDL and DML Replication
        • Troubleshooting Oracle GoldenGate in Autonomous AI Databases
          • Support for Archived Log Retention
          • Connection Timeout
          • Cross Region Active Data Guard Support
          • Oracle GoldenGate Replicat Limitations for Autonomous AI Databases
    • PostgreSQL
      • Prepare Database Users and Privileges for PostgreSQL
      • Prepare Database Connection
      • Configure a DSN Connection in Linux
      • Connecting to a FIPS-enabled PostgreSQL System with Version 14 or Lower
      • Configuring SSL Support for PostgreSQL
        • Changes required in odbc.ini file
      • Database Configuration
      • Azure Database for PostgreSQL
      • Amazon Aurora PostgreSQL and Amazon RDS for PostgreSQL
      • Google AlloyDB for PostgreSQL
      • Google Cloud SQL for PostgreSQL
      • Enabling Table-Level Supplemental Logging
      • Configure Oracle GoldenGate CDC Extract for EnterpriseDB (EDB) Subscriber Node
      • PostgreSQL: Supported Data Types, Objects, and Operations
      • Supported Databases
        • High Availability Considerations
      • Supported PostgreSQL Data Types
      • Non-Supported PostgreSQL Data Types
      • Supported Objects and Operations for PostgreSQL
        • Tables, Views, and Materialized Views
        • Sequences and Identity Columns
    • SQL Server
      • SQL Server Supported Versions
      • Prepare Database Users and Privileges for SQL Server
        • Database User for SQL Server
        • Amazon RDS for SQL Server
        • Azure SQL Database
        • Google Cloud SQL for SQL Server
      • Prepare Database Connection
        • Configure a DSN Connection in Linux
        • Configure a DSN Connection in Windows
        • Connecting to the Listener of a SQL Server Always On Configuration
      • Preparing Tables for Processing
        • Replicat Consideration for Target Identity Columns, Triggers, and Constraints
          • Improving IDENTITY Replication with Array Processing
        • Ensuring Row Uniqueness in Source and Target Table
          • Using KEYCOLS to Specify a Custom Key
      • Prepare the Database for Oracle GoldenGate
        • Enabling CDC Supplemental Logging
        • Purge CDC Staging Data
        • Enabling Bi-Directional Loop Detection
      • CDC Capture Method Operational Considerations
        • Tuning SQL Server Change Data Capture
        • Oracle GoldenGate CDC Object Versioning
        • Supported and Unsupported Extract Parameters for SQL Server Change Data Capture
        • Details of the Oracle GoldenGate CDC Cleanup Process
        • Updating from Classic Extract to a CDC Extract
      • Requirements Summary for Capture and Delivery of Databases in an Always On Availability Group
        • Database Connection
        • Supplemental Logging
        • Operational Requirements and Considerations
      • SQL Server: Supported Data Types, Objects, and Operations
        • Instance Requirements
        • Database Requirements
        • Table Requirements
        • Supported SQL Server Data Types
        • Non-Supported SQL Server Data Types and Features
        • Supported Objects and Operations for SQL Server
        • Non-Supported Objects and Operations for SQL Server
          • Requirements for Table Level DDL Changes
        • System Schemas for SQL Server
    • Sybase
      • Prepare Database Users and Privileges for Sybase
      • Prepare Database Connection
      • Database Configuration
      • Preparing Tables for Processing
        • Disabling Triggers and Cascade Constraints
        • Assigning Row Identifiers
        • Limiting Row Changes in Tables that do not Have a Key
        • Replicating Encrypted Data
        • Preparing the Transaction Logs
          • Initializing the Secondary Truncation Point
          • Sizing and Retaining the Logs
          • Enabling Transaction Logging
      • Sybase: Supported Data Types, Objects, and Operations
        • Supported Sybase Data Types
        • Non-Supported Sybase Data Types
        • Supported Operations and Objects for Sybase
        • Non-Supported Operations and Objects for Sybase
    • Teradata
      • Prepare Database Users and Privileges for Teradata
      • Prepare Database Connection
        • Configure a DSN Connection in Linux
        • Preventing Multiple Connections
      • Preparing Tables for Processing
        • Disabling Triggers and Cascade Constraints
        • Ensuring Row Uniqueness for Tables
      • Teradata: Supported Data Types, Objects, and Operations
        • Supported Teradata Data Types
        • Limitations of Support for Data Types
        • Supported Objects and Operations for Teradata
        • Non-Supported Operations for Teradata
    • Yugabyte
      • Prepare Database Connection
        • Set up a DSN-based Connection
      • Connecting to a FIPS-enabled Yugabyte System with Version 14 or Lower
      • Configuring SSL Support for Yugabyte
        • Changes required in odbc.ini file
      • Preparing Tables for Handling Schema Changes
        • Prerequisites for Handling Schema Changes
        • Handling Table Level Schema Changes
          • Add a New Table to an Existing Extract Process
          • Add a New Table to an Existing Extract Process - Example
          • Drop a Table from an Extract Process
          • Handling Column Level Schema Changes
            • Add a Column
            • Drop a Column
      • Yugabyte: Supported Objects and Operations
        • Yugabyte Limitations
    • TimesTen
      • Prepare Database Users and Privileges for TimesTen
      • Prepare Database Connection
        • Choosing the Oracle TimesTen Connectivity Type
        • Configure a DSN Connection in Linux
      • Preparing Tables for Processing
        • Removing ON DELETE CASCADE Contraints
        • Ensuring Row Uniqueness for Tables
      • TimesTen: Supported Data Types, Objects, and Operations
        • Supported TimesTen Data Types
        • Supported Objects and Operations for TimesTen
        • Non-Supported TimesTen Data Types and Features
        • Limitations and Non-supported Items for Oracle TimesTen
  • Prepare Oracle GoldenGate
    • Configure Secure Database Connections from Oracle GoldenGate
    • Authenticate the Database Connection Using the Database Password Plugin
      • APIs Required for Database Password Plugin
      • Configure the Database Password Plugin to Store and Access the Database Password from a Third-Party Vault
      • Configure the Database Password Plugin to Store and Access the Database Password from OCI Vault
      • Configure the Database Password Plugin to Store and Access the Database Password from Oracle Key Vault
    • Add Database Connections
    • Add a Path Connection
    • Before Adding Extract and Replicat Processes
      • Add TRANDATA
        • Enable TRANDATA or SCHEMATRANDATA for Oracle Database
        • Enable TRANDATA for Non-Oracle Databases
      • Add a Checkpoint Table
        • Add a Checkpoint Table with Journaling in Db2 for i
      • Add Heartbeat Table
        • Running the Heartbeat Update and Purge Function for PostgreSQL
      • Create the Oracle GoldenGate CDC Cleanup Task
      • PostgreSQL: Extract Considerations for Remote Deployment
    • Prepare Oracle GoldenGate for Db2 for i
      • Update the GLOBALS File
      • Specifying Object Names
      • Adjusting the System Clock
• Manage Vector Embedding with the AI Service
  • Embedding Patterns
  • Cross-Platform Vector Replication Considerations
  • External AI Embedding with @AIService Function
    • Before Adding an AI Service Provider
    • Configure and Use the AI Service
  • Native Database Embedding with @DBFunction
  • Support for ONNX Models with Oracle GoldenGate
• Replicate Data
  • Extract
    • Add an Extract
      • Extract Information Screen
      • Register Extract Screen - PostgreSQL and Yugabyte Databases
        • Register Extract for PostgreSQL from the Admin Client
        • Guidelines and Limitations for PGOUTPUT Plugin Type
      • Extract Options Screen
        • Register Extract for Oracle from the Admin Client
      • Downstream Capture Screen
      • Managed Options Screen
      • Extract Parameter File Screen
        • Create a Parameter File for Extract
          • Additional Parameter Options for Extract
    • Configure Extract for Oracle Autonomous AI Database
    • Downstream Extract for Oracle GoldenGate Deployment
      • Configure the Source and Downstream Mining Databases
        • Oracle GoldenGate User in Source and Downstream Mining Databases
        • Configure Database Connections
        • Configure Parameters for Downstream Database
          • Parameter Settings for Downstream Extract in Real-Time Mining Mode
          • Parameter Settings for Downstream Extract in Archive Mining Mode
      • Configure Oracle GoldenGate Extract for Downstream Deployment
        • Configure Oracle GoldenGate for Downstream Database
      • Configure Cascaded Downstream Extract Using Active Data Guard
        • Enable Downstream Extract to Work with ADG
    • Extract Actions
      • Access Extract Details
      • Start or Stop Extract
      • Alter Extract
      • Delete Extract
    • Using Oracle GoldenGate with MySQL Group Replication
      • Oracle GoldenGate Features to Support MySQL Group Replication
        • REST API Example for GTIDSET parameter
      • Requirements for Supporting Group Replication
        • Limitations of Group Replication with Oracle GoldenGate for MySQL
      • SSL Configuration on Group Replication Cluster
        • Overview of Database Cluster SSL Configuration for Group Replication
        • Create Server Certificates
        • Configure Database Nodes and Router
  • Instantiate
    • Instantiating Oracle GoldenGate for Db2 for i
      • Prerequisites for Instantiating for Db2 for i
        • Configure Change Capture and Delivery
        • Add Collision Handling
        • Prepare the Target Tables
      • Precise Instantiation Using Db2 for i Database Utilities
        • Precise Instantiation Using Db2 for i Database Utilities
        • To Perform Instantiation with a Database Utility
      • Start Extract During Instantiation
      • Positioning Extract After Startup
      • Making the Instantiation Procedure More Efficient
    • Instantiating Oracle GoldenGate for Db2 LUW
    • Precise Instantiation for Oracle
      • Using Oracle Data Pump for Automatic Per Table Instantiation
      • Using Recovery Manager (RMAN) for Instantiation
        • Precise Instantiation for Oracle Using the RMAN Method
      • Precise Instantiation for Oracle Using Initial Load Extract
        • Step 1: Create a Primary Extract
        • Step 2: Determine the Instantiation SCN
        • Step 3: Create and Start the Initial Load Replicat
        • Step 4: Create and start the Initial Load Extract
        • Step 5: Create the Distribution Paths
        • Step 6: Create the Primary Replicat
    • Precise Instantiation for MySQL to MySQL Using MySQL Shell Utilities and Oracle GoldenGate
    • Precise Instantiation for SQL Server
    • Precise Instantiation for PostgreSQL Using Initial Load Extract
    • Precise Instantiation Between PostgreSQL Environments Using pg_dump Utility
    • Monitoring and Controlling Processing After the Instantiation
    • Verifying Synchronization
  • Distribute
    • Distribution Path Streaming Protocols
    • Distribution Service Path
      • Add a Distribution Path
      • Actions for Distribution Service Paths
        • Reposition a Path
        • Change the Path Filtering
      • Monitor the Path Information and Statistics
        • Monitor the Path
        • Review the Path Statistics
    • Receiver Service Paths
      • Add Receiver Service Paths
      • Actions for Receiver Service Path
      • Access Network Statistics for a Path
    • Data Streams
      • About Data Streams
        • Components of Oracle GoldenGate Data Streams
          • Async API
          • Data Streams Protocol
          • Data Streams Start/Restart Position
          • Schema Records
          • CloudEvents
      • Add Data Streams
      • Edit Data Streams Configuration
      • Access and Edit Data Streams Path Information
      • Monitor Data Streams Statistics
      • Oracle GoldenGate Data Streams REST APIs
    • Replicate Business Objects with Oracle JSON Relational Duality and GoldenGate Data Streams
      • Advantages of Using JSON Duality Views with GoldenGate Data Streams
      • Parameters Used When Configuring JSON DVs and JCTs
      • Configure GoldenGate Data Streams and JSON Relational Duality Views to Deliver Change Data
  • Replicat
    • Types of Replicat
      • About Classic or Non-Integrated Replicat
      • About Coordinated Replicat
        • About Barrier Transactions
        • How Barrier Transactions are Processed
      • About Integrated Replicat
        • Benefits of Integrated Replicat
        • Integrated Replicat Requirements
      • About Parallel Replicat
        • Benefits of Parallel Replicat
        • Parallel Replication Architecture
        • Basic Parameters for Parallel Replicat
      • Select a Replicat Type for the Deployment
    • Add a Replicat
    • Configure Replicat for Oracle Autonomous AI Database
    • Replicat Actions
      • Access Replicat Details
      • Stop, Start a Replicat
      • Alter Replicat
      • Delete Replicat
    • Configure a Replicat Parameter File
    • Additional Parameter Options for Integrated Replicat and Parallel Replicat in Integrated Mode
    • Controlling Checkpoint Retention
    • Excluding Replicat Transactions in Bidirectional Replication
    • DDL Notification on Target Tables
    • Oracle GoldenGate Delivery for Google Cloud Spanner
      • Add a Replicat for Google Cloud Spanner
• Failover and Recovery
  • MySQL Considerations for Positioning Extract to a Specific Start Point
    • Failover Support for Oracle GoldenGate with PostgreSQL 17 and higher
      • Prerequisites for Enabling Failover Support for Oracle GoldenGate for PostgreSQL 17 and higher
      • Configure the Failover Support
        • Best Practices for Failover Support Configuration
        • Limitations
        • Cloud-Specific Considerations
  • Bounded Recovery
• Manage Schema Evolution
  • DDL Replication - MySQL
    • MySQL: Prerequisites for DDL Configuration
      • DDL Filtering for MySQL
      • Using DDL Statements and Options for Filtering
        • Filtering DDL Generated by MySQL Heatwave Engine
  • DDL Replication - Oracle
    • Overview of DDL Synchronization
      • Limitations of Oracle GoldenGate DDL Support
      • DDL Statement Length
        • Supported Topologies
        • Filtering, Mapping, and Transformation
          • Renames
          • Interactions Between Fetches from a Table and DDL
          • Comments in SQL
          • Compilation Errors
          • Interval Partitioning
          • DML or DDL Performed Inside a DDL Trigger
          • LogMiner Data Dictionary Maintenance
        • Guidelines for Configuring DDL Replication for Oracle
          • Database Privileges
          • Parallel Processing
          • Object Names
          • Truncates
          • Initial Synchronization
          • Data Continuity After CREATE or RENAME
          • Understanding DDL Scopes
        • Mapped Scope
        • Unmapped Scope
        • Other Scope
          • Correctly Identifying Unqualified Object Names in DDL
          • Enabling DDL Support
          • Filtering DDL Replication
        • Filtering with the DDL Parameter
          • Special Filter Cases
        • DDL EXCLUDE ALL
        • Implicit DDL
          • How Oracle GoldenGate Handles Derived Object Names
        • MAP Exists for Base and Derived Objects
        • MAP Exists for Derived Object, But Not Base Object
        • New Tables as Derived Objects
          • Prerequisites for Configuring DDL
          • RENAME and ALTER TABLE RENAME
        • Disabling the Mapping of Derived Objects
          • Using DDL String Substitution
          • Add Supplemental Log Groups Automatically
          • Removing Comments from Replicated DDL
          • Replicating an IDENTIFIED BY Password
          • How DDL is Evaluated for Processing
          • Viewing DDL Report Information
        • Viewing DDL Reporting in Replicat
        • Viewing DDL Reporting in Extract
        • Statistics in the Process Reports
        • Using Edition-Based Redefinition
        • Modify DDL for Oracle GoldenGate for Sybase
• Map and Transform Data
  • Parameters that Control Mapping and Data Integration
    • Mapping between Dissimilar Databases
      • Mapping and Conversion on NonStop Systems
      • Mapping and Conversion on Windows and UNIX Systems
    • Globalization Considerations when Mapping Data
      • Conversion between Character Sets
        • Database Object Names
        • Column Data
      • Preservation of Locale
      • Support for Escape Sequences
    • Mapping Columns Using TABLE and MAP
      • Supporting Case and Special Characters in Column Names
      • Configuring Table-level Column Mapping with COLMAP
        • Using USEDEFAULTS to Enable Default Column Mapping
        • Specifying the Columns to be Mapped in the COLMAP Clause
      • Configuring Global Column Mapping with COLMATCH
      • Understanding Default Column Mapping
    • Data Type Conversions
      • Numeric Columns
      • Character-type Columns
      • Datetime Columns
    • Selecting and Filtering Rows
      • Selecting Rows with a FILTER Clause
      • Selecting Rows with a WHERE Clause
      • Considerations for Selecting Rows with FILTER and WHERE
        • Ensuring Data Availability for Filters
        • Comparing Column Values
        • Testing for NULL Values
    • Retrieving Before and After Values
    • Selecting Columns
    • Selecting and Converting SQL Operations
    • Using Transaction History
    • Testing and Transforming Data
      • Handling Column Names and Literals in Functions
      • Using the Appropriate Function
      • Transforming Dates
      • Performing Arithmetic Operations
        • Omitting @COMPUTE
      • Manipulating Numbers and Character Strings
      • Handling Null, Invalid, and Missing Data
        • Using @COLSTAT
        • Using @COLTEST
        • Using @IF
      • Performing Tests
        • Using @CASE
        • Using @VALONEOF
        • Using @EVAL
    • Using Tokens
      • Defining Tokens
      • Using Token Data in Target Tables
  • Bi-Directional Replication
  • Prerequisites for Bidirectional Replication
    • Enable Bi-Directional Loop Detection
    • Considerations for an Active-Active Configuration
      • Application Design
      • Keys
      • Database-Generated Values
      • Database Configuration
    • Preventing Data Looping
      • Identifying Replicat Transactions
    • Preventing the Capture of Replicat Operations
      • Oracle: Preventing the Capture of Replicat Transactions
      • Manage Conflicts
    • MySQL: Bi-Directional Replication
    • PostgreSQL: Bi-Directional Replication
    • Preparing DBFS for an Active-Active Configuration
      • Supported Operations and Prerequisites
      • Applying the Required Patch
      • Examples Used in these Procedures
      • Partitioning the DBFS Sequence Numbers
      • Configuring the DBFS file system
      • Mapping Local and Remote Peers Correctly
• Manage Errors
  • Overview of Oracle GoldenGate Error Handling
    • Handling Extract Errors
    • Handling Replicat Errors during DML Operations
      • Handling Errors as Exceptions
        • Using EXCEPTIONSONLY
        • Using MAPEXCEPTION
        • About the Exceptions Table
    • Handling Replicat Errors during DDL Operations
    • Use the Error Log
    • Handling Transient and Permanent Errors in Replicat for Google Spanner
  • Automatic Conflict Detection and Resolution
    • About Automatic Conflict Detection and Resolution
      • Automatic Conflict Detection and Resolution
      • Requirements for Automatic Conflict Detection and Resolution
        • Compatibility and Migration
      • Column Groups
      • Earliest Timestamp Conflict Detection and Resolution
      • Latest Timestamp Conflict Detection and Resolution
      • Delta Conflict Resolution
      • Site Priority CDR
      • Delete Always Wins Timestamp CDR
      • DELETE TOMBSTONE Table
      • Track Primary Key Updates in Delete Tombstone
    • Configuring Delta Conflict Detection and Resolution
      • Configuring Latest Timestamp Conflict Detection and Resolution
      • Configuring Delta Conflict Detection and Resolution
    • Managing Automatic Conflict Detection and Resolution
      • Altering Conflict Detection and Resolution for a Table
      • Altering a Column Group
      • Purging Tombstone Rows
      • Online Redefinition on ACDR Tables
      • Removing Conflict Detection and Resolution From a Table
      • Removing a Column Group
      • Removing Delta Conflict Detection and Resolution
    • Monitoring Automatic Conflict Detection and Resolution
      • Displaying Information About the Tables Configured for Conflicts
      • Displaying Information About Conflict Resolution Columns
      • Displaying Information About Column Groups
  • Manual Conflict Detection and Resolution
    • Overview of the Oracle GoldenGate CDR Feature
    • Configuring the Oracle GoldenGate Parameter Files for Conflict Resolution
    • Making the Required Column Values Available to Extract
    • Viewing CDR Statistics
    • CDR Example 1: All Conflict Types with USEMAX, OVERWRITE, DISCARD
      • Table Used in this Example
      • MAP Statement with Conflict Resolution Specifications
      • Description of MAP Statement
      • INSERTROWEXISTS with the USEMAX Resolution
      • UPDATEROWEXISTS with the USEMAX Resolution
      • UPDATEROWMISSING with OVERWRITE Resolution
      • DELETEROWEXISTS with OVERWRITE Resolution
      • DELETEROWMISSING with DISCARD Resolution
    • CDR Example 2: UPDATEROWEXISTS with USEDELTA and USEMAX
      • Table Used in this Example
      • MAP Statement
      • Description of MAP Statement
      • Error Handling
    • CDR Example 3: UPDATEROWEXISTS with USEDELTA, USEMAX, and IGNORE
      • Table Used in this Example
      • MAP Statement
      • Description of MAP Statement
      • Error Handling
    • Configuring the Oracle GoldenGate Parameter Files for Error Handling
      • Tools for Mapping Extra Data to the Exceptions Table
      • Sample Exceptions Mapping with Source and Target Columns Only
      • Sample Exceptions Mapping with Additional Columns in the Exceptions Table
• Manage Trail Files
  • Assign Storage for Oracle GoldenGate Trails
  • Estimate Space for the Trails
  • Add a Trail
  • Change the Size of Trail Files
  • Download Trail Files
  • Delete Trail Files
  • Automate Maintenance Tasks
    • Archive Trails
    • Purge Trails
    • Purge Process
    • Report Lag
    • Using Automatic Trail File Recovery
  • Guidelines for Using Self-describing Trails
• Administer
  • Common Administrative Tasks Performed from the Admin Client
    • About Admin Client
    • Using Wildcards in Command Arguments
    • Using Command History
    • Storing and Calling Frequently Used Command Sequences
    • Controlling Extract and Replicat
    • Deleting Extract and Replicat
    • Creating a Parameter File Using Admin Client
      • Creating a Parameter File with a Text Editor
    • Validating a Parameter File
    • Simplifying the Creation of Parameter Files
      • Using Wildcards
      • Using OBEY
      • Using Macros
      • Using Parameter Substitution
    • Specifying Object Names in Oracle GoldenGate Input
      • Specifying Filesystem Path Names in Parameter Files on Windows Systems
      • Supported Database Object Names
        • Supported Special Characters
        • Non-supported Special Characters
      • Specifying Names that Contain Slashes
      • Qualifying Database Object Names
        • Two-part Names
        • Three-part Names
        • Applying Data from Multiple Containers or Catalogs
        • Specifying a Default Container or Catalog
      • Specifying Case-Sensitive Database Object Names
      • Using Wildcards in Database Object Names
        • Rules for Using Wildcards for Source Objects
        • Rules for Using Wildcards for Target Objects
        • Fallback Name Mapping
        • Asterisks or Question Marks as Literals in Object Names
        • How Wildcards are Resolved
        • Excluding Objects from a Wildcard Specification
      • Differentiating Case-Sensitive Column Names from Literals
  • Performing Advanced Administrative Tasks
    • Shutting Down the System
    • Changing Database Attributes
      • Changing Database Metadata
      • Adding Tables to the Oracle GoldenGate Configuration
      • Coordinating Table Attributes between Source and Target
      • Dropping and Recreating a Source Table
      • Purging Archive Logs
      • Reorganizing a DB2 Table (z/OS Platform)
    • Access the Parameter Files
    • Manage Auto Start and Auto Restart for Extract and Replicat Processes
    • Procedural Replication
      • About Procedural Replication
      • Procedural Replication Process Overview
      • Determining Whether Procedural Replication Is On
      • Enabling and Disabling Supplemental Logging
      • Filtering Features for Procedural Replication
      • Handling Procedural Replication Errors
      • Listing the Procedures Supported for Oracle GoldenGate Procedural Replication
      • Monitoring Oracle GoldenGate Procedural Replication
    • Execute Commands, Stored Procedures, and Queries with SQLEXEC
      • Performing Processing with SQLEXEC
      • Using SQLEXEC
      • Apply SQLEXEC as a Standalone Statement
      • Apply SQLEXEC within a TABLE or MAP Statement
      • Using Input and Output Parameters
        • Passing Values to Input Parameters
        • Passing Values to Output Parameters
        • SQLEXEC Examples Using Parameters
      • Handling SQLEXEC Errors
        • Handling Database Errors
        • Handling Missing Column Values
      • Additional SQLEXEC Guidelines
  • Switching Replicat from Non-Integrated Mode to Integrated Mode
  • Switching Replicat from Integrated Mode to Non-Integrated Mode
  • Switching Replicat to Coordinated Mode
    • Procedure Overview
    • Performing the Switch to Coordinated Replicat
  • Administering a Coordinated Replicat Configuration
    • Performing a Planned Re-partitioning of the Workload
    • Recovering Replicat After an Unplanned Re-partitioning
      • Reprocessing From the Low Watermark with HANDLECOLLISIONS
      • Using the Auto-Saved Parameter File
  • Simplify and Automate Work with Oracle GoldenGate Macros
    • Define a Macro
    • Call a Macro
      • Call a Macro that Contains Parameters
      • Call a Macro without Input Parameters
    • Calling Other Macros from a Macro
    • Create Macro Libraries
    • Tracing Macro Expansion
  • Using User Exits to Extend Oracle GoldenGate Capabilities
    • When to Implement User Exits
    • Making Oracle GoldenGate Record Information Available to the Routine
    • Creating User Exits
    • Supporting Character-set Conversion in User Exits
    • Using Macros to Check Name Metadata
    • Describing the Character Format
    • Upgrading User Exits
    • Viewing Examples of How to Use the User Exit Functions
• Monitor and Tune
  • Monitor
    • Purge Datastore
    • Monitor Extracts
    • Monitor Replicats
    • Monitor Microservices
      • Protocols for Performance Monitoring for Different Operating Systems
      • Recover from Datastore Corruption
    • Using Automatic Workload Repository (AWR) Reports for Oracle Database
      • Replication System Resource Usage
      • Replication Top Wait Events
      • Replication Top SQLs
      • Oracle GoldenGate Extract Performance Metrics
      • Oracle GoldenGate Integrated Replicat
      • Oracle GoldenGate Replicat
    • Monitor Oracle GoldenGate Statistics using StatsD
      • Enable StatsD using OGGCA
      • Enable StatsD with REST API Service Endpoints
      • StatsD Metrics Catalog
        • Batch SQL Statistics
        • Bounded Recovery Status
        • Cache Manager Statistics
        • Distribution Service Network Statistics
        • Distribution Service Path Statistics
        • Distribution Service Table Statistics
        • Checkpoint Position Information Statistics
        • Input Trail File Statistics
        • Output Trail File Statistics
        • Extract Database Statistics
        • Network Statistics
        • Process Performance Statistics
        • Queue Statistics
        • Replicat Database Statistics
        • Parallel Replicat Statistics
        • Receiver Service Statistics
        • Extract Database Statistics by Table
        • Replicat Database Statistics by Table
      • Disable StatsD using OGGCA
      • Disable StatsD with REST API Service Endpoints
    • About Integrated Diagnostics
      • How to Configure Integrated Diagnostics
    • Monitor Processes and Statistics from the Command Line
    • Monitor Oracle GoldenGate Processes, Trails, and Paths
      • Search and Read the Log Information from the Diagnosis Page
        • Search for Log Messages
      • Search and Read Log Information for Microservices in a Deployment
    • Monitor an Extract Recovery
    • Monitor Lag
      • About Lag
      • Monitor Lag Using Automatic Heartbeat Tables
        • Heartbeat Table End-To-End Replication Flow
        • Update Heartbeat Tables
          • Configure Automation Task to Update Heartbeat Table for PostgreSQL
        • Purge the Heartbeat History Tables
        • Best Practice
        • Using the Automatic Heartbeat Commands
      • Reporting Lag
      • Identifying Lag in Replicat
    • Db2 z/OS: Interpret Statistics for Update Operations
    • Monitor Processing Volume
    • Use the Process Report
      • Scheduling Runtime Statistics in the Process Report
      • Viewing Record Counts in the Process Report
      • Prevent SQL Errors from Filling the Replicat Report File
    • Use the Discard File
      • Maintain Discard and Report Files
    • Parameters Used to Interpret Synchronization Lag
  • Tuning
    • Using Multiple Process Groups
      • Considerations for Using Multiple Process Groups
        • Maintaining Data Integrity
        • Number of Groups
        • Memory
        • Isolating Processing-Intensive Tables
    • Splitting Large Tables Into Row Ranges Across Process Groups
    • Eliminating Disk I/O Bottlenecks
      • Improving I/O performance Within the System Configuration
      • Improving I/O Performance Within the Oracle GoldenGate Configuration
    • Managing Virtual Memory and Paging
    • Tuning Replicat Transactions
      • Tuning Coordination Performance Against Barrier Transactions
      • Preventing Full Table Scans in the Absence of Keys
      • Splitting Large Transactions
      • Adjusting Open Cursors
      • Improving Update Speed
      • Set a Replicat Transaction Timeout
    • Using Healthcheck Scripts to Monitor and Troubleshoot
      • Installing, Running, and Uninstalling Healthcheck Scripts
      • How to Deal with Healthcheck Information?
      • Components of Healthcheck Information
• Mission Critical
  • Configuration Service
    • Enable the Configuration Service
    • Configuration Service: Considerations
  • Backing up the Oracle GoldenGate Environment
• Appendix
  • Oracle GoldenGate Frequently Asked Questions
  • Sample Commands to Configure GoldenGate Data Streams for JSON Relational Duality Views
  • OGGCA Sample Template Response File for Silent Deployment
    • OGGCA Sample Template Response File for Silent Deployment
    • OGGCA Response File Example
  • Using the LogDump Utility to Access Trail File Records
    • Trail Recovery Mode
    • Trail Record Format
      • Trail File Header Record
        • Partition Name Record in Trail File Header
        • Viewing the Partition Name and PNR Index in Logdump
        • Example of an Oracle GoldenGate Record
        • Record Header Area
        • Description of Header Fields
        • Using Header Data
        • Record Data Area
          • Full Record Image Format (NonStop Sources)
        • Compressed Record Image Format (Windows, UNIX, Linux Sources)
    • Tokens Area
    • Oracle GoldenGate Operation Types
  • Checkpoint Tables Additional Details
    • Internal Checkpoint Information
    • INFO EXTRACT SHOWCH Command: Checkpoint Information
    • INFO REPLICAT, SHOWCH: Checkpoint Information
  • Oracle GoldenGate Microservices Roles
  • Supported Character Sets
    • Supported Character Sets - Oracle
    • Supported Character Sets - Non-Oracle
  • Supported Locales
  • Special Values Supported by Database Data Types
  • Commit Sequence Number (CSN)
  • Connecting Microservices and Classic Architectures
    • Connect Oracle GoldenGate Classic Architecture to Microservices Architecture
    • Connect Oracle GoldenGate Microservices Architecture to Classic Architecture