dmreaddtable - Update source table definition

Use this command to update the definition of one or more source tables in the CDC Replication metadata.

Run this command after you have changed the definition of a source table using your relational database.
Notes:
  • This command will set the table status to Parked after updating the source table definition in the CDC Replication metadata.
  • This command is not the equivalent of the Management Console Update Source Table Definition dialog, which you access by selecting Configuration > Subscriptions > <subscription_name>, then right-clicking the table mapping name under Table Mappings, and then selecting Update Table Definition > Source Table.
Note:

Syntax

dmreaddtable [-I <name>] -A|-t <schema>.<table> ... [-a] [-L <locale>]

Parameters

[-I <name>]
Specifies the name of the CDC Replication instance. Alternatively, you can specify the TSINSTANCE environment variable in place of this value.
-A
Specifies that CDC Replication updates definitions for all source tables that are available for replication.
-t <schema>.<table> ...
Specifies the name of a source table in the subscription for which CDC Replication updates the definition. You must specify the table name in the format schema.table.
To specify multiple tables, list the tables separated by a space.
[-a ]
Specifies that the source replication engine will preserve the Active table status after updating the definition of the source tables in the CDC Replication metadata.
By using this optional parameter, the table status will not be set to Parked, you will not lose the bookmark, and the tables will not require a refresh after you run the command.
[-L <locale>]
The name of the locale used for the CDC Replication instance. The default is your machine's locale.

Result

This command returns a value of 0 if the command was successful and a non-zero value if the command fails.

Examples

dmreaddtable -I NEWINSTANCE -A

CDC Replication updates definitions for all source tables that are available for replication. The status for all tables will be set to Parked.

dmreaddtable -I NEWINSTANCE -A -a

CDC Replication updates definitions for all source tables that are available for replication and all tables will retain an Active status.