Command Line Processor (CHCCLP) (Version 10.2.1) Getting

Command Line Processor (CHCCLP) (Version 10.2.1) 6

Getting started with the CHCCLP program 7

Supported operating systems 8

Running CHCCLP 9

Running the CHCCLP commands in interactive mode 10

To run the CHCCLP commands in interactive mode 11

Working with command results in interactive mode 12

Running the CHCCLP commands in batch mode 13

To run CHCCLP commands in batch mode 14

To run a script file with substitution variables 15

Working with command results in batch mode 16

Running the CHCCLP commands in embedded mode 17

To set up EmbeddedScript 18

Working with EmbeddedScript 19

Working with command results in embedded mode 22

Sample programs 25

Overriding the locale 28

Enabling verbose command output 29

Setting and working with context 30

CHCCLP Commands 32

Understanding command syntax 33

Environment commands 34

chcclp session set to cdc 35

clear context 36

exit 37

help 38

print 39

quit 40

save session 41

set debug 42

set variable 44

set verbose 45

show context 46

show session 47

show variables 48

show version 49

Access Server commands 50

connect server 51

disconnect server 52

modify server 53

show server 55

Datastore commands 56

connect datastore 57

define external target datastore 60

disconnect datastore 62

list database schemas 63

list database tables 64

list databases 65

list datastores 66

list datatypes 67

list encodings 68

list journal control fields 69

select datastore 70

show datastore 72

Tables commands 74

add replication table 75

list index columns 77

list replication tables 79

list table columns 81

list table indexes 83

readd replication table 85

remove replication table 87

Subscription commands 89

add subscription 90

delete subscription 93

describe subscription 94

export subscription 95

import subscription 97

list subscriptions 100

lock subscription 102

modify latency thresholds 103

modify subscription 105

modify subscription datastage properties 108

modify subscription user exit 111

promote subscription 113

select subscription 116

show latency thresholds 117

show subscription 118

show subscription datastage properties 120

show subscription user exit 121

unlock subscription 122

Table mapping commands 124

add rule set 125

add table mapping 128

delete rule set 134

delete table mapping 135

export rule set 136

export table mapping 138

flag refresh 139

list refresh order 141

list rule set tables 142

list rule sets 143

list table mappings 144

mark capture point 146

modify refresh order 148

modify rule set 150

modify table mapping 153

park table mapping 157

promote rule set 158

promote table mapping 160

reassign table mapping 163

select rule set 164

select table mapping 165

show rule set 167

show table mapping 169

Mapping details commands 171

add data translation 172

add derived column 173

clear user exit 176

delete data translation 177

delete derived column 178

filter source column 179

list column encodings 181

list column mappings 183

list source columns 185

map column 187

modify column encoding 190

modify data translation 192

modify derived column 193

modify operations 196

modify user exit cdll 204

modify user exit function 206

modify user exit javaclass 208

modify user exit storedproc 211

show data translation 213

show derived column 214

show operations 216

show user exit 218

unmap column 220

Replication commands 221

clear datastore events 222

clear subscription events 223

end replication 224

list datastore events 227

list subscription events 228

list subscription performance metrics 229

list table performance metrics 231

monitor replication 233

monitor subscription activity 234

monitor subscription busy tables 235

monitor subscription latency 236

monitor subscription performance 237

monitor subscription refresh 238

monitor table performance 239

show datastore event details 241

show subscription event details 242

start mirroring 243

start refresh 245

Access Manager commands 247

add access connection 248

add access datastore 250

add access user 251

change login password 253

close access user connections 254

delete access connection 255

delete access datastore 256

delete access user 257

list access datastores 258

list access users 259

modify access connection 260

modify access datastore 262

modify access user 264

show access connection 266

show access datastore 268

show access user 269

Support commands 271

run support assistant 272

Management Console Commands reference 273

Using commands in Management Console 274

Opening command environments 275

To issue commands in a Windows environment 276

To issue commands in a UNIX or Linux environment 277

