Skip to content

spock.sub_disable

The spock.sub_disable() function disables a subscription and disconnects from the provider.

Synopsis

spock.sub_disable(subscription_name name, immediate boolean)

Description

The spock.sub_disable() function disables a subscription by putting the subscription on hold and disconnecting from the provider.

Arguments

The function accepts the following arguments:

  • subscription_name - The name of an existing subscription.
  • immediate - If true, the subscription is stopped immediately; otherwise the subscription will be stopped only at the end of the current transaction. The default is false.

Example

In the following example, the spock.sub_disable() function disables a subscription named sub_n1_n2:

SELECT spock.sub_disable('sub_n1_n2');
 sub_disable
-------------
 t
(1 row)