Oracle DBMS_BACKUP_RESTORE
Version 11.1
 
General Information
Source {ORACLE_HOME}/rdbms/admin/dbmsbkrs.sql

Constants
Name Data Type Value
ATTRIBUTE_NOTFOUND BINARY_INTEGER 2
ATTRIBUTE_REMOTE BINARY_INTEGER 1
MAXSCNVAL NUMBER 281474976710655
protocol_version_NUMBER_min(major release NUMBER) NUMBER 8
protocol_release_NUMBER_min(maintenance release NUMBER) NUMBER 0
protocol_update_NUMBER_min(application release NUMBER) NUMBER 4
protocol_component_NUMBER_min(component release NUMBER) NUMBER 0
protocol_version_NUMBER_max(major release NUMBER) NUMBER 1
protocol_release_NUMBER_max(maintenance release NUMBER) NUMBER 1
protocol_update_NUMBER_max(application release NUMBER) NUMBER 0
protocol_component_NUMBER_max(component release NUMBER) NUMBER 6
RETRYABLE_ERROR BINARY_INTEGER 19624
SIGNAL_CHANGE_TRACKING_ERROR BINARY_INTEGER 0
TBS_ATTR_ENCRYPT BINARY_INTEGER 1
TBS_ATTR_EXCLUDE BINARY_INTEGER 0
Proxy
CAN_PROXY BINARY_INTEGER 0
CANNOT_PROXY BINARY_INTEGER 1
Valid record types
RTYP_DB_INFO BINARY_INTEGER 0
RTYP_CKPTPROG BINARY_INTEGER 1
RTYP_THREAD BINARY_INTEGER 2
RTYP_LOGFILE BINARY_INTEGER 3
RTYP_DATAFILE BINARY_INTEGER 4
RTYP_FILENAME BINARY_INTEGER 5
RTYP_TABLESPACE BINARY_INTEGER 6
RTYP_RESERVED1 BINARY_INTEGER 7
RTYP_TEMPFILE BINARY_INTEGER 7
RTYP_RMAN_CONFIGURATION BINARY_INTEGER 8
RTYP_LOG_HISTORY BINARY_INTEGER 9
RTYP_OFFLINE_RANGE BINARY_INTEGER 10
RTYP_ARCHIVED_LOG BINARY_INTEGER 11
RTYP_BACKUP_SET BINARY_INTEGER 12
RTYP_BACKUP_PIECE BINARY_INTEGER 13
RTYP_BACKUP_DFILE BINARY_INTEGER 14
RTYP_BACKUP_LOG BINARY_INTEGER 15
RTYP_DFILE_COPY BINARY_INTEGER 16
RTYP_BACKUP_DFILE_CORR BINARY_INTEGER 17
RTYP_DFILE_COPY_CORR BINARY_INTEGER 18
RTYP_DELETED_OBJECT BINARY_INTEGER 19
RTYP_RESERVED3 BINARY_INTEGER 20
RTYP_PROXY BINARY_INTEGER 20
RTYP_RESERVED4 BINARY_INTEGER 21
RTYP_BACKUP_SPFILE BINARY_INTEGER 21
RTYP_DB2 BINARY_INTEGER 22
RTYP_INCARNATION BINARY_INTEGER 23
RTYP_FLASHBACK BINARY_INTEGER 24
RTYP_RA_INFO BINARY_INTEGER 25
RTYP_INST_RSVT BINARY_INTEGER 26
RTYP_AGED_FILES BINARY_INTEGER 27
RTYP_RMAN_STATUS BINARY_INTEGER 28
RTYP_THREAD_INST BINARY_INTEGER 29
RTYP_MTR BINARY_INTEGER 30
RTYP_DFH BINARY_INTEGER 31
RTYP_SDM BINARY_INTEGER 32
RTYP_RSP BINARY_INTEGER 33
RTYP_NRR BINARY_INTEGER 34
RTYP_BLOCK_CORRUPTION BINARY_INTEGER 35
RTYP_ACM_OPERATION BINARY_INTEGER 36
RTYP_FOREIGN_ARCHIVED_LOG BINARY_INTEGER 37
Validate Constants
VALIDATE_OK BINARY_INTEGER 0
VALIDATE_RECORD_NOTFOUND BINARY_INTEGER 1
VALIDATE_RECORD_DIFFERENT BINARY_INTEGER 2
VALIDATE_FILE_DIFFERENT BINARY_INTEGER 4
VALIDATE_IN_USE BINARY_INTEGER 8
VALIDATE_DEL_FOR_SPACE BINARY_INTEGER 16

Dependencies
DBMS_APPLICATION_INFO PLITBLM
DBMS_BACKUP_RESTORE V$ARCHIVED_LOG
DBMS_IR V$COPY_CORRUPTION
DBMS_SERVER_ALERT V$DATABASE_INCARNATION
DBMS_STREAMS_TBS_INT V$DATAFILE_COPY
DBMS_SYS_ERROR V$INSTANCE
DUAL X$KCCFN
Defined Data Types -- This record captures block statistics for a file validation.
--
TYPE blockStat_t IS RECORD (
filetype   BINARY_INTEGER, -- KSFD file type
dfNUMBER   NUMBER,         -- datafile NUMBER
thread     BINARY_INTEGER, -- archived log thread
sequence   NUMBER,         -- archived log sequence
highscn    NUMBER,         -- highest scn found in the datafile
examined   NUMBER,         -- total blocks examined
corrupt    NUMBER,         -- total blocks that are marked corrupt
empty      NUMBER,         -- total empty blocks
data_proc  NUMBER,         -- total data blocks that are processed
data_fail  NUMBER,         -- total data blocks that failed
index_proc NUMBER,         -- total index blocks that are processed
index_fail NUMBER,         -- total index blocks that failed
other_proc NUMBER,         -- total other blocks that are processed
other_fail NUMBER,         -- total other blocks that failed
-- Spare fields for future
spare1     NUMBER,
spare2     NUMBER,
spare3     NUMBER,
spare4     NUMBER,
spare5     NUMBER,
spare6     NUMBER,
spare7     DATE,
spare8     DATE);