To issue commands in a Telnet environment 278

Management Console commands 279

addTable - Add Table to Catalog 281

assignTable - Assign Source Table 282

connectAgent - Connect to Datastore 285

connectServer - Connect to Access Server 286

deAssignTable - Unassign Target Table 288

describe - Describe Selected Tables 289

disconnectAgent - Disconnect from Datastore 290

disconnectServer - Disconnect from Access Server 291

errorHandle - Define Error Handler 292

execute - Run Batch File 293

exit - Close Command Environment 294

getAgents - Get Accessible Datastores 295

getSubscriptionActivity - Get Subscription Activity 296

getSubscriptions - Get Subscriptions for Datastore 297

getSubscriptionStatus - Get Subscription Status 298

getSubscriptionTables - Get Subscription Tables 299

getTableStatus - Get Source Table Status 300

help - Display Command Help 301

reAddTable - Re-add Table in Catalog 302

removeTable - Remove Table from Catalog 303

setReplication - Set Replication Method 304

setTableStatus - Set Source Table Status 306

startRefresh - Start Refresh 307

startMirror - Start Mirroring 309

stopAll - Stop All Replication Activities 311

stopMirror - Stop Mirroring 312

stopRefresh - Stop Refresh 314

subscribeTable - Select Table to Subscription 316

unSubscribeTable - Deselect Table from Subscription 317

Scripting support 318

Creating a script file 319

Compiling a script file 321

To compile a script file (Windows) 322

To compile a script file (Linux or UNIX) 323

To compile a script file (Telnet) 324

Running a batch file 325

User roles and permissions 326

User roles 327

User permissions 328

Troubleshooting 332

Using the IBM Support Assistant (ISA DC) 333

To use ISA DC to collect data for a product problem (command line) 334

To use ISA DC to collect data for a product problem (GUI) 337

To use ISA DC to collect data for a question or an enhancement request (command line) 339

To use ISA DC to collect data for a question or an enhancement request (GUI) 341

Troubleshooting and contacting IBM Support 343

Getting started with the CHCCLP program

CHCCLP is the command line interface for IBM®InfoSphere® Change Data Capture

version 10.2 or later datastores. CHCCLP allows users to script InfoSphere CDC

functionality, such as connecting to datastores, creating subscriptions, mapping

tables, modifying mapping details, and controlling and monitoring replication.

The CHCCLP program can process the commands in one of three modes:

Interactive—Run CHCCLP commands one at a time from an interactive command

prompt.

Batch—Assemble CHCCLP commands in a script file that is processed by a single

invocation of the program. Batch mode uses the same syntax as Interactive mode.

Embedded—Run CHCCLP commands through a Java™ programming interface.

Related concepts

Running the CHCCLP commands in interactive mode

Running the CHCCLP commands in batch mode

Running the CHCCLP commands in embedded mode

Getting started with the CHCCLP program

CHCCLP is the command line interface for IBM®InfoSphere® Change Data Capture

version 10.2 or later datastores. CHCCLP allows users to script InfoSphere CDC

functionality, such as connecting to datastores, creating subscriptions, mapping

tables, modifying mapping details, and controlling and monitoring replication.

The CHCCLP program can process the commands in one of three modes:

Interactive—Run CHCCLP commands one at a time from an interactive command

prompt.

Batch—Assemble CHCCLP commands in a script file that is processed by a single

invocation of the program. Batch mode uses the same syntax as Interactive mode.

Embedded—Run CHCCLP commands through a Java™ programming interface.

Related concepts

Running the CHCCLP commands in interactive mode

Running the CHCCLP commands in batch mode

Running the CHCCLP commands in embedded mode

Supported operating systems

The CHCCLP program runs on Linux, UNIX, Windows, z/OS®, and UNIX System

Services (USS) on z/OS.

The CHCCLP commands generate replication definitions for all operating system

environments that are supported by InfoSphere® CDC: z/OS, Linux, UNIX, and

