1. Using Oracle GoldenGate Free
  2. Replicate
  3. Create database connections

Create database connections

Connections contain the network connectivity information for Oracle Database sources and targets.

Explore connections

Learn about the connection types you can use with GoldenGate Free and how to create them.

What is a connection?

A connection contains the connectivity details for a data source or target.

GoldenGate Free currently supports Oracle Database connections.

Supported connection types

Check the following list for specific Oracle Database versions you can use as sources and targets in GoldenGate Free.

The following Oracle Database versions are supported:

  • Oracle Database 11.2.0.4
  • Oracle Database 12.1.0.2
  • Oracle Database 19c
  • Oracle Database 21c, 21c XE
  • Oracle Database 23c, 23c Free

Note:

Oracle Autonomous Database and wallet authentication are not supported.

Create an Oracle Database connection

Learn to create a connection to Oracle Database to use as a GoldenGate Free source or target.

Watch this short video to learn how to create a database connection:

Tip:

  • Before you create a connection, ensure that you enable Archive Log Mode and restart your database.
  • If your database is a container database (CDB), it's recommended that you have the sys or system user credentials, or assistance from your DBA.
To create the Oracle Database connection:
  1. From the GoldenGate Free Home page, click Create connection.
  2. The Create database connection configuration panel consists of six pages. On the General Information page, enter a Database name, and optionally, a Description.
  3. Click Next.
  4. On the Connections details page, select a Connection role.
    • Select Source, to create a source database connection.
    • Select Target, to create a target database connection.
  5. Select Basic from the Connection type dropdown.
  6. Enter the database's Hostname and Port.
  7. For Database type:
    • If your Oracle database version is 21c or above, select Pluggable database (PDB) in Oracle Database 21c or above.
      1. Enter the Pluggable database service name (PDB).
      2. If you have DBA privileges for the container database, select SYSDBA privileges available, and then log in as sys or system in the Administrator Credentials dialog.
    • If your Oracle database version is 19c or above, select Pluggable database (PDB) in Oracle Database 19c or above.
      1. Enter the Pluggable database service name (PDB).
      2. If you have DBA privileges for the container database, select SYSDBA privileges available, and then log in as sys or system in the Administrator Credentials dialog.
      3. Enter the Pluggable database service name. If you logged in with DBA privileges, the field autopopulates with the PDB name or you can click Get PDB list and then select it from the dropdown.
    • If your database is not a Container database, then select Non-container database, and then enter the Database service name.

    Note:

    Database names with a domain name should be entered in the Database service name field.
  8. Click Next.
  9. On the GoldenGate admin user page:
    1. Select Add GoldenGate admin database user if one doesn't yet exist.
    2. Enter the GoldenGate username and password.

    Note:

    1. For a container (CDB) Oracle Database connection, the GoldenGate admin user is typically c##ggadmin. For a non-CDB Oracle Database connection, use ggadmin.
    2. See Non-supported special characters for the list of non-supported characters in object and user names. If a user name contains any of the characters in this list, you will encounter issues with your pipelines.
  10. Click Next.
  11. (If you logged in with DBA privileges, skip to step 13.) On the Validate configuration page, click Validate to ensure that your database is accessible and ready for GoldenGate to use.

    The database connection only validates when the correct service name and password are used. If the service name or password is incorrect, then an error message appears and action must be taken by your database administrator to update the analysis script. Learn more about the script.

    Tip:

    Click the ellipsis (three dots) menu to view log messages for each step.
  12. Click Next.
  13. On the Configuration page:
    • If you have DBA privileges, click Run analysis. Review the generated script completely, take note of recommended actions, and then select Run SQL to run it now, or Download SQL for your DBA to run the script separately.
    • If you don't have DBA privileges, click Download analysis script and have your DBA run it for you. Learn more about the script.
    • If Archive Log Mode is not enabled, you must download the SQL script and follow the instructions in the script to enable Archive Log Mode, and then restart the database. You can then run the SQL manually to prepare the database. After you run the script, return to the user interface and click Run analysis again to validate and continue creating the connection.
  14. On the Confirmation page review a summary of your connection details, and then click Create.

About the configuration script

The configuration script prepares your database for Oracle GoldenGate and creates the GoldenGate user, with whom Oracle GoldenGate uses to perform operations on the database. This interactive script detects inconsistencies and directs you on how to address them.

If you choose to run your script on your own, or have your database administrator run it for you, you must have SYSDBA privileges.

Ensure you provide following information in the SQL script:
  • The Service name of the database (container (CDB), pluggable (PDB), or non-container (CDB)).
  • A Password for the Oracle GoldenGate user to use.
The following are default values for Oracle GoldenGate user names and tablespace names. While you can change these values, it is recommended that you keep the default names.
  • For Oracle Database 21c or above:
    • CDB user is not applicable
    • PDB user: GGADMIN
    • Non-CDB user is not applicable
  • For Oracle Database 19c or below:
    • CDB user: C##GGADMIN
    • PDB user: GGADMIN
    • Non-CDB user is not applicable
  • For Non-container database:
    • CDB user is not applicable
    • PDB user is not applicable
    • Non-CDB user: GGADMIN

The default Oracle GoldenGate tablespace name is GG_ADMIN_DATA.

Learn more about preparing your database for Oracle GoldenGate.

After the script is run, the output displays the database information, the status of the database settings set for Oracle GoldenGate, and confirmation of database privileges granted to the Oracle GoldenGate user. Inconsistencies and errors reported in the script output will also include guidance on how to fix them. These errors must be fixed before you can create connections and pipelines.

For example, if your database doesn't have Archive Log Mode enabled, which is required for Oracle GoldenGate, then the analysis output includes instructions about how to enable Archive Log Mode, and then restart the database.

Next steps

After you have source and target connections created in GoldenGate Free, you can: