Table of Contents

Search

  1. Preface
  2. Overview of the Server Manager Command Line Interface
  3. Usage Scenario: Using Server Manager CLI Commands to Run Replications
  4. Command Reference

Command Line Interface for the Server Manager

Command Line Interface for the Server Manager

supplog add

supplog add

Enables database supplemental logging for DB2 for Linux, UNIX, and Windows, Microsoft SQL Server, and Oracle sources.
  • For DB2 sources, marks the tables for which you want to set DATA CAPTURE CHANGES.
  • For Microsoft SQL Server sources, marks the tables for which you want to enable Change Data Capture.
  • For Oracle sources, marks the columns in a source table that you want to add to a supplemental log group.
    You cannot include columns that have the following datatypes in an Oracle supplemental log group: BLOB, CLOB, LONG, LONG RAW, NCLOB, RAW, and the Oracle datatypes that Data Replication does not support.
The supplog add command only marks the database supplemental logging settings that you want to enable. To persist the changes, run the supplog run command. Alternatively, you can run the supplog save command to save the settings to a script file that your DBA can run later.
Before you can run this command, you must run the supplog open command.
After the supplog add command runs successfully, the Server Manager CLI lists the number of updated objects.

Syntax

For DB2 and Microsoft SQL Server sources, use the following syntax:
supplog add
source_schema
.
source_table
[-a]
For Oracle sources, use the following syntax:
supplog add
source_schema
.
source_table
[-a] [columns=
column_name1
,
column_name2
,...]

Parameters

The following table describes the command parameters for DB2 and Microsoft SQL Server sources:
Parameter
Description
source_schema
The name of the source schema or a mask for the name of the source schema or schemas. You can use the following wildcard characters in a mask:
  • An asterisk (*) to match all characters
  • A question mark (?) to match any single character
  • Square brackets ([ ]) to match only one out of several characters
source_table
For DB2 sources, the name of the source table or a mask for the name of the source table or tables.
For SQL Server sources, the owner name and source table name, or a mask for owner and table names.
You can use the following wildcard characters in a mask:
  • An asterisk (*) to match all characters
  • A question mark (?) to match any single character
  • Square brackets ([ ]) to match only one out of several characters
-a
For DB2 sources, include this parameter to set DATA CAPTURE CHANGES for the table or tables that match the
source_schema
and
source_table
parameter values and that are
not
mapped in the open configuration.
For SQL Server sources, include this parameter to enable Change Data Capture for the table or tables that match the
source_schema
and
source_table
parameter values and that are
not
mapped in the open configuration.
The following table describes the command parameters for Oracle sources:
Parameter
Description
source_schema
The name of the source schema. No wildcards are allowed.
source_table
The name of the source table. No wildcards are allowed.
-a
If the table that matches the
source_schema
and
source_table
parameter values is
not
mapped in the open configuration, use this parameter to add the columns in the source table to a supplemental log group.
columns
A comma-separated list of the columns to add to the supplemental log group or a mask for these columns. You can use the following wildcard characters in a mask:
  • An asterisk (*) to match all characters
  • A question mark (?) to match any single character
  • Square brackets ([ ]) to match only one out of several characters
If you omit this parameter, the command adds all of the columns to the supplemental log group.

Usage Notes

For Oracle sources, the Server Manager generates a supplemental log group when you use this command to add columns to a group. If you add over 33 columns, the Server Manager generates an additional supplemental log group.
To name the generated supplemental log groups, Data Replication uses the following naming pattern:
IDR_
object_ID
_
sequence_number
The
object_ID
is the object ID of the mapped source table, and the
sequence_number
is a generated sequence number for the supplemental log group.

Examples

For a DB2 source, the following command sets DATA CAPTURE CHANGES for all mapped and unmapped tables in all schemas:
supplog add *.* -a The supplog add command executed successfully. Updated 1000 object(s).
For a Microsoft SQL Server source, the following command enables Change Data Capture for the mapped "tab1" table that has the "src" schema and "dbo" owner:
supplog add src.dbo.tab1 The supplog add command executed successfully. Updated 1 object(s).
For an Oracle source, the following command adds all columns in the mapped "tab1" table to a supplemental log group:
supplog add src.tab1 The supplog add command executed successfully. Updated 8 object(s).

0 COMMENTS

We’d like to hear from you!