Windows. You must have connectivity to each server for which you are generating

replication definitions; that is, you must be able to issue a database connection

statement to each of the servers.

Note: Additional configuration steps are required to enable the CHCCLP to run

natively on z/OS or on USS.

Running CHCCLP

If you want to use the CHCCLP simplified command line tool on a server other than

the one on which Management Console or Access Server are currently installed and

running, you can install copies of Access Server on any server from which you want

to issue commands; the additional installations of Access Server do not need to be

running for you to use the CHCCLP tool.

Note: Your command prompt or terminal window might need to have its size

adjusted to larger than 80 characters in order to display command output without

wrapping.

Running CHCCLP on Windows

Open the Command Line Processor from the Windows Start menu. By default, the

Management Console installer creates the following Start menu shortcut: IBM®

InfoSphere® Change Data Capture/Management Console/Command Line

ProcessorThis method can only be used to launch CHCCLP in interactive mode.

The same shortcut is created by the Access Server installer.

Alternatively, open an operating system command prompt, change to the

installation folder for Management Console or Access Server, and in the bin folder,

issue the following command: chcclp

The CHCCLP command starts the CHCCLP program and changes the command

prompt to Repl >.

Running CHCCLP on Linux or UNIX

Open an operating system command prompt, change to the installation folder for

Access Server, and in the bin folder, issue the following command: ./chcclp

The CHCCLP command starts the CHCCLP program and changes the command

prompt to Repl >.

Running CHCCLP on z/OS

You can enable the CHCCLP command-line program to run on UNIX System

Services (USS) for z/OS®.

Install the IBM SDK for z/OS, Java™ Technology Edition, Version 6 on USS. You

can find the SDK at http://www.ibm.com/servers/eserver/zseries/software/java.

Set the JAVA_HOME environment variable to point to the Java installation, and

CHC_HOME environment variable to point to the installation folder for CHCCLP:

export JAVA_HOME=/usr/lpp/java/J6.0

export CHC_HOME=/usr/lpp/chc

Update the PATH environment variable to include CHCCLP:export

PATH=$PATH:$CHC_HOME/bin

In the UNIX System Services prompt, issue the following command: chcclp

In this section, you will learn:

Running the CHCCLP commands in interactive mode

Running the CHCCLP commands in batch mode

Running the CHCCLP commands in embedded mode

Running the CHCCLP commands in interactive

mode

You can run the CHCCLP commands in interactive mode from a command prompt.

See also:

To run the CHCCLP commands in interactive mode

Working with command results in interactive mode

Parent topic:Running CHCCLP

To run the CHCCLP commands in interactive mode

Procedure

Launch CHCCLP on your operating system. The CHCCLP command starts the

CHCCLP program in interactive mode by default and changes the command

prompt to Repl >.

Issue any of the CHCCLP commands.

To exit the CHCCLP program, issue either of the following commands:quit;

exit;

Parent topic:Running the CHCCLP commands in interactive mode

Working with command results in interactive mode

In interactive mode, commands display their output in the prompt window. There are

six results for a command:

Success with no results—The command executes with no output and the

interactive prompt returns to Repl >. Most commands that add or modify

configuration use this method. For example, the command add subscription does

not display any output if the subscription was added successfully.

Success with a text value—The interactive prompt displays a formatted output

string for a command. Commands like show datastore event details use this

method. The command documentation identifies this result type as

ResultStringValue.

Success with a list of values—The interactive prompt displays a list of strings.

The command help uses this output. The command documentation identifies this

result type as ResultStringList.

Success with a table of key pairs or value pairs—The interactive prompt

displays a table of key pairs or value pairs containing the output of the command.

Commands like show subscription use this method. The command documentation

identifies this result type as ResultStringKeyValues.

Success with a table of records—The interactive prompt displays a table of

results with column headers and a row for each record. Commands like list

subscriptions use this method. The command documentation identifies this result

type as ResultStringTable.

Failure—The command fails to execute and displays an error code and message.

