21 DBMS_RA Package Reference
This chapter provides details on the DBMS_RA
PL/SQL package. You use DBMS_RA
subprograms to perform all Recovery Appliance administration functions.
One DBMS_RA
procedure may execute at a given time. With the exception of ABORT_RECOVERY_APPLIANCE
, attempts to run multiple DBMS_RA
procedure in different sessions at the same time fail with an appropriate message.
The following table summarizes the available DBMS_RA
subprograms.
Table 21-1 DBMS_RS Package Subprograms
Subprogram | Description |
---|---|
ABORT
|
Synonymous with |
ABORT_RECOVERY_APPLIANCE
|
This procedure shuts down the Recovery Appliance without waiting for in-progress operations to complete. |
ADD_DB
|
This procedure adds the specified database to the Recovery Appliance, and assigns a protection policy to the database. This procedure enables a non-protected database to attain the status of a protected database. |
ADD_REPLICATION_SERVER
|
This procedure adds the specified replication server configuration to the specified protection policy. After the operation succeeds, the Recovery Appliance replicates backups of databases protected by this policy to the downstream Recovery Appliance. |
CONFIG
|
This procedure updates a value in the |
COPY_BACKUP
|
This procedure copies one or more backup pieces from the Recovery Appliance to a
user-specified disk or SBT destination.
The Recovery Appliance copies all backup pieces matching the specified tag to the
location specified with the |
COPY_BACKUP_PIECE
|
This procedure copies a single backup piece from the Recovery Appliance to a user-specified disk or SBT destination. |
CREATE_ARCHIVAL_BACKUP
|
This procedure copies all backup pieces from Recovery Appliance as restricted by user inputs to TAPE with the ability to recover the protected database to a user specified point described by |
CREATE_POLLING_POLICY
|
This procedure creates a backup polling policy. |
CREATE_PROTECTION_POLICY
|
This procedure creates a protection policy. |
CREATE_REPLICATION_SERVER
|
This procedure defines a configuration for a downstream Recovery Appliance that forms part of a Recovery Appliance replication scheme. |
CREATE_SBT_ATTRIBUTE_SET
|
This procedure creates an SBT attribute set that SBT jobs can use. |
CREATE_SBT_JOB_TEMPLATE
|
This procedure creates an SBT job that describes how the Recovery Appliance chooses backups for copying to tape. This form of this overloaded procedure applies to backups for all protected databases assigned to the specified protection policy. |
CREATE_SBT_JOB_TEMPLATE
|
This procedure creates a new SBT backup job. The job describes how the Recovery Appliance chooses backups for copying to tape/cloud. This form of this overloaded procedure applies to backups for a single protected database only, whereas the previous form applies to backups of all databases assigned to a specific protection policy. With the exception of this difference, this procedure and its parameters are identical to the alternative form of this procedure. |
CREATE_SBT_LIBRARY
|
This procedure creates metadata describing an installed media management software library. The Recovery Appliance uses the specified library to copy backups from internal storage either to tape or to other tertiary storage supported by this media manager. |
DELETE_DB
|
This procedure removes the specified protected database from the Recovery Appliance. The Recovery Appliance deletes all metadata and backups associated with this database, both from disk and SBT. Backups on tape are not affected. Regarding replicated and cloud pieces: the meta data is deleted from the Recovery Appliance doing the delete, but the data is not deleted from the downstream or cloud storage. |
DELETE_POLLING_POLICY
|
This procedure deletes the specified backup polling policy. |
DELETE_PROTECTION_POLICY
|
This procedure deletes the specified protection policy. |
DELETE_REPLICATION_SERVER
|
This procedure deletes a replication server configuration. The Recovery Appliance removes all metadata relating to the downstream Recovery Appliance. |
DELETE_SBT_ATTRIBUTE_SET
|
This procedure deletes the specified SBT attribute set. |
DELETE_SBT_JOB_TEMPLATE
|
This procedure deletes the specified SBT job template. |
DELETE_SBT_LIBRARY
|
This procedure deletes the metadata describing the specified SBT library. |
ESTIMATE_SPACE
|
This procedure estimates the amount of storage in GB required for recovery of a given database and a desired recovery window. |
GET_REDO_TRANSPORT_LAG
|
Returns the current redo transport lag on the specified database. |
GRANT_DB_ACCESS
|
This procedure grants the necessary privileges to the specified recovery Appliance user account to enable this account to back up, restore, and access recovery catalog metadata for the specified protected database. |
KEY_REKEY
|
This procedure rekeys encryption keys for all databases with existing encryption keys. |
KEY_REKEY
|
This procedure rekeys encryption keys for the specified database with an existing encryption key. |
KEY_REKEY
|
This procedure rekeys encryption keys for all databases with existing encryption keys in the specified protection_policy |
MIGRATE_TAPE_BACKUP
|
This procedure makes pre-migration tape backups
accessible to the Recovery Appliance through the specified SBT
library. You must first import metadata about the tape backups
into the Recovery Appliance catalog using the RMAN
|
MOVE_BACKUP
|
This procedure moves one or more long-term archival backup pieces from the Recovery Appliance to a user-specified disk or SBT destination. |
MOVE_BACKUP_PIECE
|
This procedure moves a single long-term archival backup piece from the Recovery Appliance to a user-specified disk or SBT destination. |
PAUSE_REPLICATION_DATABASE
|
This procedure pauses replication for the specified database with all associated replication servers. If |
PAUSE_REPLICATION_SERVER
|
This procedure pauses replication to the specified downstream Recovery Appliance. |
PAUSE_SBT_LIBRARY
|
This procedure pauses the specified SBT library. The Recovery Appliance allows in-progress
copies of backup pieces to complete. However, if backup pieces were
queued for copy through this SBT library but not yet copied, then the Recovery Appliance
holds them until you resume the SBT library. No new SBT jobs that run
against this library can execute until you resume the library ( |
POPULATE_BACKUP_PIECE
|
This procedure pushes the specified backup piece into the delta store. |
QUEUE_SBT_BACKUP_TASK
|
This procedure queues the backup pieces selected by the specified SBT job template for copying to tape. Typically, a scheduling utility such as Oracle Scheduler calls this procedure. |
REMOVE_REPLICATION_SERVER
|
This procedure removes the specified replication server configuration from the specified protection policy. After the operation succeeds, the Recovery Appliance no longer replicates backups of databases protected by this policy to the downstream Recovery Appliance. |
RENAME_DB
|
This procedure changes the name of the specified protected database in the Recovery Appliance metadata. |
RESET_ERROR
|
This procedure modifies the specified set of incident log entries to have
the status |
RESUME_DB
|
This procedure restores a suspended database to normal operation. Only suspended databases may be resumed. |
RESUME_REPLICATION_DATABASE
|
This procedure resumes replication for the specified database after a previous call to |
RESUME_REPLICATION_SERVER
|
This procedure resumes replication to the specified downstream Recovery Appliance, after a
previous call to |
RESUME_SBT_LIBRARY
|
This procedure resumes a paused SBT library. |
REVOKE_DB_ACCESS
|
This procedure revokes privileges on one protected database from the specified Recovery Appliance user account. |
SET_SYSTEM_DESCRIPTION
|
This procedure sets a descriptive name for users to apply to their Recovery Appliance. The name provided here will be seen in the RA_SERVER view. |
SHUTDOWN
|
Synonymous with |
SHUTDOWN_RECOVERY_APPLIANCE
|
This procedure performs a clean shutdown of the Recovery Appliance. |
STARTUP
|
Synonymous with |
STARTUP_RECOVERY_APPLIANCE
|
This procedure starts the Recovery Appliance after it has been shut down or terminated. |
SUSPEND_DB
|
This procedure deletes all local disk backups associated with this database from the Recovery Appliance. Backups on tape, in the cloud, or replicated to other Recovery Appliances are not affected. |
UPDATE_ARCHIVAL_BACKUP_KEEP
|
This procedure makes updates the retention time of archival backup with the specified |
UPDATE_DB
|
This procedure changes the attributes that are assigned to the specified protected database. |
UPDATE_POLLING_POLICY
|
This procedure modifies the parameters for an existing backup polling policy. |
UPDATE_PROTECTION_POLICY
|
This procedure modifies the parameters for an existing protection policy. |
UPDATE_REPLICATION_SERVER
|
This procedure changes the settings for a replication server configuration. |
UPDATE_SBT_ATTRIBUTE_SET
|
This procedure updates the parameters for the specified SBT attribute set. |
UPDATE_SBT_JOB_TEMPLATE
|
This procedure updates the parameters for the specified SBT job. |
UPDATE_SBT_LIBRARY
|
This procedure modifies the parameters for the specified SBT library. |