Datafile copies with compression are
not supported. If the function dbms_backup_restore.backuppieceCreate is called outside RMAN, then the incompatible values are being passed for the parameters docompress and imagcp. If this message occurs during an RMAN job, then this is an internal error in RMAN, and you should contact Oracle support.

Applies an incremental backup from the backup set to an
existing copy of the datafile. The incremental backup and the datafile must have the same resetlogs
stamp but this can not be detected until the restore is begun.

dbms_backup_restore.applydatafileto(
dfNUMBER IN BINARY_INTEGER,
toname IN VARCHAR2 DEFAULT
NULL,
fuzziness_hint IN NUMBER DEFAULT 0,
max_corrupt IN BINARY_INTEGER,
islevel0 IN BINARY_INTEGER,recid
IN NUMBER,stamp
IN NUMBER);

TBD

APPLYOFFLINERANGE

This applies an offline range record from the named controlfile to the named
datafile.

Overload 1

dbms_backup_restore.applyofflinerange(
cfname IN VARCHAR2 DEFAULT NULL,
dfname IN VARCHAR2 DEFAULT NULL,
blksize IN NUMBER DEFAULT NULL,
recid IN NUMBER DEFAULT NULL,
stamp IN NUMBER DEFAULT NULL,
fno IN BINARY_INTEGER);

TBD

Overload 2

dbms_backup_restore.applyofflinerange(
cfname IN VARCHAR2 DEFAULT NULL,
dfname IN VARCHAR2 DEFAULT NULL,
blksize IN NUMBER DEFAULT NULL,
recid IN NUMBER DEFAULT
NULL,
stamp IN NUMBER DEFAULT
NULL,
fno IN BINARY_INTEGER, dfrecid IN NUMBER, dfstamp IN NUMBER);

TBD

APPLYSETDATAFILE

Begins a conversation that will apply incremental
backups to existing datafiles

Overload 1

dbms_backup_restore.applysetdatafile;

exec dbms_backup_restore.applysetdatafile;

Overload 2

dbms_backup_restore.applysetdatafile(check_logical IN
BOOLEAN);

exec dbms_backup_restore.applysetdatafile(FALSE);

Overload 3

dbms_backup_restore.applysetdatafile(
check_logical IN BOOLEAN,cleanup IN BOOLEAN);

dbms_backup_restore.backuparchivedlog(
arch_recid IN NUMBER,
arch_stamp IN NUMBER,duplicate OUT BOOLEAN);

TBD

BACKUPBACKUPPIECE

Copies a backup piece that was originally written to an operating system file, onto sequential media. This requires allocating
a sequential device first. This could copy to another operating system file if the NULL device is allocated.

dbms_backup_restore.backuppiececreate(
fname IN VARCHAR2,
pieceno OUT BINARY_INTEGER,
done OUT BOOLEAN,
handle OUT VARCHAR2,
comment OUT VARCHAR2,
media OUT VARCHAR2,
concur OUT BOOLEAN,
params IN VARCHAR2 DEFAULT NULL,
sequence IN BINARY_INTEGER,
year IN BINARY_INTEGER,
month_day IN BINARY_INTEGER);

TBD

Overload 5

dbms_backup_restore.backuppiececreate(
fname IN VARCHAR2,
pieceno OUT BINARY_INTEGER,
done OUT BOOLEAN,
handle OUT VARCHAR2,
comment OUT VARCHAR2,
media OUT VARCHAR2,
concur OUT BOOLEAN,
params IN VARCHAR2 DEFAULT NULL,media_pool IN BINARY_INTEGER,sequence IN BINARY_INTEGER,year IN BINARY_INTEGER,month_day IN BINARY_INTEGER);

TBD

Overload 6

dbms_backup_restore.backuppiececreate(
fname IN VARCHAR2,
pieceno OUT BINARY_INTEGER,
done OUT BOOLEAN,
handle OUT VARCHAR2,
comment OUT VARCHAR2,
media OUT VARCHAR2,
concur OUT BOOLEAN,
params IN VARCHAR2
DEFAULT NULL,media_pool IN BINARY_INTEGER DEFAULT 0,reuse IN BOOLEAN,sequence IN BINARY_INTEGER,year IN BINARY_INTEGER,month_day IN BINARY_INTEGER);