-- Table of block statistics
TYPE blockStatTable_t IS TABLE OF blockStat_t
INDEX BY BINARY_INTEGER;

-- Record to describe a block range
TYPE blockRange_t IS RECORD (
blkNUMBER NUMBER,
dfNUMBER  NUMBER,
range     NUMBER,
spare1    NUMBER,
spare2    NUMBER,
spare3    NUMBER);

-- Table of block ranges
TYPE blockRangeTable_t IS TABLE OF blockRange_t
INDEX BY BINARY_INTEGER;

TYPE nrecs_array IS TABLE OF BINARY_INTEGER
INDEX BY BINARY_INTEGER;

Error Messages Raised by ORA-2000 Exception
Error Code Reason
230 snapshot_enqueue_busy
231 snapshot_name_not_set
232 snapshot_not_made
233 inconsistant_read
ORA-19563 file_validation_failure
ORA-19571 record_not_found
ORA-19579 archivelog_not_found
ORA-19582 archivelog_validate_error
ORA-19625 file_not_found
ORA-19648 inc_scn_matches_df_scn
ORA-19658 different_resetlogs
ORA-19695 This is an internal error. The fixed table x$krbmaft was not populated using the function dbms_backup_restore.searchFiles
ORA-19699 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.
ORA-19717 The procedure dbms_backup_restore.searchFiles was called with an empty pattern while the parameter omf was set to FALSE
ORA-19831 This version of database was incompatible with the the indicated dbms_backup_restore package installed in the database
backuppiece failover exceptions
ORA-19505 cant_identify_file
ORA-19599 corrupt_block
ORA-19608 The specified file is not a backup piece produced by the dbms_backup_restore package. Either the first block of the backup piece is corrupt or this file is not a backup piece.
ORA-19610 corrupt_directory
ORA-19624 retryable_error_exp
Used in SPFILE and controlfile restore from autobackup
ORA-19687 spfile_not_in_bs
ORA-19695 scf_not_in_bs
Used in copy code
ORA-19635 identical_input_output_file
Signaled if recovery area is not set
ORA-19801 ra_not_set
Security Model Execute is not granted
 
APPLYBACKUPPIECE

Reads one backup piece and writes its contents to the files in the restore list.
Applies incremental backups to existing  datafiles.
 dbms_backup_restore.applybackuppiece(
handle IN  VARCHAR2,
done   OUT BOOLEAN,
params IN  VARCHAR2 DEFAULT NULL);
TBD
 
APPLYDATAFILETO
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.

Overload 1		 dbms_backup_restore.applydatafileto(
dfNUMBER       IN BINARY_INTEGER,
toname         IN VARCHAR2 DEFAULT NULL,
fuzziness_hint IN NUMBER   DEFAULT 0);
TBD

Overload 2		 dbms_backup_restore.applydatafileto(
dfNUMBER       IN BINARY_INTEGER,
toname         IN VARCHAR2 DEFAULT NULL,
fuzziness_hint IN NUMBER   DEFAULT 0,
max_corrupt    IN BINARY_INTEGER);
TBD

Overload 3		 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);
exec dbms_backup_restore.applysetdatafile(FALSE, TRUE);
 
AUTOBACKUPFLAG
Turns OFF/ON Server tracking flag for generating autobackups on structural changes dbms_backup_restore.autobackupflag(flag IN BOOLEAN);
exec dbms_backup_restore.autobackupflag(TRUE);
 
BACKUPARCHIVEDLOG
Add an archived log to the redo log backup set

Overload 1		 dbms_backup_restore.backuparchivedlog(
arch_recid IN NUMBER,
arch_stamp IN NUMBER);
TBD
Overload 2 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.

Overload 1
 dbms_backup_restore.backupbackuppiece(
bpname     IN  VARCHAR2,
fname      IN  VARCHAR2,
handle     OUT VARCHAR2,
comment    OUT VARCHAR2,
media      OUT VARCHAR2,
concur     OUT BOOLEAN,
recid      OUT NUMBER,
stamp      OUT NUMBER,
tag        IN  VARCHAR2       DEFAULT NULL,
params     IN  VARCHAR2       DEFAULT NULL,
media_pool IN  BINARY_INTEGER DEFAULT 0,
reuse      IN  BOOLEAN        DEFAULT FALSE);
TBD

Overload 2		 dbms_backup_restore.backupbackuppiece(
bpname        IN  VARCHAR2,
fname         IN  VARCHAR2,
handle        OUT VARCHAR2,
comment       OUT VARCHAR2,
media         OUT VARCHAR2,
concur        OUT BOOLEAN,
recid         OUT NUMBER,
stamp         OUT NUMBER,
tag           IN  VARCHAR2 DEFAULT NULL,
params        IN  VARCHAR2 DEFAULT NULL,
media_pool    IN  BINARY_INTEGER DEFAULT 0,
reuse         IN  BOOLEAN  DEFAULT FALSE,
check_logical IN  BOOLEAN);
TBD

Overload 3		 dbms_backup_restore.backupbackuppiece(
bpname        IN  VARCHAR2,
fname         IN  VARCHAR2,
handle        OUT VARCHAR2,
comment       OUT VARCHAR2,
media         OUT VARCHAR2,
concur        OUT BOOLEAN,
recid         OUT NUMBER,
stamp         OUT NUMBER,
tag           IN  VARCHAR2 DEFAULT NULL,
params        IN  VARCHAR2 DEFAULT NULL,
media_pool    IN  BINARY_INTEGER DEFAULT 0,
reuse         IN  BOOLEAN DEFAULT FALSE,
check_logical IN  BOOLEAN,
copyno        IN  BINARY_INTEGER);
TBD

