The cdc_endcapture() function

Ends capture for a specified table.

The row in the syscdctabs table associated with the specified session ID and table is deleted.

Purpose


1  cdc_endcapture (  session_ID , MBZ , "database:owner.table_name"  )

Function arguments

Table 1. The cdc_endcapture() arguments
Argument Data Type Description
session_ID INTEGER The session ID of an open capture session.
MBZ BIGINT Must be 0. Reserved.
database:owner.table_name LVARCHAR The qualified name of the table from which to capture data. The qualified name includes the following elements:
database
The name of the database in which the table exists.
owner
The name of the owner of the table.
table
The name of the table

Usage

Use the cdc_endcapture() function to stop capturing data from a specific table. This function does not affect the session status; the session remains open and active.

You must call this function from a client application. You cannot call this function from a user-defined routine that runs within the database server.

Return values

If successful, returns 0.

If unsuccessful, returns an integer corresponding to an error code and updates the syscdcsess table with the error information.