Replication Management API Reference, 174 of 179

PURGE_SNAPSHOT_FROM_LOG procedure

This procedure is called on the master site to delete the rows in snapshot refresh related data dictionary tables maintained at the master site for the specified snapshot identified by its snapshot_id or the combination of the snapowner, snapname, and the snapsite. If the snapshot specified is the oldest snapshot to have refreshed from any of the master tables, then the snapshot log is also purged. This procedure does not unregister the snapshot.

In case there is an error while purging one of the snapshot logs, the successful purge operations of the previous snapshot logs are not rolled back. This is to minimize the size of the snapshot logs. In case of an error, this procedure can be invoked again until all the snapshot logs are purged.

Syntax

DBMS_SNAPSHOT.PURGE_SNAPSHOT_FROM_LOG (
   snapshot_id   IN   BINARY_INTEGER  |
   snapowner     IN   VARCHAR2,
   snapname      IN   VARCHAR2, 
   snapsite      IN   VARCHAR2);

Note:
This procedure is overloaded. The snapshot_id parameter is mutually exclusive with the three remaining parameters: snapowner, snapname, and snapsite.

Parameters

Table 8-309 PURGE_SNAPSHOT_FROM_LOG Procedure Parameters

Parameter	Description
snapshot_id	If you want to execute this procedure based on the ID of the target snapshot, specify the snapshot ID using the `snapshot_id` parameter. Query the `DBA_SNAPSHOT_LOGS` view at the snapshot log site for a listing of snapshot IDs. Executing this procedure based on the snapshot ID is useful if the target snapshot is not listed in the list of registered snapshots (`DBA_REGISTERED_SNAPSHOTS`).
snapowner	If do not specify a `snapshot_id`, enter the owner of the target snapshot using the `snapowner` parameter. Query the `DBA_REGISTERED_SNAPSHOTS` view at the snapshot log site to view the snapshot owners.
snapname	If do not specify a `snapshot_id`, enter the name of the target snapshot using the `snapname` parameter. Query the `DBA_REGISTERED_SNAPSHOTS` view at the snapshot log site to view the snapshot names.
snapsite	If do not specify a `snapshot_id`, enter the site of the target snapshot using the `snapsite` parameter. Query the `DBA_REGISTERED_SNAPSHOTS` view at the snapshot log site to view the snapshot sites.