ttRepSubscriberStateSet

Description

Changes a replicating subscriber's state with respect to the executing master store.

Required privilege

This procedure requires the ADMIN privilege.

Syntax

ttRepSubscriberStateSet('replicationName', 'replicationOwner', 'subscriberStoreName', 'subscriberHostName', newStateCode)

Parameters

ttRepSubscriberStateSet has these parameters:

Parameter	Type	Description
`replicationName`	TT_CHAR (30)	The name of the replication scheme on which to operate. May be NULL to indicate all replication schemes.
`replicationOwner`	TT_CHAR (30)	The owner of the replication scheme. May be NULL to indicate all replication scheme owners.
`subscriberStoreName`	TT_VARCHAR (200)	The name of the subscribing data store whose state is to be set. May be NULL to indicate all stores on host `subscriberHostName`.
`subscriberHostName`	TT_VARCHAR (200)	The subscriber's host. May be NULL to indicate all hosts of subscribing peers.
`newStateCode`	TT_INTEGER	An integer code representing the specified subscriber's new state: 0/NULL - started 1 - paused 2 - stopped All other state codes are disallowed. (This procedure cannot set a subscriber state to "failed.")

Result set

ttRepSubscriberStateSet returns no results.

Examples

For the replication scheme named REPL.REPSCHEME, the following directs the master data store to set the state of the subscriber data store (SUBSCRIBERDS ON SYSTEM1) to Stop (2):

CALL ttRepSubscriberStateSet('REPSCHEME', 'REPL', 'SUBSCRIBERDS','SYSTEM1', 2);

To direct the master data store to set the state of all its subscribers to Pause (1), use:

CALL ttRepSubscriberStateSet( , , , , 1 );

Leaving a parameter empty is equivalent to using NULL.