5 Managing Database Registrations

Register a database to use with Oracle Cloud Infrastructure GoldenGate. Registering a database enables networking and connectivity for a source or target database.

A database registration creates a private connection between the OCI GoldenGate service tenancy VCN and your tenancy VCN. When you register a database, you provide the database's IP network location and a fully-qualified domain name (FQDN) that OCI GoldenGate uses to reference the database. After creating a database registration, it becomes available to all OCI GoldenGate deployments within that compartment.

Database registrations also capture and synchronize database credentials to OCI GoldenGate. Any change made to the credential, such as updating or deleting, is synchronized to OCI GoldenGate.

Database registrations can be used with different deployments, as long as the database registrations and deployments are in the same tenancy compartment and the user currently logged in to the Oracle Cloud Infrastructure GoldenGate Deployment Console can access the database. Database registrations allow you to reuse the same networking and connection information for each deployment you want to use the database registration with.

Supported Databases

The following databases are certified to work with OCI GoldenGate as a source or target:

  • Oracle Databases 11.2.0.4, 12.1.0.2, and higher

    Note:

    If using Oracle Database, ensure that you use the CDB user to capture data from PDBs. For more information, see Configuring Oracle GoldenGate in a Multitenant Container Database.
  • Oracle Exadata
  • Oracle ExadataCS
  • Oracle Autonomous Transaction Processing
  • Oracle Autonomous Data Warehouse

Note:

Ensure that you apply the latest patches for the databases you use with OCI GoldenGate as recommended by Oracle Support. See:

Registering a Database

When you register a database, you select an existing database on Oracle Cloud or add details for a new database.

After you register a database, it's automatically available in the OCI GoldenGate Deployment Console for you to use. Keep in mind that while you can add and modify credentials in the OCI GoldenGate Deployment Console, you run the risk of overwriting these credentials when you register a database with the same name in the OCI Console, and each time a deployment is restarted.

Note:

You only need one database registration per database within a compartment. Before you create a database registration, ensure that one doesn't already exist for the database you want to use.

Follow the appropriate set of instructions for the database you want to register:

Registering an Oracle Database

Ensure that you enable supplemental logging and complete relevant prerequisite steps as outlined in Preparing the Database for Oracle GoldenGate.
To register an Oracle Database:
  1. In the Console navigation menu, under Oracle Database, select GoldenGate.
  2. In the GoldenGate menu, select Registered Databases.
  3. On the Registered Databases page, click Register Database.
  4. In the Register Database panel, enter a name, an alias (a unique identifier) and optionally, a description.
  5. For Compartment, select a compartment from the dropdown.

    Note:

    Deployments can only access database registrations within the same compartment.
  6. Choose Enter database information to register a new database, and then enter the database's information into the following fields:
    1. For Database FQDN, enter the database's fully qualified domain name (cannot be an Oracle Single Client Access Name (SCAN) Host)

      The OCI GoldenGate Deployment Console uses the FQDN to reference the database.

      Note:

      If a private IP is used, the Database FQDN is internally mapped within the OCI GoldenGate service tenancy to the internal Private Endpoint private IP address that corresponds to the database's Private IP address.
    2. Enter the Database Connection String. This field is not required when you upload a Database wallet.
    3. For Database User Name and Database Password fields, enter the credentials to connect to the database with.

      Note:

      If using Oracle Database, ensure that you use the CDB user to capture data from PDBs. For more information, see Configuring Oracle GoldenGate in a Multitenant Container Database.
    4. (Optional) For Database Wallet, drag and drop the wallet file to the dropzone or click select one to upload it.
  7. Select Network Connectivity via Private Endpoint if the database is accessible only by private IP.
    1. For Database IP, enter the private IP of the database. This value cannot be an Oracle Single Client Access Name (SCAN IP).
    2. For Subnet in <Compartment_Name>, select the subnet to which a private endpoint is created from the OCI GoldenGate service tenancy. This creates a network route for the OCI GoldenGate deployment to connect to the databse within your customer tenancy. Click Change Compartments to select a subnet in a different compartment.
  8. Click Show Advanced Options to add security and tags.
    1. In the Security tab, you can create a secret for the database password and wallet. Select who manages the secret.

      Note:

      You can manage secrets in your tenancy's Vault or have Oracle manage it in the OCI GoldenGate tenancy's Vault. Learn more about the Vault service.
    2. In the Tags tab, add tags to help track the resources within your tenancy. Click + Additional Tag to add more tags. Learn more about tagging.
  9. Click Register.

Registering an Autonomous Database

