Valid For
Manager, Extract, Replicat, DEFGEN
Supported for
DB2 for i
DB2 LUW
DB2 on z/OS
MySQL
Oracle
SQL Server
Teradata
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.
Note:
The privileges that are required for the USERIDALIAS
user vary by database. See the Using Oracle GoldenGate for Heterogeneous Databasesto determine the privileges that are required for the Oracle GoldenGate database users.
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.
See Administering Oracle GoldenGate for more information about these parameters and Oracle GoldenGate security features.
USERIDALIAS Requirements Per Database Type
The usage of USERIDALIAS
varies depending on the database type.
Note:
Logins that require a database user and password must be stored in the Oracle GoldenGate credential store. See Configuring Security for Oracle GoldenGate in Administering Oracle GoldenGate for more information about the credential store.
DB2 for LUW
Use USERIDALIAS
with the SOURCEDB
or TARGETDB
parameter for all Oracle GoldenGate processes that connect to a DB2 LUW database using database authentication. You can omit USERIDALIAS
and only use SOURCEDB
or TARGETDB
if the database is configured allow authentication at the operating-system level. See "SOURCEDB" and "TARGETDB" for more information.
MySQL
Use USERIDALIAS
for all Oracle GoldenGate processes that connect to a MySQL database. The SOURCEDB
or TARGETDB
parameter is not required.
Oracle
Use USERIDALIAS
for Oracle GoldenGate processes that connect to an Oracle database.
The SOURCEDB
or TARGETDB
parameter is not required.
Specify the alias of a database credential that is stored in the Oracle GoldenGate credential store.
(Oracle Enterprise Edition earlier than 11.2.0.2) 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 the Log Retention Options in Using Oracle GoldenGate for Oracle Database for more information about LOGRETENTION
.
(Oracle Standard or Enterprise Edition 11.2.0.2 or later) To use USERIDALIAS
for an Extract group that is configured for integrated capture, the user must have the privileges granted in the dbms_goldengate_auth.grant_admin_privilege
procedure, and 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
.
To support capture from an Oracle container database, the user that is specified with USERID
must log on to the root container and must be a common database user. A connect string must be supplied for this user, for example: C##GGADM@FINANCE
. For more information, see Configuring the Primary Extract in Using Oracle GoldenGate for Heterogeneous Databases.
SQL Server
Use USERIDALIAS
if the ODBC data source connection that will be used by the Oracle GoldenGate process is configured to supply database authentication. USERIDALIAS
can be a specific login that is assigned to the process or any member of an account in the System Administrators
or Server Administrators
fixed server role.
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 source Teradata system, also use the SOURCEDB
parameter to specify the source ODBC data source.
On a target Teradata system, also 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. Refer to USERID Requirements Per Database Type for additional guidelines.
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
.