TBD

Overload 7

dbms_backup_restore.backuppiececreate(
fname IN
VARCHAR2,
pieceno OUT BINARY_INTEGER,
done
OUT BOOLEAN,
handle OUT VARCHAR2,
comment OUT VARCHAR2,
media OUT
VARCHAR2,
concur OUT BOOLEAN,
params IN
VARCHAR2 DEFAULT NULL,
media_pool IN BINARY_INTEGER DEFAULT 0,
reuse IN
BOOLEAN DEFAULT FALSE,
sequence IN BINARY_INTEGER,
year
IN BINARY_INTEGER,
month_day IN BINARY_INTEGER,
archlog_failover OUT BOOLEAN);

TBD

Overload 8

dbms_backup_restore.backuppiececreate(
fname IN
VARCHAR2,
pieceno OUT BINARY_INTEGER,
done
OUT BOOLEAN,
handle OUT VARCHAR2,
comment OUT VARCHAR2,
media OUT
VARCHAR2,
concur OUT BOOLEAN,
params IN
VARCHAR2 DEFAULT NULL,
media_pool IN BINARY_INTEGER DEFAULT 0,
reuse IN
BOOLEAN DEFAULT FALSE,
sequence IN BINARY_INTEGER,
year
IN BINARY_INTEGER,
month IN
BINARY_INTEGER,
day
IN BINARY_INTEGER,
archlog_failover OUT BOOLEAN,
deffmt IN
BINARY_INTEGER,
recid OUT
NUMBER,
stamp OUT
NUMBER,
tag
OUT VARCHAR2);

backupStatus returns information about the current backup conversation. It is useful for resyncing with a conversation after some error has interrupted normal execution, and it is now time to resume the conversation. It can also be called if there is no conversation.

dbms_backup_restore.backupstatus(
state OUT BINARY_INTEGER,
setid OUT NUMBER,
stamp OUT NUMBER,
pieceno OUT BINARY_INTEGER,
files OUT BINARY_INTEGER,
datafiles OUT BOOLEAN,
incremental OUT BOOLEAN,
nochecksum OUT BOOLEAN,
device OUT BOOLEAN);

dbms_backup_restore.bmrstart(
save_all_blocks IN BOOLEAN,
save_final_blocks IN BOOLEAN,
nofileupdate IN BOOLEAN);

TBD

Overload 2

dbms_backup_restore.bmrstart(
save_all_blocks IN BOOLEAN,
save_final_blocks IN BOOLEAN,
nofileupdate IN BOOLEAN,
doclear
IN BOOLEAN);

TBD

CFILECALCSIZEARRAY

Takes an array of parameters, at indices corresponding to each of the record types RTYP_DB_INFO through RTYP_<KCCDIMAX>, the
NUMBER of record slots postulated for the section containing records of that type.

If TRUE, indicates that the controlfile to make is a
standby controlfile, normal backup otherwise.

Overload 2

dbms_backup_restore.cfilemakeandusesnapshot(isstby IN
BOOLEAN);

exec dbms_backup_restore.cfilemakeandusesnapshot(FALSE);

Overload 3

dbms_backup_restore.cfilemakeandusesnapshot(
isstby IN BOOLEAN,
source_dbuname IN VARCHAR2,
dest_cs IN VARCHAR2,
source_cs IN VARCHAR2,
for_resync IN BOOLEAN);

TBD

CFILERESIZESECTION

Attempts to resize the
controlfile, expanding or shrinking
the section holding records of the specified "record_type" such that it will hold
"desired_numrecs" (rounded up to the nearest block boundary).

Sets the filename to be used for the snapshot controlfile during subsequent invocations of
cfileMakeAndUseSnapshot and cfileUseSnapshot.

dbms_backup_restore.cfilesetsnapshotname(fname IN
VARCHAR2);

See
CFILEMAKEANDUSESNAPSHOT Demo