Overload 4		 dbms_backup_restore.backupbackuppiece(
bpname        IN  VARCHAR2,
fname         IN  VARCHAR2,
handle        OUT VARCHAR2,
comment       OUT VARCHAR2,
media         OUT VARCHAR2,
concur        OUT BOOLEAN,
recid         OUT NUMBER,
stamp         OUT NUMBER,
tag           IN  VARCHAR2 DEFAULT NULL,
params        IN  VARCHAR2 DEFAULT NULL,
media_pool    IN  BINARY_INTEGER DEFAULT 0,
reuse         IN  BOOLEAN DEFAULT FALSE,
check_logical IN  BOOLEAN,
copyno        IN  BINARY_INTEGER,
deffmt        IN  BINARY_INTEGER,
copy_recid    IN  NUMBER,
copy_stamp    IN  NUMBER,
npieces       IN  BINARY_INTEGER);
TBD
 
BACKUPCANCEL
Cancels a backup conversation releasing the context dbms_backup_restore.backupcancel
exec dbms_backup_restore.backupcancel;
 
BACKUPCONTROLFILE
Include the controlfile in the backup set

Overload 1		 dbms_backup_restore.backupcontrolefile(
cfname IN VARCHAR2 DEFAULT NULL);
TBD
Overload 2 dbms_backup_restore.backupcontrolefile(
cfname IN VARCHAR2 DEFAULT NULL,
isstby IN BOOLEAN);
TBD
 
BACKUPDATAFILE

Add a data file to a backup set
 dbms_backup_restore.backupdatafile(
dfNUMBER     IN BINARY_INTEGER,
since_change IN NUMBER         DEFAULT 0,
max_corrupt  IN BINARY_INTEGER DEFAULT 0);
TBD
 
BACKUPDATAFILECOPY

Backups a copy of a datafile that was made via copyDataFile or some operating system utility
 dbms_backup_restore.backupdatafilecopy(
copy_recid   IN NUMBER,
copy_stamp   IN NUMBER,
since_change IN NUMBER         DEFAULT 0,
max_corrupt  IN BINARY_INTEGER DEFAULT 0);
TBD
 
BACKUPPIECECREATE

This procedure should be called to create the first (and any subsequent)
backup piece after all calls to specify the file list have been issued.

Multiple backupPieceCreate calls may be necessary.

Overload 1		 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);
TBD

Overload 2		 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);
TBD

Overload 3		 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);
TBD

Overload 4		 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);
TBD

Overload 9		 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
,archlog_failover OUT BOOLEAN
,deffmt IN BINARY_INTEGER
,recid OUT NUMBER
,stamp OUT NUMBER,
tag        OUT VARCHAR2,
docompress IN  BOOLEAN);
TBD

Overload 10		 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 ,
archlog_failover OUT BOOLEAN,
deffmt IN BINARY_INTEGER,
recid OUT NUMBER,
stamp OUT NUMBER,
tag OUT VARCHAR2,
docompress IN BOOLEAN,
dest IN BINARY_INTEGER);
TBD

Overload 11		 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,
archlog_failover OUT BOOLEAN,
deffmt           IN  BINARY_INTEGER,
recid            OUT NUMBER,
stamp            OUT NUMBER,
tag              OUT VARCHAR2,
docompress       IN  BOOLEAN,
dest             IN  BINARY_INTEGER,
post10_2         IN  BOOLEAN);
TBD

Overload 12		 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,
archlog_failover OUT BOOLEAN,
deffmt      IN  BINARY_INTEGER,
recid       OUT NUMBER,
stamp       OUT NUMBER,
tag         OUT VARCHAR2,
docompress  IN  BOOLEAN,
dest        IN  BINARY_INTEGER,
post10_2    IN  BOOLEAN,
netalias    IN  VARCHAR2,
compressalg IN  VARCHAR2);
TBD
 
BACKUPPIECECRTDUPGET
Gets the output information (media, handle and comment) for the copy specified by copy_n and places it in the
output variables.		 dbms_backup_restore.backuppiecedupget(
copy_n  IN  BINARY_INTEGER,
handle  OUT VARCHAR2,
comment OUT VARCHAR2,
media   OUT VARCHAR2);
TBD
 
BACKUPPIECECRTDUPSET
Sets the output information (media, handle and comment) for the copy specified by copy_n and places it in the
output variables.		 dbms_backup_restore.backuppiececrtdupset(
copy_n IN BINARY_INTEGER,
fname  IN VARCHAR2);
TBD
 
BACKUPPIECERESTORE

Restores a backup piece		 dbms_backup_restore.backuppiecerestore(
bpname        IN  VARCHAR2,
fname         IN  VARCHAR2,
handle        OUT VARCHAR2,
recid         OUT NUMBER,
stamp         OUT NUMBER,
tag           IN  VARCHAR2 DEFAULT NULL,
reuse         IN  BOOLEAN  DEFAULT FALSE,
check_logical IN  BOOLEAN);
TBD
 
BACKUPSETARCHIVEDLOG
Starts a backup conversation to backup archived redo logs.

Overload 1		 dbms_backup_restore.backupsetarchivedlog(
set_stamp  OUT NUMBER,
set_count  OUT NUMBER,
nochecksum IN  BOOLEAN DEFAULT FALSE);
TBD

Overload 2		 dbms_backup_restore.backupsetarchivedlog(
set_stamp  OUT NUMBER,
set_count  OUT NUMBER,
nochecksum IN  BOOLEAN DEFAULT FALSE,
tag        IN  VARCHAR2);
TBD

