CUSEREXIT

有效对象

复制

说明

使用 CUSEREXIT 参数调用在 Oracle GoldenGate 处理中定义的退出点处 Windows DLL 或 UNIX 共享对象中用 C 编程代码编写的定制退出例程。用户出口例程必须能够接受来自 Replicat 进程的不同事件和信息，根据需要处理信息，然后将响应和信息返回给调用方（调用它的 Oracle GoldenGate 进程）。

用户出口可以作为 Oracle GoldenGate 解决方案中可用的数据转换函数的替代项，也可以与之结合使用。

注意：使用协调复制调用用户出口例程时，您需要负责以线程安全的方式写入用户出口。

有关创建和实施用户出口的帮助，请参阅使用用户出口扩展 Oracle GoldenGate 功能。

默认值

无

语法

CUSEREXIT {<DLL> | <shared_object>} <routine>
[, INCLUDEUPDATEBEFORES]
[, PARAMS '<string>']

{<DLL> | <shared_object>}

包含用户出口函数的 Windows DLL 或 UNIX 共享对象的名称。

<routine>

要执行的退出例程的名称。

INCLUDEUPDATEBEFORES

将列值的前映像传递到用户退出。使用此参数时，必须通过在支持此标志的回调函数中将 requesting_before_after_ind 标志设置为 BEFORE_IMAGE_VAL 来显式请求之前的映像。否则，仅将后面的映像传递给用户出口。默认情况下，Oracle GoldenGate 仅在映像后使用。

将 INCLUDEUPDATEBEFORES 用于从 Replicat 调用的用户出口时，请始终对 tranlog 提取进程使用 GETUPDATEBEFORES 参数，以便将之前的映像写入线索。

PARAMS <'string'>

启动时传递指定的字符串。可用于传递属性文件、启动参数或其他字符串。将字符串括在单引号内。

字符串中的数据将传递到 EXIT_CALL_START exit_params_def.function_param 中的用户出口。如果未使用 PARAMS 指定带引号的字符串，则 exit_params_def.function_param 为 NULL。

示例

示例 1

CUSEREXIT userexit.dll MyUserExit

示例 2

CUSEREXIT userexit.dll MyUserExit, PARAMS 'init.properties'

示例 3

CUSEREXIT userexit.dll MyUserExit, INCLUDEUPDATEBEFORES, PARAMS 'init.properties'

示例 4

CUSEREXIT userexit.dll MyUserExit, INCLUDEUPDATEBEFORES, &
  PARAMS 'init.properties'

示例 5

CUSEREXIT cuserexit.dll MyUserExit, &
  INCLUDEUPDATEBEFORES, PARAMS 'Some text to start with during startup'