USERIDALIAS

Valid For

Extract, Replicat, DEFGEN, Admin Client.

Supported for

All supported databases for the release.

Description

Use the USERIDALIAS parameter to specify authentication for an Oracle GoldenGate process to use when logging into a database. The use of USERIDALIAS requires the use of an Oracle GoldenGate credential store. Specify USERIDALIAS before any TABLE or MAP entries in the parameter file. The privileges that are required for the USERIDALIAS user vary by database.

The following rules apply to the value of alias:

Can be upto 30 characters in length
Must start with an alphabet
Can include any combination of alphabets, numbers, and following special characters:
- $ (Dollar) sign
- _ (underscore)
- # (hash) sign

USERIDALIAS Compared to USERID

USERIDALIAS enables you to specify an alias, rather than a user ID and password, in the parameter file. The user IDs and encrypted passwords are stored in a credential store. USERIDALIAS supports databases running on Linux, UNIX, and Windows platforms.

USERID requires either specifying the clear-text password in the parameter file or encrypting it with the ENCRYPT PASSWORD command and, optionally, storing an encryption key in an ENCKEYS file. USERID supports a broad range of the databases that Oracle GoldenGate supports. In addition, it supports the use of an operating system login for Oracle databases.

USERIDALIAS Requirements Per Database Type

The usage of USERIDALIAS varies depending on the database type.

Note:

Login that requires a database user and password must be stored in the Oracle GoldenGate credential store.

The supported specified USERID in USERIDALIAS in Oracle GoldenGate with MySQL MA are:

user/db
user@host/db
user@host:port/db

If an Oracle GoldenGate user is allowed to alter or add a USERIDALIAS that does not follow any of the preceding patterns, the user will see the error in pattern matching on the client such as the MA web interface client or Admin Client.

DB2 for LUW

Use USERIDALIAS parameter for all Oracle GoldenGate processes that connect to a Db2 LUW database using database authentication.

MySQL

Use USERIDALIAS for all Oracle GoldenGate processes that connect to a MySQL database.

Oracle

Use USERIDALIAS for Oracle GoldenGate processes that connect to an Oracle Database.

Specify the alias of a database credential that is stored in the Oracle GoldenGate credential store.
Special database privileges are required for the USERIDALIAS user when Extract is configured to use LOGRETENTION. These privileges might have been granted when Oracle GoldenGate was installed., see Configure Logging Properties for more information about LOGRETENTION.
To use USERIDALIAS for an Extract group that is configured for integrated capture, the user must have privileges. If using Oracle Database 23ai and higher, then the user privileges can be granted with the OGG_CAPTURE and OGG_APPLY user roles. If using Oracle database 21c or lower, then the user must have privileges in the dbms_goldengate_auth.grant_admin_privilege procedure. The user must be the same one that issues DBLOGIN and REGISTER EXTRACT or UNREGISTER EXTRACT for the Extract group that is associated with this USERIDALIAS.

For details on granting Oracle Database 23ai user privileges, see Grant User Privileges for Oracle Database 23ai and higher.

For details on granting privileges for Oracle Database 21c and lower, see Grant User Privileges for Oracle Database 21c and lower

USERIDALIAS with Kerberos Authentication

Supported for Oracle Database only.

You need to set the ALTER CREDENTIALSTORE to use the NOPASSWORD keyword as the authentication is external. See ALTER CREDENTIALSTORE to know more.

SQL Server

Use USERIDALIAS if the ODBC data source connection that will be used by the Oracle GoldenGate process is configured to connect using SQL Server authentication.

On a source SQL Server system, also use the SOURCEDB parameter to specify the source ODBC data source.
On a target SQL Server system, also use the TARGETDB parameter to specify the target ODBC data source.

Teradata

Use USERIDALIAS for Oracle GoldenGate processes that connect to a Teradata database.

On a target Teradata system, use the TARGETDB parameter to specify the target ODBC data source.

Default

None

Syntax

USERIDALIAS alias [DOMAIN domain] [SYSDBA]
[, THREADS (threadID[, threadID][, ...][, thread_range[, thread_range][, ...])]

alias

Specifies the alias of a database user credential that is stored in the Oracle GoldenGate credential store.

DOMAIN domain

Specifies the credential store domain for the specified alias. A valid domain entry must exist in the credential store for the specified alias.

SYSDBA

(Oracle) Specifies that the user logs in as sysdba.

THREADS (threadID[, threadID][, ...][, thread_range[, thread_range][, ...])

Valid for Replicat. Links the specified credential to one or more threads of a coordinated Replicat. Enables you to specify different logins for different threads.

threadID[, threadID][, ...]: Specifies a thread ID or a comma-delimited list of threads in the format of threadID, threadID, threadID.
[, thread_range[, thread_range][, ...]: Specifies a range of threads in the form of threadIDlow-threadIDhigh or a comma-delimited list of ranges in the format of threadIDlow-threadIDhigh, threadIDlow-threadIDhigh.

A combination of these formats is permitted, such as threadID, threadID, threadIDlow-threadIDhigh.

TimesTen

Use USERIDALIAS for Oracle GoldenGate processes that connect to a TimesTen database.

On a target TimesTen system, use the TARGETDB parameter to specify the target ODBC data source.

Default

None

Syntax

USERIDALIAS alias [DOMAIN domain] [SYSDBA]
[, THREADS (threadID[, threadID][, ...][, thread_range[, thread_range][, ...])]

alias

Specifies the alias of a database user credential that is stored in the Oracle GoldenGate credential store.

DOMAIN domain

Specifies the credential store domain for the specified alias. A valid domain entry must exist in the credential store for the specified alias.

SYSDBA

(Oracle) Specifies that the user logs in as sysdba.

THREADS (threadID[,threadID][, ...][,thread_range[,thread_range][, ...])

Valid for Replicat. Links the specified credential to one or more threads of a coordinated Replicat. Enables you to specify different logins for different threads.

threadID[,threadID][, ...]: Specifies a thread ID or a comma-delimited list of threads in the format of threadID, threadID, threadID.
[,thread_range[,thread_range][, ...]: Specifies a range of threads in the form of threadIDlow-threadIDhigh or a comma-delimited list of ranges in the format of threadIDlow-threadIDhigh, threadIDlow-threadIDhigh.

A combination of these formats is permitted, such as threadID, threadID, threadIDlow-threadIDhigh.

Examples

Example 1

The following supplies a credential for the user in the credential store that has the alias of tiger1 in the domain of east.

USERIDALIAS tiger1 DOMAIN east

Example 2

The following supplies a credential for thread 3 of a coordinated Replicat.

USERIDALIAS tiger1 DOMAIN east THREADS (3)

Example 3

The following example shows the use of the parameter in PostgreSQL:

USERIDALIAS pgdsn

The following example shows using Kerberos authentication with Oracle GoldenGate Admin Client:

OGG (http://localhost:9005 demo)4> dblogin useridalias ggma 
Successfully logged into database CDB1_PDB1

In this example, the credential store is previously set up using the ALTER CREDENTIALSTORE command.