Ensure that you enable supplemental logging and complete relevant prerequisite steps as outlined in Preparing the Database for Oracle GoldenGate.
To register an autonomous database:
  1. In the Console navigation menu, under Oracle Database, select GoldenGate.
  2. In the GoldenGate menu, select Registered Databases.
  3. On the Registered Databases page, click Register Database.
  4. In the Register Database panel, enter a name, an alias (a unique identifier) and optionally, a description.
  5. For Compartment, select a compartment from the dropdown.

    Note:

    Deployments can only access database registrations within the same compartment.
  6. Choose one of the following options:
    1. Choose Select database to select an existing database, and then complete the following fields:
      1. For Database Type, select Autonomous Database.
      2. For <Database_Type> in <Compartment>, select from a list of available databases in the selected compartment. Click Change Compartment to choose a different compartment.
      3. For Database FQDN, enter the database's fully qualified domain name (cannot be an Oracle Single Client Access Name (SCAN) Host):

        The OCI GoldenGate Deployment Console uses the FQDN to reference the database.

        Note:

        If a private IP is used, the Database FQDN is internally mapped within the OCI GoldenGate service tenancy to the internal Private Endpoint private IP address that corresponds to the database's Private IP address.
      4. For Database User Name and Database Password fields, enter the credentials to connect to the database with.

        The Database User Name is prepopulated with the ggadmin user and read-only for Autonomous Database.

        Note:

        If using Oracle Database, ensure that you use the CDB user to capture data from PDBs. For more information, see Configuring Oracle GoldenGate in a Multitenant Container Database.
    2. Choose Enter database information to register a new database, and then enter the database's information into the respective fields.

      Note:

      Database Connection String is not required when you upload a Database wallet.
  7. Select Network Connectivity via Private Endpoint if the database is accessible only by private IP.
    1. For Database IP, enter the private IP of the database. This value cannot be an Oracle Single Client Access Name (SCAN IP).
    2. For Subnet in <Compartment_Name>, select the subnet to which a private endpoint is created from the OCI GoldenGate service tenancy. This creates a network route for the OCI GoldenGate deployment to connect to the databse within your customer tenancy. Click Change Compartments to select a subnet in a different compartment.
  8. Click Show Advanced Options to add security and tags.
    1. In the Security tab, you can create a secret for the database password and wallet. Select who manages the secret.

      Note:

      You can manage secrets in your tenancy's Vault or have Oracle manage it in the OCI GoldenGate tenancy's Vault. Learn more about the Vault service.
    2. In the Tags tab, add tags to help track the resources within your tenancy. Click + Additional Tag to add more tags. Learn more about tagging.
  9. Click Register.

Registering a DB System Database

This set of instructions applies to Bare Metal, VM, and Exadata DB systems.

Ensure that you enable supplemental logging and complete relevant prerequisite steps as outlined in Preparing the Database for Oracle GoldenGate.
To register a DB system database:
  1. In the Console navigation menu, under Oracle Database, select GoldenGate.
  2. In the GoldenGate menu, select Registered Databases.
  3. On the Registered Databases page, click Register Database.
  4. In the Register Database panel, enter a name, an alias (a unique identifier) and optionally, a description.
  5. For Compartment, select a compartment from the dropdown.

    Note:

    Deployments can only access database registrations within the same compartment.
  6. Choose one of the following options:
    1. Choose Select database to select an existing database, and then complete the following fields:
      1. For Database Type, select DB System Database (Bare Metal, VM, Exadata).
      2. For <Database_Type> in <Compartment>, select from a list of available databases in the selected compartment. Click Change Compartment to choose a different compartment.
      3. Select a database system from the Database Home dropdown.
      4. Select a database from the Database dropdown.
      5. For Database FQDN, enter the database's fully qualified domain name (cannot be an Oracle Single Client Access Name (SCAN) Host):

        The OCI GoldenGate Deployment Console uses the FQDN to reference the database.

        Note:

        If a private IP is used, the Database FQDN is internally mapped within the OCI GoldenGate service tenancy to the internal Private Endpoint private IP address that corresponds to the database's Private IP address.
      6. For Database Connection String, enter the connection string using one of the following syntaxes. Ensure that you replace <database-fqdn> with the value entered for Database FQDN in the previous step:
        • <database-fqdn>:<port>/<service-name>
        • <database-fqdn:<port>@<SID>
        • The TNS format:
          (DESCRIPTION=
                          (ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=<database-fqdn>)(PORT=<port>)))
                          (CONNECT_DATA=(SERVICE_NAME=<service-name>))
                     )

        Note:

        You can find the connection string in the database's DB Connection dialog on the Database Details page. If you upload a Database wallet, then this field is not required.
      7. For Database User Name and Database Password fields, enter the credentials to connect to the database with.

        Note:

        If using Oracle Database, ensure that you use the CDB user to capture data from PDBs. For more information, see Configuring Oracle GoldenGate in a Multitenant Container Database.
      8. For Database Wallet, drag-and-drop the database's wallet file to the dropzone, or click select one to browse for the file.

        Note:

        You can download the wallet file in the database's DB Connection dialog.
    2. Choose Enter database information to register a new database, and then enter the database's information into their respective fields.
  7. Select Network Connectivity via Private Endpoint if the database is accessible only by private IP.
    1. For Database IP, enter the private IP of the database. This value cannot be an Oracle Single Client Access Name (SCAN IP).
    2. For Subnet in <Compartment_Name>, select the subnet to which a private endpoint is created from the OCI GoldenGate service tenancy. This creates a network route for the OCI GoldenGate deployment to connect to the databse within your customer tenancy. Click Change Compartments to select a subnet in a different compartment.
  8. Click Show Advanced Options to add security and tags.
    1. In the Security tab, you can create a secret for the database password and wallet. Select who manages the secret.

      Note:

      You can manage secrets in your tenancy's Vault or have Oracle manage it in the OCI GoldenGate tenancy's Vault. Learn more about the Vault service.
    2. In the Tags tab, add tags to help track the resources within your tenancy. Click + Additional Tag to add more tags. Learn more about tagging.
  9. Click Register.

Registering a VM Cluster Database

This set of instructions applies to Exadata VM Cluster databases only.

Ensure that you enable supplemental logging and complete relevant prerequisite steps as outlined in Preparing the Database for Oracle GoldenGate.
To register a VM Cluster database:
  1. In the Console navigation menu, under Oracle Database, select GoldenGate.
  2. In the GoldenGate menu, select Registered Databases.
  3. On the Registered Databases page, click Register Database.
  4. In the Register Database panel, enter a name, an alias (a unique identifier) and optionally, a description.
  5. For Compartment, select a compartment from the dropdown.

    Note:

    Deployments can only access database registrations within the same compartment.
  6. Choose one of the following options:
    1. Choose Select database to select an existing database, and then complete the following fields:
      1. For Database Type, select VM Cluster Database (Exadata).
      2. For <Database_Type> in <Compartment>, select from a list of available databases in the selected compartment. Click Change Compartment to choose a different compartment.
      3. Select a database from the Database dropdown.
      4. For Database FQDN, enter the database's fully qualified domain name. This cannot be an Oracle Single Client Access Name (SCAN) Host.

        Note:

        If a private IP is used, the Database FQDN is internally mapped within the OCI GoldenGate service tenancy to the internal Private Endpoint private IP address that corresponds to the database's Private IP address.

        The OCI GoldenGate Deployment Console uses the FQDN to reference the database.

      5. For Database Connection String, enter the connection string using one of the following syntaxes. Ensure that you replace <database-fqdn> with the value entered for Database FQDN in the previous step:

        Note:

        .
        • <database-fqdn>:<port>/<service-name>
        • <database-fqdn:<port>@<SID>
        • The TNS format:
          (DESCRIPTION=
                          (ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=<database-fqdn>)(PORT=<port>)))
                          (CONNECT_DATA=(SERVICE_NAME=<service-name>))
                     )

        Note:

        You can find the connection string in the database's DB Connection dialog on the Database Details page. If you upload a Database wallet, then this field is not required.
      6. For Database User Name and Database Password fields, enter the credentials to connect to the database with.

        The Database User Name is prepopulated with the ggadmin user and read-only for Autonomous Database.

        Note:

        If using Oracle Database, ensure that you use the CDB user to capture data from PDBs. For more information, see Configuring Oracle GoldenGate in a Multitenant Container Database.
      7. For Database Wallet, drag-and-drop the database's wallet file to the dropzone, or click select one to browse for the file.

        Note:

        You can download the wallet file in the database's DB Connection dialog.
    2. Choose Enter database information to register a new database, and then enter the database's information into their respective fields.
  7. Select Network Connectivity via Private Endpoint if the database is accessible only by private IP.
    1. For Database IP, enter the private IP of the database. This value cannot be an Oracle Single Client Access Name (SCAN IP).
    2. For Subnet in <Compartment_Name>, select the subnet to which a private endpoint is created from the OCI GoldenGate service tenancy. This creates a network route for the OCI GoldenGate deployment to connect to the databse within your customer tenancy. Click Change Compartments to select a subnet in a different compartment.
  8. Click Show Advanced Options to add security and tags.
    1. In the Security tab, you can create a secret for the database password and wallet. Select who manages the secret.

      Note:

      You can manage secrets in your tenancy's Vault or have Oracle manage it in the OCI GoldenGate tenancy's Vault. Learn more about the Vault service.
    2. In the Tags tab, add tags to help track the resources within your tenancy. Click + Additional Tag to add more tags. Learn more about tagging.
  9. Click Register.