Overload 3		 dbms_backup_restore.backupsetarchivedlog(
set_stamp OUT NUMBER,
set_count OUT NUMBER,
nochecksum IN BOOLEAN DEFAULT FALSE,
tag IN VARCHAR2,
imagcp IN BOOLEAN);
TBD

Overload 4		 dbms_backup_restore.backupsetarchivedlog(
set_stamp OUT NUMBER
,set_count OUT NUMBER
,nochecksum IN BOOLEAN DEFAULT FALSE
,tag IN VARCHAR2
,imagcp IN BOOLEAN
,validate IN BOOLEAN);
TBD

Overload 5		 dbms_backup_restore.backupsetarchivedlog(
set_stamp OUT NUMBER,
set_count OUT NUMBER,
nochecksum IN BOOLEAN DEFAULT FALSE,
tag IN VARCHAR2,
imagcp IN BOOLEAN,
validate IN BOOLEAN,
keep_options IN BINARY_INTEGER,
keep_until IN NUMBER);
TBD
 
BACKUPSETDATAFILE

Starts a backup conversation to backup datafiles and possibly a controlfile.

Overload 1		 dbms_backup_restore.backupsetdatafile(
set_stamp    OUT NUMBER,
set_count    OUT NUMBER,
nochecksum   IN  BOOLEAN        DEFAULT FALSE,
tag          IN  VARCHAR2       DEFAULT NULL,
incremental  IN  BOOLEAN        DEFAULT FALSE,
backup_level IN  BINARY_INTEGER DEFAULT 0);
TBD

Overload 2		 dbms_backup_restore.backupsetdatafile(
set_stamp     OUT NUMBER,
set_count     OUT NUMBER,
nochecksum    IN  BOOLEAN        DEFAULT FALSE,
tag           IN  VARCHAR2       DEFAULT NULL,
incremental   IN  BOOLEAN        DEFAULT FALSE,
backup_level  IN  BINARY_INTEGER DEFAULT 0,
check_logical IN  BOOLEAN);
TBD

Overload 3		 dbms_backup_restore.backupsetdatafile(
set_stamp     OUT NUMBER,
set_count     OUT NUMBER,
nochecksum    IN  BOOLEAN DEFAULT FALSE,
tag           IN  VARCHAR2 DEFAULT NULL,
incremental   IN  BOOLEAN DEFAULT FALSE,
backup_level  IN  BINARY_INTEGER DEFAULT 0,
check_logical IN  BOOLEAN DEFAULT FALSE,
keep_options  IN  BINARY_INTEGER,
keep_until    IN  NUMBER);
TBD

Overload 4		 dbms_backup_restore.backupsetdatafile(
set_stamp     OUT NUMBER,
set_count     OUT NUMBER,
nochecksum    IN  BOOLEAN DEFAULT FALSE,
tag           IN  VARCHAR2 DEFAULT NULL,
incremental   IN  BOOLEAN DEFAULT FALSE,
backup_level  IN  BINARY_INTEGER DEFAULT 0,
check_logical IN  BOOLEAN DEFAULT FALSE,
keep_options  IN  BINARY_INTEGER DEFAULT 0,
keep_until    IN  NUMBER DEFAULT 0,
imagcp        IN  BOOLEAN,
convertto     IN  BOOLEAN,
convertfr     IN  BOOLEAN,
pltfrmto      IN  BINARY_INTEGER,
pltfrmfr      IN  BINARY_INTEGER,
sameen        IN  BOOLEAN);
TBD

Overload 5		 dbms_backup_restore.backupsetdatafile(
set_stamp     OUT NUMBER,
set_count     OUT NUMBER,
nochecksum    IN  BOOLEAN DEFAULT FALSE,
tag           IN  VARCHAR2 DEFAULT NULL,
incremental   IN  BOOLEAN DEFAULT FALSE,
backup_level  IN  BINARY_INTEGER DEFAULT 0,
check_logical IN  BOOLEAN DEFAULT FALSE,
keep_options  IN  BINARY_INTEGER DEFAULT 0,
keep_until    IN  NUMBER DEFAULT 0,
imagcp        IN  BOOLEAN,
convertto     IN  BOOLEAN,
convertfr     IN  BOOLEAN,
pltfrmto      IN  BINARY_INTEGER,
pltfrmfr      IN  BINARY_INTEGER,
sameen        IN  BOOLEAN,
convertdb     IN  BOOLEAN);
TBD

Overload 6		 dbms_backup_restore.backupsetdatafile(
set_stamp     OUT NUMBER,
set_count     OUT NUMBER,
nochecksum    IN  BOOLEAN DEFAULT FALSE,
tag           IN  VARCHAR2 DEFAULT NULL,
incremental   IN  BOOLEAN DEFAULT FALSE,
backup_level  IN  BINARY_INTEGER DEFAULT 0,
check_logical IN  BOOLEAN DEFAULT FALSE,
keep_options  IN  BINARY_INTEGER DEFAULT 0,
keep_until    IN  NUMBER DEFAULT 0,
imagcp        IN  BOOLEAN,
convertto     IN  BOOLEAN,
convertfr     IN  BOOLEAN,
pltfrmto      IN  BINARY_INTEGER,
pltfrmfr      IN  BINARY_INTEGER,
sameen        IN  BOOLEAN,
convertdb     IN  BOOLEAN,
nocatalog     IN  BOOLEAN);
TBD

Overload 7		 dbms_backup_restore.backupsetdatafile(
set_stamp OUT NUMBER,
set_count OUT NUMBER,
nochecksum IN BOOLEAN DEFAULT FALSE
,tag IN VARCHAR2 DEFAULT NULL
,incremental IN BOOLEAN DEFAULT FALSE
,backup_level IN BINARY_INTEGER DEFAULT 0
,check_logical IN BOOLEAN DEFAULT FALSE
,keep_options IN BINARY_INTEGER DEFAULT 0
,keep_until IN NUMBER DEFAULT 0
,imagcp IN BOOLEAN
,convertto IN BOOLEAN
,convertfr IN BOOLEAN
,pltfrmto IN BINARY_INTEGER 
,pltfrmfr IN BINARY_INTEGER 
,sameen IN BOOLEAN
,convertdb IN BOOLEAN
,nocatalog IN BOOLEAN
,validate IN BOOLEAN
,validateblk IN BOOLEAN
,hdrupd IN OUT BOOLEAN);
TBD
 
BACKUPSPFILE
Include the current SPFILE in the backup set. dbms_backup_restore.backupspfile;
exec dbms_backup_restore.backupspfile;
 
BACKUPSTATUS

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);

BACKUP_NO_CONVERSATION CONSTANT BINARY_INTEGER := 0;
BACKUP_NAMING_FILES    CONSTANT BINARY_INTEGER := 1;
BACKUP_PIECE_CREATE    CONSTANT BINARY_INTEGER := 2;
BACKUP_PIECE_RETRY     CONSTANT BINARY_INTEGER := 3;
TBD
 
BACKUPVALIDATE
Called to perform a 'validation backup'.

Overload 1		 dbms_backup_restore.backupvalidate;
exec dbms_backup_restore.backupvalidate;

Indicates if server did archivelog failover

Overload 2		 dbms_backup_restore.backupvalidate(archlog_failover OUT BOOLEAN);
set serveroutput on

DECLARE
 b BOOLEAN;
BEGIN
  dbms_backup_restore.backupvalidate(b);

  IF b THEN
    dbms_output.put_line('TRUE');
  ELSE
    dbms_output.put_line('FALSE');
  END IF;
END;
/
Overload 3 dbms_backup_restore.backupvalidate(
archlog_failover OUT BOOLEAN,
nocleanup        IN  BOOLEAN);
TBD
 
BCTSET


Allows for runtime adjustment of various constants that affect the operation of the CTWR process. This routine should be used only by Oracle support personnel. 		dbms_backup_restore.bctset(
parmno  IN BINARY_INTEGER,
numval  IN NUMBER   DEFAULT null,
charval IN VARCHAR2 DEFAULT null);

BCTSET_CLEANLIMIT           CONSTANT BINARY_INTEGER := 1;
BCTSET_CKPFREQ              CONSTANT BINARY_INTEGER := 2;
BCTSET_MAXPEND              CONSTANT BINARY_INTEGER := 3;
BCTSET_MAXEXT               CONSTANT BINARY_INTEGER := 4;
BCTSET_OPTIONS              CONSTANT BINARY_INTEGER := 5;
BCTSET_CTWR_EMPTY_THRESHOLD CONSTANT BINARY_INTEGER := 6;
BCTSET_CTWR_REAP_THRESHOLD  CONSTANT BINARY_INTEGER := 7;
BCTSET_CTWR_CIC_SECONDS     CONSTANT BINARY_INTEGER := 8;
TBD
 
BCTSWITCH

Switches change tracking bitmaps for the specified list of files.
 dbms_backup_restore.bctswitch(filelist IN VARCHAR2 DEFAULT NULL);
TBD
 
BMRADDBLOCK
Add each block in the range (starting from blkNUMBER) to the bmr context dbms_backup_restore.bmraddblock(
dfNUMBER  IN BINARY_INTEGER,
blkNUMBER IN BINARY_INTEGER,
range     IN BINARY_INTEGER DEFAULT 1);
TBD
 
BMRCANCEL

Ends/cancels previously started conversation
 dbms_backup_restore.bmrcancel;
exec dbms_backup_restore.bmrcancel;
 
BMRDOMEDIARECOVERY

Called to recover after bmr is setup
 dbms_backup_restore.bmrdomeidarecovery(alname IN VARCHAR2);
TBD
 
BMRGETFILE

Returns file NUMBER for which blocks are to be restored		 dbms_backup_restore.bmrgetfile(firstcall IN BOOLEAN)
RETURN NUMBER;
DECLARE
 x NUMBER;
BEGIN
  x := dbms_backup_restore.bmrgetfile(FALSE);
END;
/
 
BMRINITIALSCAN
Scans for new blocks and eliminates the one in block list dbms_backup_restore.bmrinitialscan;
exec dbms_backup_restore.bmrinitialscan;
 
BMRRESTOREFROMFLASHBACK
Restore blocks from flashback logs. dbms_backup_restore.bmrrestorefromflashback(
limitSCN    IN  NUMBER,
restoredNum OUT BINARY_INTEGER);
TBD
 
BMRSCANDATAFILECOPY

Copies blocks from datafilecopy 		dbms_backup_restore.bmrscandatafilecopy(
recid IN NUMBER,
stamp IN NUMBER);
TBD
 
BMRSTART
Starts a bmr conversation

Overload 1		 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.

Obsolete from 10gR2 onwards - always returns 0		 dbms_backup_restore.cfilecalcsizearray(num_recs IN nrecs_array)
RETURN BINARY_INTEGER;
TBD
 
CFILECALCSIZELIST
Takes a list of parameters, for each record type, the NUMBER of record slots postulated for the section containing records of that type.

Obsolete from 10gR2 onward