Parent topic:Running the CHCCLP commands in interactive mode

Running the CHCCLP commands in batch mode

You can run the CHCCLP commands in batch mode by using an input file.

A CHCCLP input file is known as a script. A CHCCLP script contains the same

commands used in interactive mode. Each command ends with a semicolon (;). The

script can also contain comments. These lines start with a pound sign (#). The first

command, excluding comments, in a script must be “CHCCLP session set to cdc” in

order to identify the script for InfoSphere® CDC.

Commands are executed in sequence. If a command returns an error, batch

processing terminates.

See also:

To run CHCCLP commands in batch mode

To run a script file with substitution variables

Working with command results in batch mode

Parent topic:Running CHCCLP

To run CHCCLP commands in batch mode

Procedure

Follow the instructions for your operating system to open a system command

prompt and locate the CHCCLP program.

Issue the following command: CHCCLP –f <file>

where <file> is the fully qualified file name.

Parent topic:Running the CHCCLP commands in batch mode

To run a script file with substitution variables

Procedure

Create a script file containing a series of commands. For any parameter values

for which you want to provide input at execution time, define a variable name and

use %variableName% in place of the actual value. For example:

CHCCLP session set to cdc;

connect server

hostname %hostname% port %port%

username %username% password %password;

connect datastore name %source% context source;

connect datastore name %target% context target;

...

disconnect server;

exit;

Open an operating system command prompt and issue the following command,

providing variableName:value arguments for each substitution variable in the

script:CHCCLP –f script.txt hostname:myserver port:10101

username:user1 password:pass1 source:ds1 target:ds2

Parent topic:Running the CHCCLP commands in batch mode

Working with command results in batch mode

In batch mode, commands display their output in the prompt window. There are six

results for a command:

Success with no results—The command executes with no output and the

interactive prompt returns to Repl >. Most commands that add or modify

configuration use this method. For example, the command add subscription does

not display any output if the subscription was added successfully.

Success with a text value—The interactive prompt displays a formatted output

string for a command. Commands like show datastore event details use this

method. The command documentation identifies this result type as

ResultStringValue.

Success with a list of values—The interactive prompt displays a list of strings.

The command help uses this output. The command documentation identifies this

result type as ResultStringList.

Success with a table of key pairs or value pairs—The interactive prompt

displays a table of key pairs or value pairs containing the output of the command.

Commands like show subscription use this method. The command documentation

identifies this result type as ResultStringKeyValues.

Success with a table of records—The interactive prompt displays a table of

results with column headers and a row for each record. Commands like list

subscriptions use this method. The command documentation identifies this result

type as ResultStringTable.

Failure—The command fails to execute and displays an error code and message.

Parent topic:Running the CHCCLP commands in batch mode

Running the CHCCLP commands in embedded

mode

You can interact with the command line processor using EmbeddedScript in a

Java™ program. EmbeddedScript accepts the same commands as interactive or

batch mode and provides the ability to execute commands and retrieve results.

See also:

To set up EmbeddedScript

Working with EmbeddedScript

Working with command results in embedded mode

Sample programs

Parent topic:Running CHCCLP

Related concepts

Getting started with the CHCCLP program

To set up EmbeddedScript

Procedure

Open your Java™ programming environment, create a new Java project, and add

the following library from an Access Server installation:<access server installation>

/lib/CHCCLP.jar

If you want to copy the CHCCLP.jar file into your Java programming environment,

rather than pointing to CHCCLP.jar in the Access Server installation, you must

copy all jar files from <access server installation>/lib.

Create a new class, and add the following import statement:import

com.ibm.replication.cdc.scripting.*;

Additional imports may be required depending on your code.

Parent topic:Running the CHCCLP commands in embedded mode

Working with EmbeddedScript

The EmbeddedScript class provides support for starting a scripting session,

executing scripting commands, retrieving results, and ending the session using the

Java™ programming language.

Modifier and Type / Method Description

void open() throws

EmbeddedScriptExceptionOpen

s a connection to the command

line processor.

EmbeddedScript script = new

EmbeddedScript();

try

{

script.open();

...

}

catch (EmbeddedScriptException e)

{

...

}

finally

{

script.close();

}

void execute() throws

EmbeddedScriptExceptionE

xecutes a script command.

Statements do not need to be

terminated with semicolon (;)

when executing commands

using EmbeddedScript. If the

command succeeds, the results

can be accessed by calling

getResult(). If the command

fails, an exception is thrown.

EmbeddedScript script = new

EmbeddedScript();

try

{

script.open();

script.execute(connect server username

user1 password pass1);

Result result = script.getResult();

...

}

catch (EmbeddedScriptException e)

{

int resultCode = e.getResultCode();

String message = e.getResultMessage();

}

finally

{

script.close();

}

void close()Closes from the

command line processor

session. Closing is required and

ensures that the command line

processor successfully

disconnects from datastores and

Access Server, if those

connections are not closed using

scripting commands.

EmbeddedScript script = new

EmbeddedScript();

try

{

script.open();

...

}

catch (EmbeddedScriptException e)

{

...

}

finally

{

script.close();

}

Result getResult()Returns the last

result. Results can be printed to

the console using

result.display(System.ou

t) or cast to a specific result

type:

ResultNullResultStringKeyValue

sResultStringListResultStringTa

bleResultStringValuetry

{

script.execute(list datastores);

Result result = script.getResult();

if (result instanceof

ResultStringTable)

{

...

}

catch (EmbeddedScriptException e)

{

...

}

int getResultCode()Returns the

result code for statement

execution.

String getResultMessage()Returns

the last result message. The

message may be null if the

command executes successfully.

int getStatus()Returns the

status of the command as

EmbeddedScript.SUCCESS or

EmbeddedScript.FAILURE.

String getVerboseMessages()If

verbose is enabled, returns any

messages that have been

logged during command

execution. To enable verbose

mode, execute:

script.execute(set verbose);

The EmbeddedScriptException class provides access to the result error code and

result error message

Parent topic:Running the CHCCLP commands in embedded mode

Header Header

int getResultCode()Returns the

result code for statement

execution.

String getResultCodeAndMessage(

)Returns a formatted result code

and message.

String getResultMessage()Returns

the last result message. The

message may be null if the

command executes successfully.

Working with command results in embedded mode

The EmbeddedScript method getResult() returns the result of the last command

that was executed There are five types of Result supported by EmbeddedScript. In

order to cast a result to its specific type, check the result object to determine which

class it is, or call getType(). While the documentation indicates the type of result

returned for each command, it is recommended to confirm that the type is the

correct instance before using it.

Using instanceof to check the type:

script.execute(list subscriptions);

Result result = script.getResult();

if (result instanceof ResultStringTable)

{

...

}

Using getType() to check the type:

script.execute(list subscriptions);

Result result = script.getResult();

switch (result.getType())

{

case Result.TABLE:

...

break;

}

The key methods for each of the result types are as follows:

ResultNull for commands with no output.

String

toString()Returns an empty string

ResultStringKeyValues for commands that return a collection of string-based

key-value pairs.

String[]

getKeys()

Returns an array containing the keys in the result.

String[]

getNames()

Returns the column names for the result.

int

getRowCount()

Returns the number of keys in the result.

String

getValue(String key)

Returns the value for a given key, or null if the key cannot be found.

String

toString()

Returns a formatted text representation of the result.

ResultStringList for commands that return a list of strings.

int

getRowCount()

Returns the number of strings in the result.

String

getValueAt(int row) throws IndexOutOfBoundsException

Returns the value for a row index. Row indexes start from zero.

String

toString()

Returns a formatted text representation of the result.

ResultStringTable for commands that return a table of records.

int

getColumnCount()

Returns the number of columns in the table.

String

getColumnAt(int column) throws IndexOutOfBoundsException

Returns the name of a column for the column index. Column indexes start

from zero.

int

getRowCount()

Returns the number of rows in the result.

String

getValueAt(int row, int column) throws

ArrayIndexOutOfBoundsException

Returns the value for a row and column index. Row indexes start from zero.

Column indexes start from zero.

String

getValueAt(int row, String columnName) throws

ArrayIndexOutOfBoundsException

Returns the value for a row and named column. Row indexes start from zero.

Returns null if no value is found.

int rowCount = result.getRowCount();

for (int row = 0; row < rowCount; row++)

{

String value = result.getValueAt(row, DATASTORE);

…

}

int

lookupRow(String lookupColumnName, String lookupValue)

Returns the row index where the named lookup column contains the given

lookup value.

int row = result.lookupRow(LASTNAME, SMITH);

String firstName = result.getValueAt(row, FIRSTNAME);

String middleName = result.getValueAt(row, MIDDLENAME);

String

lookupValue(String lookupColumnName, String

keyColumnName,

String keyValue)

Returns the string value in the named lookup column where the named key

column contains a key value.

String firstName = result.lookupValue(FIRSTNAME, LASTNAME,

SMITH);

String middleName = result.lookupValue(MIDDLENAME, LASTNAME,

SMITH);

String

toString()

Returns a formatted text representation of the result.

ResultValue for commands that return a string value.

String

getValue()

Returns the value.

String

toString()

Returns a formatted text representation of the result.

The results for a command may contain elements that are translated. For example,

an application run in Japanese will display column names, keys, and possibly values

in Japanese. Applications written using EmbeddedScript must account for language

differences, if those applications are run in multiple languages.

Parent topic:Running the CHCCLP commands in embedded mode

Sample programs

The following example connects to Access Server and two datastores, creates a

subscription, maps a few tables, and starts replication.

import com.ibm.replication.cdc.scripting.EmbeddedScript;

import com.ibm.replication.cdc.scripting.EmbeddedScriptException;

import java.text.MessageFormat;

public class Sample1

{

public static void main(String[] args)

{

EmbeddedScript script = new EmbeddedScript();

try

{

script.open();

script.execute(connect server username user1 password pass1);

script.execute(connect datastore name DS1 context source);

script.execute(connect datastore name DS2 context target);

script.execute(add subscription name SUB1);

String mapping = add table mapping

+ sourceSchema {0} sourceTable {1}

+ targetSchema {2} targetTable {3};

script.execute(MessageFormat.format(mapping, new Object[] {

USER1, TABLE_1, USER1, TABLE_1 }));

script.execute(MessageFormat.format(mapping, new Object[] {

USER1, TABLE_2, USER1, TABLE_2 }));

script.execute(MessageFormat.format(mapping, new Object[] {

USER1, TABLE_3, USER1, TABLE_3 }));

script.execute(start mirroring);

script.execute(disconnect server);

}

catch (EmbeddedScriptException e)

{

System.out.println(e.getResultCodeAndMessage());

}

finally

{

script.close();

}

The following example connects to Access Server and two datastores, gets the list

of subscriptions with monitor summary and starts any that are not currently

mirroring.

import com.ibm.replication.cdc.scripting.EmbeddedScript;

import com.ibm.replication.cdc.scripting.EmbeddedScriptException;

import com.ibm.replication.cdc.scripting.Result;

import com.ibm.replication.cdc.scripting.ResultStringTable;

public class Sample2

{

public static void main(String[] args)

{

EmbeddedScript script = new EmbeddedScript();

try

{

script.open();

script.execute(connect server username user1 password pass1);

script.execute(connect datastore name DS1 context source);

script.execute(connect datastore name DS2 context target);

script.execute(monitor replication);

Result result = script.getResult();

if (result.getType() == Result.TABLE)

{

ResultStringTable table = (ResultStringTable) result;

// Prints the table to the console window.

table.display(System.out);

String subscription;

String state;

for (int row = 0, rows = table.getRowCount(); row < rows; row++)

{

subscription = table.getValueAt(row, SUBSCRIPTION);

state = table.getValueAt(row, STATE);

if (state.equals(Inactive))

{

System.out.println(Starting + subscription);

script.execute(start mirroring name + subscription);

}

script.execute(disconnect server);

}

catch (EmbeddedScriptException e)

{

System.out.println(e.getResultCodeAndMessage());

}

finally

{

script.close();

}

Parent topic:Running the CHCCLP commands in embedded mode

Overriding the locale

You can override the locale for CHCCLP. The following list indicates the languages

that are supported by InfoSphere® CDC:

English (en)

Japanese (ja)

Korean (ko)

Simplified Chinese (zh_CN)

To change the locale, open an operating system command prompt and issue the

following command:

CHCCLP –L <locale>

where <locale> is the abbreviation for the supported language.

Enabling verbose command output

Verbose mode displays additional output for many commands. By default, verbose

mode is not enabled.

Execute either of the following commands to turn on verbose mode:

set verbose;

set debug verbose yes;

Execute the following command to turn off verbose mode:

set debug verbose no;

In verbose mode, commands that normally run as “Success with no results” display

a success code and message. Commands may additionally report progress as the

command executes.

Setting and working with context

The context defines the Access Server, source and target datastores, subscription

and table mapping that are currently active in the script. The context is similar to

selection in Management Console. For example, in order to view or modify column

mappings in Management Console, you must select a table mapping in the current

subscription. In scripting, you must set the context to a table mapping. Setting a

table mapping context requires a subscription to be the current context, and the

subscription context requires a source and target datastore context.

To view the current context, execute the show context command.

CONTEXT CURRENT OBJECT

------------------ ----------------------------------

Access Server localhost@10101

Source Datastore DS1

Target Datastore DS2

Subscription SUB1

Table Mapping CDC.TABLE_1 - CDC.TABLE_1

Setting the Access Server context

When you connect to Access Server, the context is automatically set. Disconnecting

from Access Server clears all context settings. Setting the datastore

context

When you connect to a datastore, the context is automatically set to the source and

target, depending on the capabilities of the datastore. For example, connecting to a

DB2® datastore sets the source and target context to that datastore, because the

DB2 datastore can be used as a source and target in subscriptions. Connecting to

an InfoSphere® DataStage® datastore sets the target context, because the

InfoSphere DataStage datastore can only be used as a target.Specifying or

changing the context can be performed during connection or afterwards. You do not

have to disconnect and reconnect to change the context, and you can change the

context as often as you need.

To connect to a DB2 datastore and set it to source and target context, execute the

connect datastore command:

connect datastore name DB2DS;

If you now execute the add subscription command, the subscription will be created

with DS2DS datastore as the source and target datastores for the subscription. If

you want to create a subscription between two different datastores, you can either

connect to those datastores and identify your intention using the following

commands:

connect datastore DB2DS1 context source;

connect datastore DB2DS2 context target;

or you can connect to both datastores and specify the context after:

connect datastore DB2DS1;

connect datastore DB2DS2;

select datastore DB2DS1 context source;

select datastore DB2DS2 context target;

You can also execute the following, where the first connect statement will set the

context for the source and target to DB2DS1, and the second connect will override

the target context to DB2DS2:

connect datastore DB2DS1;

connect datastore DB2DS2 context target;

When you specify the context during connection, the context will only be set if the

connection succeeds. If you need to change the context after you have connected,

use the select datastore command. If the context is invalid for the datastore, an error

will be reported, but the datastore connection will not be closed. For example, if you

execute connect to an InfoSphere DataStage datastore with source context, the

connection will succeed, but the context switch to source will fail.

When you disconnect from a datastore, the source and target context (as

applicable) is cleared if that datastore was currently specified as the context.

Setting the subscription context

When you add a new subscription, its source and target datastores are controlled by

the current context and the new subscription is automatically set as the current

context. The subscription context can be changed at any time by executing the

select subscription command:select subscription name SUB1;

When you delete a subscription, the subscription context is cleared.

Setting the table mapping context

When you add a new table mapping, the table mapping is added to the subscription

that is the current context and the new table mapping is automatically set as the

current context. The table mapping context can be changed at any time by

executing the command:select table mapping…

The select table mapping command has various optional parameters to identify

which table mapping to select. You do not need to specify all parameters. The

command will succeed if a unique table mapping is identified, otherwise the

command will report an error. For example, to select a table mapping based on the

name of a source table, execute the following command:

select table mapping sourcetable TABLE1;

When you delete a table mapping, the table mapping context is cleared.

Related reference

disconnect server

connect datastore

add subscription

select subscription

select table mapping

CHCCLP Commands

This section discusses the commands available with InfoSphere® CDC. Using these

commands you can control replication, manage your tables for replication, monitor

replication, and perform various other tasks.

In this section, you will learn:

Understanding command syntax

Environment commands

Access Server commands

Datastore commands

Tables commands

Subscription commands

Table mapping commands

Mapping details commands

Replication commands

Access Manager commands

Support commands

Understanding command syntax

Command formats

For each command, the following items of information are provided:

Syntax and syntax diagram—Identifies the name of the command and lists the

command parameters.

Parameters—Describes each parameter in the command and identifies the values

that can be specified.

Result—Indicates the values that are returned by the command if it is successful.

This section also specifies the information that is displayed on the screen, if any,

as a result of executing the command.

Examples—Provides one or more examples of invoking the command.

Parameter formats

Note the following conventions in the definition of the command parameters:

Angle brackets ( < > ) indicate a variable value.

Square brackets ( [ ] ) indicate an optional parameter. If you omit the parameter,

InfoSphere® CDC will use a default value.

Using quotation marks in CHCCLP commands

Use double quotation marks around parameter values that contain special

characters or syntax keywords, or around empty strings.

The following text is an example of setting a description for a subscription with

spaces:

add subscription name TEST description "A test subscription";

If the parameter value contains double quotation marks, use single quotation marks

around the value. Parameter values cannot contain a mixture of single and double

quotes.

The following text is an example of setting descriptions that contain single or double

quotes:

add subscription name TEST description 'A "test" subscription';

add subscription name TEST description "A 'test' subscription";

Parent topic:CHCCLP Commands

Environment commands

See also:

chcclp session set to cdc

clear context

exit

help

quit

save session

set debug

set variable

set verbose

show context

show session

show variables

show version

Parent topic:CHCCLP Commands

chcclp session set to cdc

Use this command to identify that the script executes InfoSphere® CDC commands.

This command must be the first statement in a script file. It is not required when

running commands in the interactive prompt.

Syntax diagram

.arrow, .syntaxarrow { fill: none; stroke: black; } .arrowheadStartEnd,

.arrowheadRepSep, .arrowheadRepSepReturn { stroke: black; fill: black; }

.arrowheadSeq, .arrowheadStartChoice, .arrowheadAfterChoice,

.arrowheadStartRepGroup, .arrowheadEndRepGroup, .arrowheadRev { stroke:

none; fill: none; } rect { fill: none; stroke: none; } rect.fragref,rect.syntaxfragref { fill:

none; stroke: black; } text { fill: #000000; fill-opacity: 1; font-family: IBM Plex

Sans,Arial Unicode MS,Arial,Helvetica; font-style: normal; font-weight: normal; font-

size: 8pt; stroke: #000000; stroke-width: 0.1; } text.var, text.syntaxvar {font-

style:italic;} chcclp session set to cdc

Syntax

chcclp session set to cdc;

Parameters

None. Required role

Any Result

None. Sample

Identifies InfoSphere CDC scripts when executing from a script file.chcclp session set to

cdc;

connect server username user1 password password1;

connect datastore name DS1;

disconnect datastore;

disconnect server;

exit;

Parent topic:Environment commands

clear context

Use this command to clear the datastore, subscription or table mapping context.