alter applied function replication definition

Description

Changes the function replication definition created by the create applied function replication definition command.

Syntax

alter applied function replication definition repdef_name
        {with replicate function named ‘func_name’ |
        add @param_name datatype[, @param_name datatype]… |
        add searchable parameters @param_name[, @param_name]… |
        send standby {all | replication definition} parameters}
         [with DSI_suspended]

Parameters

repdef_name

The name of the applied function replication definition to change.

with replicate function named 'func_name'

Specifies the name of the stored procedure to execute at the replicate database. func_name is a character string with a maximum length of 255 characters.

add

Adds parameters and their datatypes to the applied function replication definition.

@param_name

The name of a parameter you are adding to the list of replicated or searchable parameters. Each parameter name must begin with the @ character.

datatype

The datatype of the parameter you are adding to the parameter list. See “Datatypes” for a list of the datatypes and their syntax. Adaptive Server stored procedures and function replication definitions cannot contain parameters with the text, unitext, rawobject, and image datatypes.

add searchable parameters

Specifies additional parameters that you can use in the where clause of the create subscription or define subscription command.

send standby

In a warm standby application, specifies whether to send all parameters in the function (send standby all parameters) or only those specified in the replication definition (send standby replication definition parameters), to a standby database. The default is send standby all parameters.

with DSI_suspended

Allows you to suspend the standby DSI, if there is one, and each of the subscribing replicate DSI threads. Replication Server suspends the DSI thread in the standby or replicate database after Replication Server applies all the data for the old replication definition version to the standby or replicate database.

After Replication Server suspends a DSI thread, you can make changes to the target stored procedures, and to any customized function strings. When you resume the DSI thread, Replication Server replicates the primary updates using the altered replication definition.

You do not need to use with DSI_suspended if:

  • There is no subscription to the replication definition.

  • You do not need to change customized function strings.

  • You do not need to change the replicate or standby stored procedure.

NoteIf there is a subscription from a replicate Replication Server with a site version earlier than 1550, the replicate DSI threads for that Replication Server are not suspended.

Examples

Example 1

Adds the @notes, @pubdate, and @contract parameters to the titles_frep function replication definition:

alter applied function replication definition titles_frep
add @notes varchar(200), @pubdate datetime, @contract bit

Example 2

Adds the @type and @pubdate parameters to the list of searchable parameters in the titles_frep function replication definition:

alter applied function replication definition titles_frep
add searchable parameters @type, @pubdate

Example 3

Changes the titles_frep function replication definition to be replicated as the newtitles stored procedure at the replicate database, and instructs Replication Server to suspend the target DSI after primary data that exists before you execute alter applied replication definition is replicated to the replicate database:

alter applied function replication definition titles_frep
with replicate function named ‘newtitles’
with DSI suspended

Usage

Permissions

alter applied function replication definition requires “create object” permission.

See also

alter function string, alter replication definition, alter function replication definition, alter request function replication definition, create applied function replication definition, create request function replication definition, rs_send_repserver_cmd, rs_helprepversion