Viewing Database Registration Details

Select a database registration from the Registered Databases page to view its details.

On the Registered Database Details page you can:

  • View the state of the database registration, which can be any one of the following:
    • Creating
    • Updating
    • Active
    • Inactive
    • Deleting
    • Deleted
    • Failed
  • View the database registration information, including:
    • OCID: The resource's unique Oracle Cloud ID.
    • Compartment: The compartment where the database registration resides.
    • Created: The date and time when the database registration was created.
    • Alias Name: A unique name used to reference the database registration internally and using REST APIs.
    • Secret: The secret storing the database's wallet credentials
    • Database: The database that this database registration references
    • Database FQDN: The database's fully-qualified domain name. If Network Connectivity via Private Endpoint is enabled, then the Database FQDN is internally mapped within the OCI GoldenGate service tenancy to the internal Private Endpoint IP address that corresponds to the database's private IP.
    • Database User Name: For Autonomous Databases, this user is ggadmin.
    • Reverse Connection Private IP: (Displayed only when Network Connectivity via Private Network is enabled) The customer subnet facing IP. Any ingress rules to this subnet must allow ingress from this IP.
  • Edit the database registration
  • Move the database registration to another compartment
  • Add tags that you can use to search for resources across your services
  • Delete the database registration
  • View the status of work requests and any log messages, error messages, and resources associated with them. Database Registration operations that create work requests include:
    • Create
    • Update
    • Delete
    • Move

Editing a Database Registration

Although it's possible to add and modify credentials in the OCI GoldenGate Deployment Console, you run the risk of overwriting these credentials when you register a database with the same name in the OCI Console, and each time a deployment is restarted. Ensure that you only edit a database registration through the OCI Console.

To edit a database registration:

  1. In the list of databases on the Registered Databases page, select Edit from the Actions (three dots) menu for the database you want to edit.
  2. In the Edit Registered Database dialog, you can update any of the following fields:
    • Name
    • Alias
    • Description
    • Database FQDN
    • Connection String (DB System and VM Cluster Exadata only)
    • Database User Name

      Note:

      If using Oracle Database, ensure that you use the CDB user to capture data from PDBs. For more information, see Configuring Oracle GoldenGate in a Multitenant Container Database.
    • Database User Password
    • Wallet Configuration (Keep or Update)

    Note:

    If the database is available only by private IP, then the database hostname and/or IP in the connection string must reference the Database FQDN value. The Database IP cannot be an Oracle Single Client Access Name (SCAN) IP.
  3. Click Save Changes.

Moving a Database Registration

You can move a database registration from one compartment to another. If you move a database registration without moving the deployment to the same compartment, the deployment will no longer be able to access the database registration.

To move a database registration:

  1. In the list of databases on the Registered Databases page, select Move Resource from the Actions (three dots) menu for the database you want to move.
    You can also select Move Resource on the Registered Database Details page.
  2. In the Move Resource to a Different Compartment dialog, select the compartment to move the registered database to from the dropdown.
  3. Click Move Resource.

After you move the registered database to the new compartment, inherent policies apply immediately and may affect access to the registered database through the Console. For more information, see Managing Compartments.

Any deployments that referenced this database registration in the original compartment won't be able to access it in the new compartment. If you need to move a deployment to the new compartment, see Moving a Deployment.

Managing Tags for a Database Registration

Tags help you locate resources within your tenancy. You can add and view a database registration's tags from the Registered Databases page and from the Registered Database Details page.

On the Registered Databases page, from the registered database's Actions (three dots) menu, select Add Tags or View Tags.

On the Registered Database Details page, you can select Add Tags from the More Actions menu, or click the Tags tab to view and edit tags.

Learn more about tagging.

Deleting a Database Registration

Before you delete a database registration, ensure that you carefully review the deployments that reference the database registration. If not, you could encounter errors. Deleting a database registration also deletes the private connection and database credentials, so it will no longer be accessible to deployments. After you delete a registered database, it cannot be restored.

Note:

Database registrations also capture and synchronize database credentials to OCI GoldenGate. Any change made to the credential, such as updating or deleting, synchronizes to OCI GoldenGate. You will encounter issues when the Replicat or Extract attempts to reconnect to a deleted database registration.

To delete a database registration:
  1. In the list of databases on the Registered Databases page, select Delete from the Actions (three dots) menu of the database you want to delete.
    You can also click Delete from on the Registered Database Details page.
  2. In the Delete dialog, click Delete.

Using the Database Registration API

You can use the following operations to manage database registrations:

For information about using the API and signing requests, see REST APIs and Security Credentials. For more information about SDKs, see Software Development Kits and Command Line Interface.