dmset - Set CDC Replication system parameter

Use this command to view or change CDC Replication system parameters.

You can also change system parameters in Management Console.

You can set parameter values per subscription, per table, or per instance. Follow these guidelines:

  • If you specify = but no value, the property value is cleared.
  • If you do not specify =, the parameter values are returned.
  • Specifying -s makes the value specific to the specified subscription.
  • Specifying -t makes the value specific to the specified table.
  • Specifying -s and -t makes the value specific to the specified subscription and table name.

The precedence hierarchy is per-subscription-per-table, per-subscription, per-table, and per-instance.

The dmset command displays values as follows:

param:sub:table=value // subscription and table -specific
param:sub=value // subscription specific
param::table=value // table specific
param=value // instance specific

When you ask to display a value for a particular parameter:

  • If a subscription name and table name are specified, show the one value for the specified property and specified subscription and specified table.
  • If a subscription name but no table name is specified, show all values for the specified property and specified subscription.
  • If a table name but no subscription name is specified, show all values for the specified property and specified table.
  • If no subscription name and no table name are specified, show all values for the specified property.

Not all system parameters support subscription-level or table-level properties.

If you try to set, delete, or display a subscription level property for a property that does not support it, you will get the following error message:

Subscription name is not applicable for property property-name

If you try to set, delete, or display a table level property for a property that does not support it, you will get the following error message:

Table name is not applicable for property property-name
Note: You can set any system parameter using this command. However, it will only display system parameters that are set to non-default values.

Syntax

dmset [-I instance_name] [parameter[=[value]]] [-s subscription_name] [-t schema_name.table_name]

Parameters

[-I instance_name]
Specifies the name of the CDC Replication instance. Alternatively, you can specify the TSINSTANCE environment variable in place of this value.
[parameter]
Specifies the name of the CDC Replication system parameter.
[value]
Specifies the value that you want to assign to the system parameter.
[subscription_name]
Specifies the subscription to which the parameter value applies.
schema_name]
Specifies the schema of the table to which the parameter value applies.
table_name]
Specifies the name of the table to which the parameter value applies.

Result

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

Examples

dmset -I MYINSTANCE

Displays all of the system parameters that are set to non-default values.

dmset -I MYINSTANCE events_max_retain=20000

Sets the events_max_retain system parameter to 20000.

dmset -I MYINSTANCE events_max_retain

Displays the current value of the specified parameter.

dmset -I MYINSTANCE stop_replication=

Deletes the stop_replication system parameter.

dmset -I MYINSTANCE on_utility_action=REFRESH -s MYSUB -t MYTABLE

Sets the on_utilty_action system parameter to REFRESH for the specified subscription and specified table.