Overload 1		 dbms_backup_restore.cfileCalcSizeList(
num_ckptprog_recs          IN BINARY_INTEGER DEFAULT 0,
num_thread_recs            IN BINARY_INTEGER DEFAULT 0,
num_logfile_recs           IN BINARY_INTEGER DEFAULT 0,
num_datafile_recs          IN BINARY_INTEGER DEFAULT 0,
num_filename_recs          IN BINARY_INTEGER DEFAULT 0,
num_tablespace_recs        IN BINARY_INTEGER DEFAULT 0,
num_tempfile_recs          IN BINARY_INTEGER DEFAULT 0,
num_rmanconfiguration_recs IN BINARY_INTEGER DEFAULT 0,
num_loghistory_recs        IN BINARY_INTEGER DEFAULT 0,
num_offlinerange_recs      IN BINARY_INTEGER DEFAULT 0,
num_archivedlog_recs       IN BINARY_INTEGER DEFAULT 0,
num_backupset_recs         IN BINARY_INTEGER DEFAULT 0,
num_backuppiece_recs       IN BINARY_INTEGER DEFAULT 0,
num_backedupdfile_recs     IN BINARY_INTEGER DEFAULT 0,
num_backeduplog_recs       IN BINARY_INTEGER DEFAULT 0,
num_dfilecopy_recs         IN BINARY_INTEGER DEFAULT 0,
num_bkdfcorruption_recs    IN BINARY_INTEGER DEFAULT 0,
num_dfcopycorruption_recs  IN BINARY_INTEGER DEFAULT 0,
num_deletedobject_recs     IN BINARY_INTEGER DEFAULT 0,
num_proxy_recs             IN BINARY_INTEGER DEFAULT 0,
num_reserved4_recs         IN BINARY_INTEGER DEFAULT 0)
RETURN BINARY_INTEGER;
TBD