CFILEUSECOPY

sets up this process' PGA such that the X$KCC fixed tables will be redirected to read
the named backup or standby controlfile.

dbms_backup_restore.cfileusecopy(fname IN
VARCHAR2);

TBD

CFILEUSECURRENT

Sets up this process' PGA such that the X$KCC fixed tables will revert to reading the current
controlfile.

dbms_backup_restore.cfileusecurrent

exec dbms_backup_restore.cfileusecurrent;

CFILEUSESNAPSHOT

Sets up this process' PGA such that the X$KCC fixed tables
will be redirected to read the snapshot controlfile previously created via
cfileMakeAndUseSnapshot.

dbms_backup_restore.cfileusesnapshot;

exec dbms_backup_restore.cfileusesnapshot;

CHANGEARCHIVEDLOG

Undocumented

Overload 1

dbms_backup_restore.changearchivedlog(
recid IN
NUMBER,
stamp IN
NUMBER,
fname IN
VARCHAR2,
thread IN NUMBER,
sequence IN NUMBER,
resetlogs_change IN NUMBER,
first_change IN NUMBER,
blksize IN NUMBER,
new_status IN VARCHAR2);

TBD

Overload 2

dbms_backup_restore.changearchivedlog(
recid IN
NUMBER,
stamp IN
NUMBER,
fname IN
VARCHAR2,
thread IN NUMBER,
sequence IN NUMBER,
resetlogs_change IN NUMBER,
first_change IN NUMBER,
blksize IN NUMBER,
new_status IN VARCHAR2,force
IN BINARY_INTEGER);

dbms_backup_restore.changebackupset(
recid IN NUMBER,
stamp IN NUMBER,
set_count IN NUMBER,
keep_options IN BINARY_INTEGER,
keep_until IN NUMBER);

TBD

CHANGEDATAFILECOPY

Undocumented

Overload 1

dbms_backup_restore.changedatafilecopy(
recid
IN NUMBER,
stamp
IN NUMBER,
fname
IN VARCHAR2,
dfNUMBER IN BINARY_INTEGER,
resetlogs_change IN NUMBER,
creation_change IN NUMBER,
checkpoint_change IN NUMBER,
blksize IN NUMBER,
new_status IN VARCHAR2);

TBD

Overload 2

dbms_backup_restore.changedatafilecopy(
recid
IN NUMBER,
stamp
IN NUMBER,
fname
IN VARCHAR2,
dfNUMBER IN BINARY_INTEGER,
resetlogs_change IN NUMBER,
creation_change IN NUMBER,
checkpoint_change IN NUMBER,
blksize IN NUMBER,
new_status IN VARCHAR2,
keep_options IN BINARY_INTEGER,
keep_until IN NUMBER);

TBD

Overload 3

dbms_backup_restore.changedatafilecopy(
recid
IN NUMBER,
stamp
IN NUMBER,
fname
IN VARCHAR2,
dfNUMBER IN BINARY_INTEGER,
resetlogs_change IN NUMBER,
creation_change IN NUMBER,
checkpoint_change IN NUMBER,
blksize IN NUMBER,
new_status IN VARCHAR2,
keep_options IN BINARY_INTEGER,
keep_until IN NUMBER,
force
IN BINARY_INTEGER);

TBD

CHECKFILENAME

Returns 0 if the filename is not in use by the database as a
controlfile, datafile, or online logfile. Returns 1 if the filename is in use. The filename must be normalized by the caller.

Makes a copy of a log that was already archived. This may be useful for moving redo to a different location, or for extra
redundancy. A record is created in the controlfile as if this log was just archived.

Makes copies of a controlfile that is already on disk in an
operating system file. It is intended to be used to make copies of controlfiles for specifying multiple controlfiles in the initialization
parameter.

Overload 1

dbms_backup_restore.copycontrolfile(
src_name IN VARCHAR2,
dest_name IN VARCHAR2,
recid OUT NUMBER,
stamp OUT NUMBER,
full_name OUT VARCHAR2);

TBD

Overload 2

