Hook operations list

Hook operations typically run on the production or staging server. Exercise caution when you create hook operations as they can inadvertently alter the state of a production database.

Below is the behavior for various data sources:

Oracle: hook scripts run on the production host for regular data sources. For staging push dSources, the hook scripts run on the staging server.
SQL Server: hook scripts run on the staging server for both regular and staging push dSources.
SAP ASE: Pre Sync and Post Sync hook scripts run on the production host. Pre and Post Validated Sync hooks run on the staging server.

dSource hook operations

Hook	Description
Pre-sync	Executed before the SnapSync operation of a dSource. These operations can quiesce data for capture during SnapSync or stop application processes that may interfere with SnapSync.
Post-sync	Executed after the SnapSync operation of a dSource. Operations undo changes made by pre-sync hooks and will run regardless of the success of pre-sync hooks or SnapSync.

Virtual Database hook operations

Hook	Description
Configure clone	Operations performed after initial provision or after a refresh. Runs after the virtual dataset has started. During a refresh, this hook precedes the post-refresh hook.
Pre-refresh	Operations performed before a refresh. Runs before the virtual dataset is stopped. Operations can cache data from the virtual dataset for restoration after the refresh.
Post-refresh	Operations performed after a refresh. Runs after the virtual dataset has started and after configure clone. Will not run if the refresh or pre-refresh hook operation fails. Operations can restore cached data after refresh completion.
Pre-rollback	Operations performed before a rollback (rewind). Runs before the virtual dataset is stopped. Operations can cache data from the virtual dataset for restoration after rewind.
Post-rollback	Operations performed after a rollback (rewind). Runs after the virtual database has started. Will not run if the rewind or pre-rewind hook operations fail. Operations can restore cached data after rewind completion.
Pre-snapshot	Operations performed before a snapshot. Operations can quiesce data for capture during the snapshot or stop processes that may interfere with the snapshot.
Post-snapshot	Operations performed after a snapshot. Runs regardless of the success of the snapshot or pre-snapshot hook operations. Operations can undo changes made by the pre-snapshot hook.
Pre-start	Operations performed before the startup of a VDB or vFile. Can be used to initialize configuration files or stop processes that might interfere with the virtual dataset.
Post-start	Operations performed after the startup of a VDB or vFile. Can clean up temporary files, restart processes stopped by pre-start hooks, or log notifications.
Pre-stop	Operations performed before the shutdown of a VDB or vFile. Can quiesce data or processes prior to the virtual dataset shutdown.
Post-stop	Operations performed after the shutdown of a VDB or vFile. Can be used to log notifications, clean up temporary files, or manage related processes.

Order of execution of hooks for various VDB operations

Provision	Refresh	Rollback	Snapshot	Start	Stop
Pre-start	Pre-refresh	Pre-rollback	Pre-snapshot	Pre-start	Pre-stop
Post-start	Pre-stop	Pre-stop	Post-snapshot	Post-start	Post-stop
Configure clone	Post-stop	Post-stop
Run masking job	Pre-start	Pre-start
Pre-snapshot	Post-start	Post-start
Post-snapshot	Configure clone	Configure clone
	Run masking job	Run masking job
	Post-refresh	Post-rollback
	Pre-snapshot	Pre-snapshot
	Post-snapshot	Post-snapshot

Staging server hooks

Staging Server hooks are currently applicable to SAP ASE and will execute on the configured staging server.

Hook	Description
Pre validated sync	Operations performed on a staging server before validated sync. This hook will run before the validated sync operation whenever the validated sync run is triggered.
Post validated sync	Operations performed on staging server after validated sync. This hook will run after the validated sync operation whenever the validated sync run is triggered.

Hook

Description

Pre validated sync

Operations performed on a staging server before validated sync.

This hook will run before the validated sync operation whenever the validated sync run is triggered.

Post validated sync

Operations performed on staging server after validated sync.

This hook will run after the validated sync operation whenever the validated sync run is triggered.

Self-service interaction with hooks

These are the operations performed by the various Self-Service operations:

Rollback
Reset, Undo, and any Restore or Branch operation using source point-in-time or a bookmark that’s part of the current container.
Refresh
Refresh and any Restore or Create Branch operation from any shared bookmark or when using the Template as the source of the restore (bookmark or point-in-time).

The Virtual Database Hooks described above will run accordingly. Snapshots are taken, for recovery purposes, before and after every operation that is performed. Bookmark operations will also initiate a snapshot.