Overload 2		 dbms_backup_restore.cfileCalcSizeList(
num_ckptprog_recs IN BINARY_INTEGER DEFAULT 0,
num_thread_recs IN BINARY_INTEGER DEFAULT 0,
num_logfile_recs IN BINARY_INTEGER DEFAULT 0,
num_datafile_recs IN BINARY_INTEGER DEFAULT 0,
num_filename_recs IN BINARY_INTEGER DEFAULT 0,
num_tablespace_recs IN BINARY_INTEGER DEFAULT 0,
num_tempfile_recs IN BINARY_INTEGER DEFAULT 0,
num_rmanconfiguration_recs IN BINARY_INTEGER DEFAULT 0,
num_loghistory_recs IN BINARY_INTEGER DEFAULT 0,
num_offlinerange_recs IN BINARY_INTEGER DEFAULT 0,
num_archivedlog_recs IN BINARY_INTEGER DEFAULT 0,
num_backupset_recs IN BINARY_INTEGER DEFAULT 0,
num_backuppiece_recs IN BINARY_INTEGER DEFAULT 0,
num_backedupdfile_recs IN BINARY_INTEGER DEFAULT 0,
num_backeduplog_recs IN BINARY_INTEGER DEFAULT 0,
num_dfilecopy_recs IN BINARY_INTEGER DEFAULT 0,
num_bkdfcorruption_recs IN BINARY_INTEGER DEFAULT 0,
num_dfcopycorruption_recs IN BINARY_INTEGER DEFAULT 0,
num_deletedobject_recs IN BINARY_INTEGER DEFAULT 0,
num_proxy_recs IN BINARY_INTEGER DEFAULT 0,
num_reserved4_recs IN BINARY_INTEGER DEFAULT 0,
num_db2_recs IN BINARY_INTEGER,
num_incarnation_recs IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD

Overload 3		 dbms_backup_restore.cfileCalcSizeList(
num_ckptprog_recs IN BINARY_INTEGER DEFAULT 0
,num_thread_recs IN BINARY_INTEGER DEFAULT 0
,num_logfile_recs IN BINARY_INTEGER DEFAULT 0
,num_datafile_recs IN BINARY_INTEGER DEFAULT 0
,num_filename_recs IN BINARY_INTEGER DEFAULT 0
,num_tablespace_recs IN BINARY_INTEGER DEFAULT 0
,num_tempfile_recs IN BINARY_INTEGER DEFAULT 0
,num_rmanconfiguration_recs IN BINARY_INTEGER DEFAULT 0
,num_loghistory_recs IN BINARY_INTEGER DEFAULT 0
,num_offlinerange_recs IN BINARY_INTEGER DEFAULT 0
,num_archivedlog_recs IN BINARY_INTEGER DEFAULT 0
,num_backupset_recs IN BINARY_INTEGER DEFAULT 0
,num_backuppiece_recs IN BINARY_INTEGER DEFAULT 0
,num_backedupdfile_recs IN BINARY_INTEGER DEFAULT 0
,num_backeduplog_recs IN BINARY_INTEGER DEFAULT 0
,num_dfilecopy_recs IN BINARY_INTEGER DEFAULT 0
,num_bkdfcorruption_recs IN BINARY_INTEGER DEFAULT 0
,num_dfcopycorruption_recs IN BINARY_INTEGER DEFAULT 0
,num_deletedobject_recs IN BINARY_INTEGER DEFAULT 0
,num_proxy_recs IN BINARY_INTEGER DEFAULT 0
,num_reserved4_recs IN BINARY_INTEGER DEFAULT 0
,num_db2_recs IN BINARY_INTEGER
,num_incarnation_recs IN BINARY_INTEGER,
num_flashback_recs IN BINARY_INTEGER,
num_rainfo_recs IN BINARY_INTEGER,
num_instrsvt_recs IN BINARY_INTEGER,
num_agedfiles_recs IN BINARY_INTEGER,
num_rmanstatus_recs IN BINARY_INTEGER,
num_threadinst_recs IN BINARY_INTEGER,
num_mtr_recs IN BINARY_INTEGER,
num_dfh_recs IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD

Overload 4		 dbms_backup_restore.cfileCalcSizeList(
num_ckptprog_recs IN BINARY_INTEGER DEFAULT 0
,num_thread_recs IN BINARY_INTEGER DEFAULT 0
,num_logfile_recs IN BINARY_INTEGER DEFAULT 0
,num_datafile_recs IN BINARY_INTEGER DEFAULT 0
,num_filename_recs IN BINARY_INTEGER DEFAULT 0
,num_tablespace_recs IN BINARY_INTEGER DEFAULT 0
,num_tempfile_recs IN BINARY_INTEGER DEFAULT 0
,num_rmanconfiguration_recs IN BINARY_INTEGER DEFAULT 0
,num_loghistory_recs IN BINARY_INTEGER DEFAULT 0
,num_offlinerange_recs IN BINARY_INTEGER DEFAULT 0
,num_archivedlog_recs IN BINARY_INTEGER DEFAULT 0
,num_backupset_recs IN BINARY_INTEGER DEFAULT 0
,num_backuppiece_recs IN BINARY_INTEGER DEFAULT 0
,num_backedupdfile_recs IN BINARY_INTEGER DEFAULT 0
,num_backeduplog_recs IN BINARY_INTEGER DEFAULT 0
,num_dfilecopy_recs IN BINARY_INTEGER DEFAULT 0
,num_bkdfcorruption_recs IN BINARY_INTEGER DEFAULT 0
,num_dfcopycorruption_recs IN BINARY_INTEGER DEFAULT 0
,num_deletedobject_recs IN BINARY_INTEGER DEFAULT 0
,num_proxy_recs IN BINARY_INTEGER DEFAULT 0
,num_reserved4_recs IN BINARY_INTEGER DEFAULT 0
,num_db2_recs IN BINARY_INTEGER
,num_incarnation_recs IN BINARY_INTEGER
,num_flashback_recs IN BINARY_INTEGER
,num_rainfo_recs IN BINARY_INTEGER
,num_instrsvt_recs IN BINARY_INTEGER
,num_agedfiles_recs IN BINARY_INTEGER
,num_rmanstatus_recs IN BINARY_INTEGER
,num_threadinst_recs IN BINARY_INTEGER,
num_mtr_recs IN BINARY_INTEGER,
num_dfh_recs IN BINARY_INTEGER,
num_sdm_recs IN BINARY_INTEGER,
num_grp_recs IN BINARY_INTEGER,
num_rp_recs IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD

Overload 5		 dbms_backup_restore.cfileCalcSizeList(
cfileCalcSizeList(
num_ckptprog_recs IN BINARY_INTEGER DEFAULT 0
,num_thread_recs IN BINARY_INTEGER DEFAULT 0
,num_logfile_recs IN BINARY_INTEGER DEFAULT 0
,num_datafile_recs IN BINARY_INTEGER DEFAULT 0
,num_filename_recs IN BINARY_INTEGER DEFAULT 0
,num_tablespace_recs IN BINARY_INTEGER DEFAULT 0
,num_tempfile_recs IN BINARY_INTEGER DEFAULT 0
,num_rmanconfiguration_recs IN BINARY_INTEGER DEFAULT 0
,num_loghistory_recs IN BINARY_INTEGER DEFAULT 0
,num_offlinerange_recs IN BINARY_INTEGER DEFAULT 0
,num_archivedlog_recs IN BINARY_INTEGER DEFAULT 0
,num_backupset_recs IN BINARY_INTEGER DEFAULT 0
,num_backuppiece_recs IN BINARY_INTEGER DEFAULT 0
,num_backedupdfile_recs IN BINARY_INTEGER DEFAULT 0
,num_backeduplog_recs IN BINARY_INTEGER DEFAULT 0
,num_dfilecopy_recs IN BINARY_INTEGER DEFAULT 0
,num_bkdfcorruption_recs IN BINARY_INTEGER DEFAULT 0
,num_dfcopycorruption_recs IN BINARY_INTEGER DEFAULT 0
,num_deletedobject_recs IN BINARY_INTEGER DEFAULT 0
,num_proxy_recs IN BINARY_INTEGER DEFAULT 0
,num_reserved4_recs IN BINARY_INTEGER DEFAULT 0
,num_db2_recs IN BINARY_INTEGER
,num_incarnation_recs IN BINARY_INTEGER
,num_flashback_recs IN BINARY_INTEGER
,num_rainfo_recs IN BINARY_INTEGER
,num_instrsvt_recs IN BINARY_INTEGER
,num_agedfiles_recs IN BINARY_INTEGER
,num_rmanstatus_recs IN BINARY_INTEGER
,num_threadinst_recs IN BINARY_INTEGER
,num_mtr_recs IN BINARY_INTEGER
,num_dfh_recs IN BINARY_INTEGER
,num_sdm_recs IN BINARY_INTEGER
,num_grp_recs IN BINARY_INTEGER
,num_rp_recs IN BINARY_INTEGER
,num_bcr_recs IN BINARY_INTEGER
,num_acm_recs IN BINARY_INTEGER
,num_rlr_recs IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD
 
CFILEMAKEANDUSESNAPSHOT
Creates a snapshot of the current  controlfile and stores it in a file it creates  using the DEFAULT filename or previously specified via cfileSetSnapshotName.

Overload 1		 dbms_backup_restore.cfilemakeandusesnapshot;
BEGIN
  dbms_backup_restore.cfilesetsnapshotname('c:\temp\backup.ctl');
  dbms_backup_restore.cfilemakeandusesnapshot;
END;
/
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). dbms_backup_restore.cfileresizesection(
record_type    IN  BINARY_INTEGER,
before_numrecs OUT BINARY_INTEGER,
after_numrecs  OUT BINARY_INTEGER,
delta_numrecs  IN  BINARY_INTEGER DEFAULT 0);
TBD
 
CFILESETSNAPSHOTNAME
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
?

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);
TBD
Overload 3 dbms_backup_restore.
TBD
 
CHANGEBACKUPPIECE
Changes the metadata about a backup piece.

Overload 1		 dbms_backup_restore.changebackuppiece(
recid     IN NUMBER,
stamp     IN NUMBER,
handle    IN VARCHAR2,
set_stamp IN NUMBER,
set_count IN NUMBER,
pieceno   IN BINARY_INTEGER,
status    IN VARCHAR2, -- 'D','S','A','U','X'
params    IN VARCHAR2 DEFAULT NULL );
TBD

Overload 2		 dbms_backup_restore.changebackuppiece(
recid     IN NUMBER,
stamp     IN NUMBER,
handle    IN VARCHAR2,
set_stamp IN NUMBER,
set_count IN NUMBER,
pieceno   IN BINARY_INTEGER,
status    IN VARCHAR2, -- 'D','S','A','U','X'
params    IN VARCHAR2 DEFAULT NULL,
force     IN BINARY_INTEGER);
TBD
 
CHANGEBACKUPSET

?
 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
?

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. dbms_backup_restore.checkfilename(name IN VARCHAR2) RETURN NUMBER;
SELECT file_name, dbms_backup_restore.checkfilename(file_name)
FROM dba_data_files;

SELECT dbms_backup_restore.checkfilename('ZZYZX.DBF') FROM dual;
 
CLEANUPBACKUPRECORDS
Called by RMAN at end of delete/uncatalog command to mark bdf/bsf/brl/bs as deleted for which no backuppieces exists. dbms_backup_restore.clearnupbackuprecords;
exec dbms_backup_restore.clearnupbackuprecords;
 
CLEARONLINELOGNAMES
For TSPITR when AUXILIARY DESTINATION is used, we need to clear all names of the online logs so that they are created in the specified location. dbms_backup_restore.clearonlinelognames;
exec dbms_backup_restore.clearonlinelognames;
 
CLEARRECOVERYDESTFLAG
Set is_recovery_dest_file='NO' for the given record. dbms_backup_restore.clearrecoverydestflag(
rectype IN BINARY_INTEGER,
recid   IN NUMBER,
stamp   IN NUMBER);
TBD
 
COMMITRMANSTATUSROW
Commits the row into controlfile. The SGA version of the row is saved in the controlfile and the contolfile record is marked as finished.

Overload 1		 dbms_backup_restore.commitrmanstatusrow(
row_id IN NUMBER,
row_stamp IN NUMBER,
mbytes IN NUMBER,
status IN BINARY_INTEGER);
TBD

Overload 2		 dbms_backup_restore.commitrmanstatusrow(
row_id    IN NUMBER,
row_stamp IN NUMBER,
mbytes    IN NUMBER,
status    IN BINARY_INTEGER,
ibytes    IN NUMBER,
obytes    IN NUMBER,
odevtype  IN VARCHAR2);
TBD
 
CONVERTDATAFILECOPY
Name one file for conversion at the target database. dbms_backup_restore.convertdatafilecopy(
fname       IN VARCHAR2,
max_corrupt IN BINARY_INTEGER DEFAULT 0);
TBD
 
CONVERTFILENAME
Converts a filename with the appropriate conversion pattern

Overload 1		 dbms_backup_restore.convertfilename(
fname IN VARCHAR2,
ftype IN BINARY_INTEGER)
RETURN VARCHAR2;
TBD
Overload 2 dbms_backup_restore.convertfilename(
fname   IN VARCHAR2,
ftype   IN BINARY_INTEGER,
osftype IN BOOLEAN)
RETURN VARCHAR2;
TBD
 
COPYARCHIVEDLOG

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.		 dbms_backup_restore.copyarchivedlog(
arch_recid IN  NUMBER,
arch_stamp IN  NUMBER,
fname      IN  VARCHAR2,
full_name  OUT VARCHAR2,
recid      OUT NUMBER,
stamp      OUT NUMBER,
nochecksum IN  BOOLEAN DEFAULT FALSE);
TBD
 
COPYCONTROLFILE
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);
TBD
 
COPYDATAFILE

Copies the named file in the database

Overload 1		 dbms_backup_restore.copydatafile(
dfNUMBER    IN  BINARY_INTEGER,
fname       IN  VARCHAR2,
full_name   OUT VARCHAR2,
recid       OUT NUMBER,
stamp       OUT NUMBER,
max_corrupt IN  BINARY_INTEGER DEFAULT 0,
tag         IN  VARCHAR2       DEFAULT NULL,
nochecksum  IN  BOOLEAN        DEFAULT FALSE,
isbackup    IN  BOOLEAN        DEFAULT FALSE);
TBD

Overload 2		 dbms_backup_restore.copydatafile(
dfNUMBER      IN  BINARY_INTEGER,
fname         IN  VARCHAR2,
full_name     OUT VARCHAR2,
recid         OUT NUMBER,
stamp         OUT NUMBER,
max_corrupt   IN  BINARY_INTEGER DEFAULT 0,
tag           IN  VARCHAR2 DEFAULT NULL,
nochecksum    IN  BOOLEAN DEFAULT FALSE,
isbackup      IN  BOOLEAN DEFAULT FALSE,
check_logical IN  BOOLEAN);
TBD

Overload 3		 dbms_backup_restore.copydatafile(
dfNUMBER      IN  BINARY_INTEGER,
fname         IN  VARCHAR2,
full_name     OUT VARCHAR2,
recid         OUT NUMBER,
stamp         OUT NUMBER,
max_corrupt   IN  BINARY_INTEGER DEFAULT 0,
tag           IN  VARCHAR2 DEFAULT NULL,
nochecksum    IN  BOOLEAN DEFAULT FALSE,
isbackup      IN  BOOLEAN DEFAULT FALSE,
check_logical IN  BOOLEAN DEFAULT FALSE,
keep_options  IN  BINARY_INTEGER,
keep_until    IN  NUMBER);
TBD
 
COPYDATAFILECOPY

Used to make a copy of a copy

Overload 1		 dbms_backup_restore.copydatafilecopy(
copy_recid  IN  NUMBER,
copy_stamp  IN  NUMBER,
full_name   OUT VARCHAR2,
recid       OUT NUMBER,
stamp       OUT