dbms_backup_restore.copycontrolfile(
src_name IN VARCHAR2,
dest_name IN VARCHAR2,
recid OUT NUMBER,
stamp OUT NUMBER,
full_name OUT VARCHAR2,keep_options IN BINARY_INTEGER,keep_until IN NUMBER);

Creates an row in a V$RMAN_OUTPUT view.
The function will create one row in SGA (krbmrort [Rman Output Row
Table]).
Overload 1

dbms_backup_restore.creatermanoutputrow(l0row_id IN NUMBER,l0row_stamp IN NUMBER,
row_id IN NUMBER,
row_stamp IN NUMBER,txt IN
VARCHAR2);

TBD

Overload 2

dbms_backup_restore.creatermanoutputrow(
l0row_id IN NUMBER,
l0row_stamp IN NUMBER,
row_id IN NUMBER,
row_stamp IN NUMBER,
txt IN VARCHAR2,
sameline IN BINARY_INTEGER);

TBD

CREATERMANSTATUSROW

Creates an row for V$RMAN_STATUS view. The function will create one row in SGA (krbmrsrt [Rman Status Row Table] and create one controlfile record (kccrsr).

Overload 1

dbms_backup_restore.creatermanstatusrow(
level IN BINARY_INTEGER,
parent_id IN NUMBER,
parent_stamp IN NUMBER,
status IN BINARY_INTEGER,
command_id IN VARCHAR2,
operation IN VARCHAR2,
row_id OUT NUMBER,
row_stamp OUT NUMBER);

TBD

Overload 2

dbms_backup_restore.creatermanstatusrow(
level IN BINARY_INTEGER,
parent_id IN NUMBER,
parent_stamp IN NUMBER,
status IN BINARY_INTEGER,
command_id IN VARCHAR2,
operation IN VARCHAR2,
row_id OUT NUMBER,
row_stamp OUT NUMBER,flags IN
BINARY_INTEGER);

Deletes an operating system file and mark its record in the controlfile as obsolete so that its row will not appear in the fixed view. If the stamp in the record does not match the stamp argument, the controlfile record will not be marked as obsolete.

Overload 1

dbms_backup_restore.deletearchivedlog(
recid IN
NUMBER,
stamp IN
NUMBER,
fname IN
VARCHAR2,
thread IN NUMBER,
sequence IN NUMBER,
resetlogs_change IN NUMBER,
first_change IN NUMBER,
blksize IN NUMBER);

TBD

Overload 2

dbms_backup_restore.deletearchivedlog(
recid IN
NUMBER,
stamp IN
NUMBER,
fname IN
VARCHAR2,
thread IN NUMBER,
sequence IN NUMBER,
resetlogs_change IN NUMBER,
first_change IN NUMBER,
blksize IN NUMBER,
force IN
BINARY_INTEGER);

TBD

DELETEBACKUPPIECE

Delete a backup piece from the storage subsystem. If a controlfile record
ID is given, it is marked as obsolete so that it will no longer appear in
V$BACKUP_PIECE. If the stamp in the record does not match the stamp argument, the controlfile record will not be marked as obsolete.

dbms_backup_restore.deletebackuppiece(
recid IN NUMBER,
stamp IN NUMBER,
handle IN VARCHAR2,
set_stamp IN NUMBER,
set_count IN NUMBER,
pieceno IN BINARY_INTEGER,
params IN VARCHAR2 DEFAULT NULL,force IN BINARY_INTEGER);

TBD

DELETECONFIG

Called to perform a
delete of RMAN Configuration. This procedure deletes the RMAN
configuration.

dbms_backup_restore.deleteconfig(conf# IN
BINARY_INTEGER);

TBD

DELETEDATAFILECOPY

Deletes an operating system file and mark its record in
the controlfile as obsolete so that its row will not appear in the fixed view. If the stamp in the record does not match the stamp argument, the
controlfile record will not be marked as obsolete.

Overload 1

dbms_backup_restore.deletedatafilecopy(
recid
IN NUMBER,
stamp
IN NUMBER,
fname
IN VARCHAR2,
dfNUMBER IN BINARY_INTEGER,
resetlogs_change IN NUMBER,
creation_change IN NUMBER,
checkpoint_change IN NUMBER,
blksize IN NUMBER,
no_delete IN BINARY_INTEGER);

TBD

Overload 2

dbms_backup_restore.deletedatafilecopy(
recid
IN NUMBER,
stamp
IN NUMBER,
fname
IN VARCHAR2,
dfNUMBER IN BINARY_INTEGER,
resetlogs_change IN NUMBER,
creation_change IN NUMBER,
checkpoint_change IN NUMBER,
blksize IN NUMBER,
no_delete IN BINARY_INTEGER,
force
IN BINARY_INTEGER);

TBD

DELETED_GETDBINFO

Placeholderfor the deleted function, getDbInfo, in order to maintain pl/sql
compatibility

dbms_backup_restore.devicestatus(
state OUT BINARY_INTEGER,
type OUT VARCHAR2,
name OUT VARCHAR2,
bufsz OUT BINARY_INTEGER,
bufcnt OUT BINARY_INTEGER,
kbytes OUT NUMBER,
readrate OUT BINARY_INTEGER,
parallel OUT BINARY_INTEGER);

Generates an Auto backup if autobackup is enabled. If no channel is
allocated, a copy of autobackup will be written in controlfile autoformat to disk.
Autobackup will contain spfile if instance is started using an server parameter file.

dbms_backup_restore.findautsearchfiletable(
mustspfile IN BOOLEAN,
until IN NUMBER,
fname OUT VARCHAR2,
year OUT BINARY_INTEGER,
month OUT BINARY_INTEGER,
day OUT BINARY_INTEGER,
sequence OUT BINARY_INTEGER,
ats OUT NUMBER)
RETURN BOOLEAN;

TBD

FLASHBACKADDFILE

Adds the given file to the list that needs a flashback.

dbms_backup_restore.flashbackaddfile(fileno IN
BINARY_INTEGER);

TBD

FLASHBACKCANCEL

Ends the flashback conversation

dbms_backup_restore.flashbackcancel;

exec dbms_backup_restore.flashbackcancel;

FLASHBACKFILES

Does the real work of flashbacking the list
added using flashbackAddFile to the SCN specified by flashbackStart.

dbms_backup_restore.flashbackfiles(alname IN
VARCHAR2);

TBD

FLASHBACKSTART

Starts a flashback conversation to flashback the database to given flashbackSCN/flashbackTime.
Overload 1

dbms_backup_restore.flashbackstart(
flashbackSCN IN NUMBER,
flashbackTime IN DATE,
scnBased IN BINARY_INTEGER,
toBefore IN BINARY_INTEGER);

TBD

Overload 2

dbms_backup_restore.flashbackstart(
flashbackSCN IN NUMBER,
flashbackTime IN DATE,
scnBased IN BINARY_INTEGER,
toBefore IN BINARY_INTEGER,
resetSCN IN NUMBER,
resetTime IN DATE);

TBD

GENPIECENAME

Called to produce the name of the piece.

Overload 1

dbms_backup_restore.genpiecename(
pno IN NUMBER,
set_count IN NUMBER,
set_stamp IN NUMBER,
format IN VARCHAR2,
copyno IN NUMBER,
devtype IN VARCHAR2,
year IN VARCHAR2,
month IN VARCHAR2,
day IN VARCHAR2,
dbid IN VARCHAR2,
ndbname IN VARCHAR2,pdbname IN VARCHAR2,
cfseq IN NUMBER)
RETURN VARCHAR2;

TBD

Overload 2

dbms_backup_restore.genpiecename(
pno IN NUMBER,
set_count IN NUMBER,
set_stamp IN NUMBER,
format IN VARCHAR2,
copyno IN NUMBER,
devtype IN VARCHAR2,
year IN BINARY_INTEGER,
month IN BINARY_INTEGER,
day IN BINARY_INTEGER,
dbid IN NUMBER,
ndbname IN VARCHAR2,
cfseq IN NUMBER,
fileno IN NUMBER,tsname IN VARCHAR2,logseq IN VARCHAR2,logthr IN NUMBER,
imagcp IN BOOLEAN)
RETURN VARCHAR2;

TBD

Overload 3

dbms_backup_restore.genpiecename(
pno IN NUMBER,
set_count IN NUMBER,
set_stamp IN NUMBER,
format IN VARCHAR2,
copyno IN NUMBER,
devtype IN VARCHAR2,
year IN BINARY_INTEGER,
month IN BINARY_INTEGER,
day IN BINARY_INTEGER,
dbid IN NUMBER,
ndbname IN VARCHAR2,
cfseq IN NUMBER,
fileno IN NUMBER,
tsname IN VARCHAR2,
logseq IN VARCHAR2,
logthr IN NUMBER,
imagcp IN BOOLEAN,
savepname IN BOOLEAN)
RETURN VARCHAR2;

Obtains an SCN and returns the high-recids from the controfile record
section for each type of controlfile record. The recids and the SCN are allocated from inside a controlfile
transaction. If the database is not open, then the SCN is calculated in the same way as for
a backup controlfile.

Reads the header from a backuppiece and creates the corresponding backupset, backuppiece, backup datafile or backup redo log records as if the file had just been created with RMAN backup command.

dbms_backup_restore.inspectbackuppiece(
handle IN VARCHAR2,
full_handle OUT VARCHAR2,
recid OUT NUMBER,
stamp OUT NUMBER);

TBD

INSPECTCONTROLFILE

Reads the header from a backup controlfile and creates
a record in the current controlfile as if the file had just been created with 'alter database backup controlfile' or copyControlFile or
restoreControlFileTo.

dbms_backup_restore.inspectcontrolfile(
fname IN VARCHAR2,
full_name OUT VARCHAR2,
recid OUT NUMBER,
stamp OUT NUMBER);

TBD

INSPECTDATAFILECOPY

Reads the header from an operating system datafile copy, and makes a record in the controlfile as if the copy had just been made
via copyDataFile.

reads the header of a archived redo log and returns thread, sequence, first_change# and next_change#. No controlfile record is added.

dbms_backup_restore.readarchivedlogheader(
fname IN
VARCHAR2,
full_name OUT VARCHAR2,
thread OUT NUMBER,
sequence OUT NUMBER,
first_change OUT NUMBER,
next_change OUT NUMBER,
resetlogs_change OUT NUMBER,
resetlogs_time OUT DATE);

TBD

READFILEHEADER

Used to obtain information from the file header of a datafile that is being cross-platform converted at the target.
In this case the file does not belong to the database (yet) and its block format is not the same of the database that is doing the conversion.

dbms_backup_restore.readfileheader(
fname IN VARCHAR2,
dbname OUT VARCHAR2,
dbid OUT NUMBER,
tsname OUT VARCHAR2,
fno OUT BINARY_INTEGER,
nblocks OUT NUMBER,
blksize OUT BINARY_INTEGER,
plid OUT BINARY_INTEGER,
sameen IN BINARY_INTEGER);

TBD

REFRESHAGEDFILES

Undocumented

dbms_backup_restore.refreshagedfiles;

exec dbms_backup_restore.refreshagedfiles;

REINIT

Reset all limits to infinity

dbms_backup_restore.reinit;

exec
dbms_backup_restore.reinit;

REMOTESQLEXECUTE

Allows executing a generic SQL statement at the remote database identified by source_cs connect string and source_dbuname
db_unique_name parameter. It can be used to execute a simple SQL stmt
or a SELECT statement that returns only one row, the value is returned
by the function.

Restore
logs from a redo log backup set, and where to restore them. The logs are
specified by giving a thread and sequence NUMBER(restoreArchivedLog). Multiple calls can be made to
specify thread and sequence NUMBERs. Only one SCN range and destination can be given per restore.

Restore
logs from a redo log backup set, and where to restore them. The logs are specified
by giving an SCN range(restoreArchivedLogRange). Multiple calls can be made to specify thread and sequence
NUMBERs. Only one SCN range and destination can be given per restore.

dbms_backup_restore.restorearchivedlogrange(
low_change IN NUMBER DEFAULT 0,
high_change IN NUMBER DEFAULT 281474976710655);

TBD

RESTOREBACKUPPIECE

Reads one backup piece and writes its contents to the files in the restore list.
Creates files from complete backups.

Begins a conversation that will completely recreate
datafiles and possibly a controlfile from the backup.

Overload 1

dbms_backup_restore.restoresetdatafile;

exec dbms_backup_restore.restoresetdatafile;

Overload 2

dbms_backup_restore.restoresetdatafile(check_logical IN
BOOLEAN);

TBD

Overload 3

dbms_backup_restore.restoresetdatafile(
check_logical IN BOOLEAN,cleanup IN BOOLEAN);

TBD

RESTORESETPIECE

Sets up the handle for
restoreBackupPiece to use. When multiple copies of piece exists, call restoreSetPiece to
for each copy before calling restoreBackupPiece. This will enable RESTORE FAILOVER feature inside kernel.

dbms_backup_restore.restoresetpiece(
handle IN VARCHAR2,
tag IN VARCHAR2,
fromdisk IN BOOLEAN,
recid IN NUMBER,
stamp IN NUMBER);

Returns information about the current restore conversation. It is useful for
resyncing with a conversation after some error has interrupted normal execution, and it is now time to resume the conversation. It can also be called when there is no
conversation.

dbms_backup_restore.restorestatus(
state OUT BINARY_INTEGER,
pieceno OUT BINARY_INTEGER,
files OUT BINARY_INTEGER,
datafiles OUT BOOLEAN,
incremental OUT BOOLEAN,
device OUT BOOLEAN);

Forces the reading of the entire backup set as if all files in the backup were being
restored but no data is written to any files. Incremental backup application does not require a
valid file to applying the changes.

Set a limit to a particular value. The limit keeps this value until the current device is deallocated, or a call is made to change the limit.

dbms_backup_restore.setlimit(name IN BINARY_INTEGER,
value IN NUMBER);

TBD

SETMSB

Set section size for multi-section backup

dbms_backup_restore.setmsb(
dfnumber IN NUMBER,
section_size IN NUMBER,
first_section IN NUMBER,
section_count IN NUMBER,
set_stamp IN NUMBER,
set_count IN NUMBER,
pieceno IN NUMBER,
piececnt IN NUMBER);

If the database is closed, then make the specified charset be the charset for this session.

dbms_backup_restore.set_charset(charset_name IN
VARCHAR2);

TBD

SET_CLIENT_INFO

Equivalent to dbms_application_info.set_client_info, and was
added so RMAN could call it from recover.bsq without needing to make the x$kqp326 package spec public.

dbms_backup_restore.set_client_info(client_info IN
VARCHAR2);

See the
DBMS_APPLICATION_INFO Demos

SLEEP

Sleep for the specified
NUMBER of seconds

dbms_backup_restore.sleep(secs IN BINARY_INTEGER);

exec dbms_backup_restore.sleep(3);

SWITCHTEMPFILE

Renames a tempfile record in controlfile section. If tempfile record doesn't exist, then it will add it to. If corresponding
tablespace record doesn't exists, then it will also add it to fix controlfile.

dbms_backup_restore.switchtempfile(
tsnum IN NUMBER,
tsname IN VARCHAR2,
tfnum IN NUMBER,
tfname IN VARCHAR2,
create_time IN DATE,
create_scn IN NUMBER,
blocks IN NUMBER,
blocksize IN BINARY_INTEGER,
rfnum IN NUMBER,
exton IN BOOLEAN,
isSFT IN BOOLEAN,
maxsize IN NUMBER,
nextsize IN NUMBER);

HERE

SWITCHTOCOPY

Causes the filename in the indicated datafile copy record to become
the current named datafile.

dbms_backup_restore.validatedatafilecopy(
recid
IN NUMBER,
stamp
IN NUMBER,
fname
IN VARCHAR2,
dfNUMBER IN
BINARY_INTEGER,
resetlogs_change IN NUMBER,
creation_change IN NUMBER,
checkpoint_change IN OUT NUMBER,
checkpoint_time IN OUT BINARY_INTEGER,
blksize IN
NUMBER,signal
IN BINARY_INTEGER)
RETURN BINARY_INTEGER;

TBD

Overload 3

dbms_backup_restore.validatedatafilecopy(
recid
IN NUMBER,
stamp
IN NUMBER,
fname
IN VARCHAR2,
dfNUMBER IN BINARY_INTEGER,
resetlogs_change IN NUMBER,
creation_change IN NUMBER,
checkpoint_change IN NUMBER,
blksize IN NUMBER,
signal IN
BINARY_INTEGER)
RETURN BINARY_INTEGER;

TBD

VALIDATETABLESPACE

Validate that the tablespace has not been recreated when performing TSPITR.

Gets the next result.- If no more results are found, then HANDLE is null.

Overload 1

dbms_backup_restore.validationnextresult(
handle OUT VARCHAR2,
recid OUT NUMBER,
set_stamp OUT NUMBER,
set_count OUT NUMBER,
pieceno OUT NUMBER,
msca OUT BINARY_INTEGER,
m1 OUT VARCHAR2,
m2 OUT VARCHAR2,
m3 OUT VARCHAR2,
m4 OUT VARCHAR2,
m5 OUT VARCHAR2,
m6 OUT VARCHAR2,
m7 OUT VARCHAR2,
m8 OUT VARCHAR2,
m9 OUT VARCHAR2,
m10 OUT VARCHAR2,
m11 OUT VARCHAR2,
m12 OUT VARCHAR2,
m13 OUT VARCHAR2,
m14 OUT VARCHAR2,
m15 OUT VARCHAR2,
m16 OUT VARCHAR2,
m17 OUT VARCHAR2,
m18 OUT VARCHAR2,
m19 OUT VARCHAR2,
m20 OUT VARCHAR2);

TBD

Overload 2

dbms_backup_restore.validationnextresult(
handle OUT VARCHAR2,
recid OUT NUMBER,
set_stamp OUT NUMBER,
set_count OUT NUMBER,
pieceno OUT NUMBER,
msca OUT BINARY_INTEGER,
m1 OUT VARCHAR2,
m2 OUT VARCHAR2,
m3 OUT VARCHAR2,
m4 OUT VARCHAR2,
m5 OUT VARCHAR2,
m6 OUT VARCHAR2,
m7 OUT VARCHAR2,
m8 OUT VARCHAR2,
m9 OUT VARCHAR2,
m10 OUT VARCHAR2,
m11 OUT VARCHAR2,
m12 OUT VARCHAR2,
m13 OUT VARCHAR2,
m14 OUT VARCHAR2,
m15 OUT VARCHAR2,
m16 OUT VARCHAR2,
m17 OUT VARCHAR2,
m18 OUT VARCHAR2,
m19 OUT VARCHAR2,
m20 OUT VARCHAR2,
attributes OUT BINARY_INTEGER);

TBD

VALIDATIONSTART

Initializes restore conversation and the list of backup pieces to validate.

dbms_backup_restore.validationstart;

exec dbms_backup_restore.validationstart;

VALIDATIONVALIDATE

Performs the validation.

Overload 1

dbms_backup_restore.validationvalidate;

exec dbms_backup_restore.validationvalidate;

Overload 2

dbms_backup_restore.validationvalidate(flags IN
BINARY_INTEGER);

TBD

VSSBACKEDRECORD

All the record with stamp less than input stamp value are backed up by VSS infrastructure.

dbms_backup_restore.bssbackedrecord(
rectype IN BINARY_INTEGER,
recid IN NUMBER,
stamp IN NUMBER);

TBD

ZERODBID

Used to update the header of a datafile so that the a new dbid
will be calculated later on by a create controlfile statement.

dbms_backup_restore.zerodbid(fno IN
BINARY_INTEGER);

exec dbms_backup_restore.zerodbid(0);

Restore Demo

The following is from $ORACLE_HOME/ cfgtoollogs/dbca/orabase/ rmanRestoreDatafiles.sql