If a procedure of this name exists, it is called at the beginning of the download stage of the synchronization process.

Actions of this procedure are committed or rolled back when the download is committed or rolled back.

Hook procedures can be created by any user with the MANAGE REPLICATION system privilege. However, to ensure that the hook can access the #hook_dict table, which is used to pass information in and out of hooks, hooks must meet one of the following requirements:

• Synchronization event hook sequence

Assume you use the following table to log synchronization events on the remote database.

CREATE TABLE SyncLog
(
   "event_id"           integer NOT NULL DEFAULT AUTOINCREMENT ,
   "event_time"         timestamp NULL,
   "event_name"         varchar(128) NOT NULL ,
   "subs"               varchar(1024) NULL ,
    PRIMARY KEY ("event_id")
)

The following logs the beginning of the download for each synchronization.

CREATE PROCEDURE sp_hook_dbmlsync_download_begin ()
BEGIN
    
    DECLARE subs_list VARCHAR(1024);

-- build a list of subscriptions being synchronized
    SELECT LIST(value) INTO subs_list
     FROM #hook_dict
     WHERE name LIKE 'subscription_%';

-- log the event
    INSERT INTO SyncLog(event_time, event_name, subs)
    VALUES( CURRENT TIMESTAMP, 'sp_hook_dbmlsync_download_begin', subs_list );
END