Oracle DBMS_BACKUP_RESTORE Backup Restore

Search the Reference Library pages:

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

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

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

TBD

Overload 4

TBD

BACKUPCANCEL

Cancels a backup conversation releasing the context

dbms_backup_restore.backupcancel

exec dbms_backup_restore.backupcancel;

BACKUPCONTROLFILE (new 11.1.0.7 overload)

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

Overload 3

dbms_backup_restore.backupcontrolefile(
cfname IN VARCHAR2 DEFAULT NULL,
isstby IN BOOLEAN,
snapshot_cf 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

TBD

Overload 2

TBD

Overload 3

TBD

Overload 4

TBD

Overload 5

TBD

Overload 6

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

TBD

Overload 2

TBD

Overload 3

TBD

Overload 4

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

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

TBD

Overload 2

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

TBD

Overload 5

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: emp\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

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

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

TBD

CHANGEBACKUPSET

Undocumented
-- keep_options
-- 0x0000 - No keep
-- 0x0100 - RECOVERABLE
-- 0x0200 - UNRECOVERABLE
-- 0x0400 - CONSISTENT
-- keep_until
-- 0 - forever
-- >0 - time when backup will expire

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

TBD

Overload 3

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;

CLEANUPFOREIGNARCHIVEDLOGS (new 11.1.0.7)

Deletes all foreign archivelogs created in the FRA as well as from the controlfile record. Called when
downgrading the database to pre 11g.

dbms_backup_restore.cleanupforeignarchivedlogs(

exec dbms_backup_restore.cleanupforeignarchivedlogs;

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 NUMBER,
fname       IN VARCHAR2       DEFAULT NULL,
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.copydatafilecopy(
copy_recid    IN NUMBER,
copy_stamp    IN NUMBER,
full_name     OUT VARCHAR2,
recid         OUT NUMBER,
stamp         OUT NUMBER,
fname         IN VARCHAR2       DEFAULT NULL,
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.copydatafilecopy(
copy_recid    IN NUMBER,
copy_stamp    IN NUMBER,
full_name     OUT VARCHAR2,
recid         OUT NUMBER,
stamp         OUT NUMBER,
fname         IN VARCHAR2       DEFAULT NULL,
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

CREATEDATAFILE

re-createDatafile for RMAN. Functionally this is same as ALTER
DATABASE CREATE DATAFILE from RMAN client point of view, when
RMAN is doing recovery (i.e., recovery is TRUE).

dbms_backup_restore.createdatafile(
fno      IN NUMBER,
newomf   IN BOOLEAN,
recovery IN BOOLEAN,
fname    IN VARCHAR2 DEFAULT NULL);

TBD

CREATERMANOUTPUTROW

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

TBD

CROSSCHECKBACKUPPIECE

CrosscheckBackupPiece is obsolete
Use validateBackupPiece instead.

dbms_backup_restore.crosscheckbackuppiece(
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)
RETURN BINARY_INTEGER;

Obsolete

DBA2RFNO

Translates DBA NUMBER to block# and relative_file#

Overload 1

dbms_backup_restore.dba2rfno(
dbano IN NUMBER,
rfno OUT NUMBER,
blockno OUT NUMBER);

TBD

Overload 2

dbms_backup_restore.d ba2rfno(
dbano   IN NUMBER,
rfno    OUT NUMBER,
blockno OUT NUMBER,
tsnum   IN BINARY_INTEGER);

TBD

DELETEARCHIVEDLOG

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

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.

Overload 1

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

TBD

Overload 2

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

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

TBD

DELETED_GETDBINFO

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

dbms_backup_restore.deleted_getdbinfo;

exec dbms_backup_restore.deleted_getdbinfo;

DELETEFILE

Delete a file from the operating system

dbms_backup_restore.deletefile(fname IN VARCHAR2);

-- create file c: emp\zzyzx.txt using notepad.

exec dbms_backup_restore.deletefile('c: emp\zzyzx.txt');

DEVICEALLOCATE

Allocates a backup device

Overload 1

dbms_backup_restore.deviceAllocate(
type   IN VARCHAR2       DEFAULT NULL,
name   IN VARCHAR2       DEFAULT NULL,
ident IN VARCHAR2       DEFAULT NULL,
noio   IN BOOLEAN        DEFAULT FALSE,
params IN VARCHAR2       DEFAULT NULL)
RETURN VARCHAR2;

See RESTOREDATAFILETO Demo

Overload 2

TBD

DEVICECOMMAND

Sends an arbitrary command to the currently allocated device

dbms_backup_restore.device_command(
cmd IN VARCHAR2,
params IN VARCHAR2 DEFAULT NULL);

TBD

DEVICEDEALLOCATE

Releases the currently allocated device

dbms_backup_restore.devicedeallocate(params IN VARCHAR2 DEFAULT NULL);

exec dbms_backup_restore.deviceDeallocate;

DEVICEQUERY

Request information about the device

dbms_backup_restore.devicequery(question IN BINARY_INTEGER)
RETURN VARCHAR2;

DEVICEQUERY_VENDOR CONSTANT BINARY_INTEGER := 0;
DEVICEQUERY_PROXY CONSTANT BINARY_INTEGER := 1;
DEVICEQUERY_MAXSIZE CONSTANT BINARY_INTEGER := 2;
DEVICEQUERY_MAXPROXY CONSTANT BINARY_INTEGER := 3;

TBD

DEVICESTATUS

Returns information about the currently allocated device

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

NO_DEVICE    CONSTANT BINARY_INTEGER := 0;
NO_IO_ALLOC CONSTANT BINARY_INTEGER := 1;
EXCL_ALLOC   CONSTANT BINARY_INTEGER := 2;
CONCUR_ALLOC CONSTANT BINARY_INTEGER := 3;
FILESYSTEM   CONSTANT BINARY_INTEGER := 4;

set serveroutput on

DECLARE
state BINARY_INTEGER;
typ VARCHAR2(30);
name VARCHAR2(30);
bsiz BINARY_INTEGER;
bcnt BINARY_INTEGER;
kb NUMBER;
rdrt BINARY_INTEGER;
para BINARY_INTEGER;
BEGIN
dbms_backup_restore.devicestatus(state, typ, name, bsiz, bcnt, kb,
rdrt, para);

dbms_output.put_line(state);
dbms_output.put_line(typ);
dbms_output.put_line(name);
END;
/

DOAUTOBACKUP

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.

Overload 1

dbms_backup_restore.doautobackup(
ncopies OUT BINARY_INTEGER,
cfaudate IN DATE           DEFAULT NULL,
seq      IN BINARY_INTEGER DEFAULT NULL,
format   IN VARCHAR2       DEFAULT NULL);

TBD

Overload 2

dbms_backup_restore.doautobackup(
ncopies OUT BINARY_INTEGER,
cfaudate IN DATE           DEFAULT NULL,
seq      IN BINARY_INTEGER DEFAULT NULL,
format   IN VARCHAR2       DEFAULT NULL,
p1       IN BINARY_INTEGER,
p2       IN BINARY_INTEGER,
p3       IN BINARY_INTEGER,
p4       IN VARCHAR2);

TBD

FAULT_INJECTOR

Use this function, for testing, to simulate any oracle error in a backup_restore function.

dbms_backup_restore.fault_injector(
funcNo IN NUMBER,
funcErr IN NUMBER,
funcCounter IN NUMBER DEFAULT 1);

TBD

FETCHFILERESTORED

Used to get the files which were restored successfully by the restore conversation.

Overload 1

dbms_backup_restore.fetchfilerestored(
firstcall IN BOOLEAN,
proxy      IN BOOLEAN,
ftype      OUT BINARY_INTEGER,
fno        OUT BINARY_INTEGER,
thread     OUT BINARY_INTEGER,
sequence   OUT NUMBER,
resetSCN   OUT NUMBER,
resetStamp OUT NUMBER)
RETURN BINARY_INTEGER;

TBD

Overload 2

TBD

FINDAUTSEARCHFILETABLE

Returns auto backup piece from X$KRBMSFT which match the input criteria (mustspfile and until).

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

TBD

GENTRANSPORTSCRIPT

Generates the transport script, pfile and convert script for transportable db

Overload 1

dbms_backup_restore.gentransportscript(
tscname      IN VARCHAR2 DEFAULT NULL,
pfformat     IN VARCHAR2 DEFAULT NULL,
rmtscname    IN VARCHAR2 DEFAULT NULL,
pfname       OUT VARCHAR2,
newtscname   OUT VARCHAR2,
newrmtscname OUT VARCHAR2);

TBD

Overload 2

TBD

GETARCFILENAME

Undocumented

dbms_backup_restore.getarchfilename(
thread IN NUMBER,
sequence IN NUMBER,
rls_id IN NUMBER,
arcName OUT VARCHAR2);

TBD

GETBLOCKSTAT

Copy all the statictics that was collected during a backup command.

dbms_backup_restore.getblockstat(
blockStatTable OUT blockStatTable_t);

TBD

GETCKPT

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.

dbms_backup_restore.getckpt(
ckp_scn OUT NUMBER,
high_cp_recid OUT NUMBER, -- 1
high_rt_recid OUT NUMBER, -- 2
high_le_recid OUT NUMBER, -- 3
high_fe_recid OUT NUMBER, -- 4
high_fn_recid OUT NUMBER, -- 5
high_ts_recid OUT NUMBER, -- 6
high_r1_recid OUT NUMBER, -- 7
high_rm_recid OUT NUMBER, -- 8
high_lh_recid OUT NUMBER, -- 9
high_or_recid OUT NUMBER, -- 10
high_al_recid OUT NUMBER, -- 11
high_bs_recid OUT NUMBER, -- 12
high_bp_recid OUT NUMBER, -- 13
high_bf_recid OUT NUMBER, -- 14
high_bl_recid OUT NUMBER, -- 15
high_dc_recid OUT NUMBER, -- 16
high_fc_recid OUT NUMBER, -- 17
high_cc_recid OUT NUMBER, -- 18
high_dl_recid OUT NUMBER, -- 19
high_r3_recid OUT NUMBER, -- 20
high_r4_recid OUT NUMBER); -- 21

TBD

GETCKPTSCN

Is the same as getCkpt procedure but returns only the ckp_scn

dbms_backup_restore.getckptscn RETURN NUMBER;

SELECT dbms_backup_restore.getckptscn
FROM dual;

GETCNCTSTR

Obtains from the server the connect string to use as defined in sparams.h; if escaped is TRUE then it performs sosd specific conversion to allow connect string to be passed to RMAN host command.

dbms_backup_restore.getcnctstr(
cnctstr OUT VARCHAR2,
orasid IN VARCHAR2,
escaped IN BOOLEAN);

VALIDATION_OK CONSTANT BINARY_INTEGER := 0;
VALIDATION_RECORD_NOTFOUND CONSTANT BINARY_INTEGER := 1;
VALIDATION_RECORD_DIFFERENT CONSTANT BINARY_INTEGER := 2;
VALIDATION_FILE_DIFFERENT CONSTANT BINARY_INTEGER := 4;

TBD

GETDEFAULTTAG

Constructs the DEFAULT tag for backups and image copies.

dbms_backup_restore.getDEFAULTtag(deftag OUT VARCHAR2);

TBD

GETDISKGROUPNAME

Given an ASM filename, return the disk group name.

dbms_backup_restore.getdiskgroupname(fname IN VARCHAR2) RETURN VARCHAR2;

TBD

GETFNO

Expands the name and compares it with all the datafile names and returns the file NUMBER for the matching file.

dbms_backup_restore.getfno(
name IN VARCHAR2,
dfNUMBER OUT BINARY_INTEGER,
creation_change OUT NUMBER);

SELECT file_name, file_id,
FROM dba_data_files;

set serveroutput on

DECLARE
dfnum BINARY_INTEGER;
crchng NUMBER;
BEGIN
dbms_backup_restore.getfno('C:\ORACLE\ORADATA\ORABASE\USERS01.DBF', dfnum, crchng);

dbms_output.put_line(dfnum);
dbms_output.put_line(crchng);
END;
/

GETLIMIT

Get a limit to a particular value.

dbms_backup_restore.getlimit(name IN BINARY_INTEGER, value OUT NUMBER);

TBD

GETMAXINFO

This procedure is used to obtain the max values for the parameters used in the create controlfile command. These values cannot be obtained from tables, as are only kept in the SGA.

dbms_backup_restore.getmaxinfo(
mlogf OUT BINARY_INTEGER,
mlogm OUT BINARY_INTEGER,
mdatf OUT BINARY_INTEGER,
minst OUT BINARY_INTEGER,
mlogh OUT BINARY_INTEGER,
chset OUT VARCHAR2);

TBD

GETOMFFILENAME

Returns an OMF file name for a datafile in the given tablespace.

Overload 1

dbms_backup_restore.getomffilename(
tsname IN VARCHAR2,
omfname OUT VARCHAR2);

set serveroutput on

DECLARE
omfname VARCHAR2(30);
BEGIN
dbms_backup_restore.getomffilename('UWDATA', omfname);
dbms_output.put_line(omfname);
END;
/

Overload 2

dbms_backup_restore.getomffilename(
tsname IN VARCHAR2,
omfname OUT VARCHAR2,
isTemp IN BOOLEAN);

set serveroutput on

DECLARE
omfname VARCHAR2(30);
BEGIN
dbms_backup_restore.getomffilename('UWDATA', omfname, FALSE);
dbms_output.put_line(omfname);
END;
/

GETPARM

Return parameter string values:

SNAPSHOT_NAME	0
CONTROL_FILE	1
DBF_CONVERT	2
LOG_CONVERT	3
SPFILE_DEFAULT	4
INCR_NOCT	5
CFAUTO_DISK_DEFAULT	6
CFAUTO_TAPE_DEFAULT	7
FORMAT_DEFAULT	8
FULL_NOOPTIM	9
PLATFORM_ID	10
TRACE_FILENAME	11
PASSWORD_FILENAME	12

dbms_backup_restore.getparam(
parmid IN BINARY_INTEGER,
parmno IN BINARY_INTEGER DEFAULT NULL)
RETURN VARCHAR2;

set serveroutput on

DECLARE
l_parm VARCHAR2(500);
BEGIN
FOR i IN 1..20 LOOP
    l_parm := dbms_backup_restore.getparm(i);

    IF LENGTH(l_parm) > 0 THEN
      dbms_output.put_line(l_parm);
    END IF;
END LOOP;
END;
/

GETTSNAMEFROMDATAFILECOPY

Obtains the tablespace name to which this datafilecopy belonged

dbms_backup_restore.gettsnamefromdatafilecopy(
fname IN VARCHAR2,
fno IN NUMBER)
RETURN VARCHAR2;

TBD

INCRARCHIVEDLOGBACKUPCOUNT

Called to increment BACKUP_COUNT column V$ARCHIVED_LOG.

dbms_backup_restore.incrarchivedlogbackupcount(
fname        IN VARCHAR2,
thread       OUT NUMBER,
sequence     OUT NUMBER,
first_change OUT NUMBER,
all_logs     IN BOOLEAN DEFAULT TRUE);

TBD

INCREMENTRECORDSTAMP

Increment record stamp for given record type.

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

TBD

INITMSB

Initialize multi-section backup processing for the specified file.

dbms_backup_restore.initmsb(
dfnumber IN NUMBER,
file_size OUT NUMBER,
set_stamp OUT NUMBER,
set_count OUT NUMBER);

TBD

INITMSR

Initialize file for multi-section full restore

dbms_backup_restore.initmsr(dfnumber IN number, fname OUT VARCHAR2);

TBD

INITNAMESPACE

Used for testing to create locations because oratst doesn't support creating locations with uppercase. It initializes controlfile, logfile and datafile locations for db_create_file_dest

dbms_backup_restore.initnamespace;

exec dbms_backup_restore.initnamespace;

INSPECTARCHIVEDLOG

Reads the header from an archived redo log and constructs a record in the controlfile as if the file had just been archived or created via copyArchivedLog.

Overload 1

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

TBD

Overload 2

dbms_backup_restore.inspectarchivedlog(
fname      IN VARCHAR2,
full_name OUT VARCHAR2,
recid      OUT NUMBER,
stamp      OUT NUMBER,
change_rdi IN BOOLEAN);

TBD

INSPECTARCHIVEDLOGSEQ

Undocumented

Overload 1

dbms_backup_restore.inspetarchivedlogseq(
log_dest IN VARCHAR2,
format IN VARCHAR2 DEFAULT NULL,
thread IN BINARY_INTEGER,
sequence IN NUMBER,
full_name OUT VARCHAR2 );

TBD

Overload 2

dbms_backup_restore.inspectarchivedlogseq(
log_dest     IN VARCHAR2,
format       IN VARCHAR2 DEFAULT NULL,
thread       IN BINARY_INTEGER,
sequence     IN NUMBER,
full_name    OUT VARCHAR2,
resetlogs_id IN NUMBER);

TBD

INSPECTBACKUPPIECE

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.

dbms_backup_restore.inspectdatafilecopy(
fname     IN VARCHAR2,
full_name OUT VARCHAR2,
recid     OUT NUMBER,
stamp     OUT NUMBER,
tag       IN VARCHAR2 DEFAULT NULL,
isbackup IN BOOLEAN DEFAULT FALSE);

TBD

IR_ICD_FINISH

called at end of DBMS_IR interface. It is same as icdFinish in prvtbkrs.pls that sets the current RPC count as FINISHED in v$session.action.

dbms_backup_restore.ir_icd_finish;

exec dbms_backup_restore.ir_icd_finish;

IR_ICD_START

called at begining of DBMS_IR interface. It is same as icdStart in prvtbkrs.pls that increments the RPC count and sets the
v$session.action field to STARTED.

dbms_backup_restore.ir_icd_start(fn IN NUMBER);

TBD

ISFILENAMEOMFRESTOREDATABASE

Does the filename belongs to an OMF family?

Overload 1

dbms_backup_restore.isfilenameomf(
fname IN VARCHAR2,
isOMF OUT BOOLEAN,
isASM OUT BOOLEAN);

TBD

Overload 2

dbms_backup_restore.isfilenameomf(
fname   IN VARCHAR2,
isOMF   OUT BOOLEAN,
isASM   OUT BOOLEAN,
isTMPLT OUT BOOLEAN);

TBD

MANAGEAUXINSTANCE

used by RMAN to manage the auxiliary instance for those OSs that require OS setup.

dbms_backup_restore.manageauxinstance(
orasid IN VARCHAR2,
cleanup IN BINARY_INTEGER);

TBD

NETWORKFILETRANSFER

Undocumented

dbms_backup_restore.networkfiletransfer(
dbname    IN VARCHAR2,
username IN VARCHAR2 DEFAULT NULL,
passwd    IN VARCHAR2 DEFAULT NULL,
srcfile   IN VARCHAR2,
destfile IN VARCHAR2,
operation IN VARCHAR2)
RETURN BOOLEAN;

TBD

NIDBEGIN

Undocumented

dbms_backup_restore.nidbegin(
newdbname IN VARCHAR2,
olddbname IN VARCHAR2,
newdbid IN NUMBER,
olddbid IN NUMBER,
dorevert IN BINARY_INTEGER,
dorestart IN BINARY_INTEGER,
events IN NUMBER);

TBD

NIDEND

Undocumented

dbms_backup_restore.nidend;

TBD

NIDGETNEWDBID

Undocumented

dbms_backup_restore.nidgetnewdbid(dbname IN VARCHAR2, ndbid OUT NUMBER);

TBD

NIDPROCESSCF

Undocumented

dbms_backup_restore.nidprocesscf(
chgdbid OUT BINARY_INTEGER,
chgdbname OUT BINARY_INTEGER);

TBD

NIDPROCESSDF

Undocumented

dbms_backup_restore.nidprocessdf(
fno       IN NUMBER,
istemp    IN BINARY_INTEGER,
skipped   OUT BINARY_INTEGER,
chgdbid   OUT BINARY_INTEGER,
chgdbname OUT BINARY_INTEGER);

TBD

NORMALIZEFILENAME

Normalizes the file name according to the rules of the target database and returns the normalized filename

dbms_backup_restore.normalizeFileName(fname IN VARCHAR2) RETURN VARCHAR2;

SELECT dbms_backup_restore.normalizefilename('test.dbf')
FROM dual;

ORACLESBTVERSION

Checks if our SBT tape channel is using Oracle Backup. If so, sets isOracle to TRUE and returns the version number as a text string in the form of "AAA.BBB.CCC.DDD".

dbms_backup_restore.oraclesbtversion(
isOracle OUT BOOLEAN,
version OUT VARCHAR2);

TBD

PIECECONTEXTGETNUMBER

Gets a numeric value from the backup piece context

dbms_backup_restore.piececontextgetnumber(
parmid IN BINARY_INTEGER,
value OUT BINARY_INTEGER);

TBD

PROCESSSEARCHFILETABLE

Reads header for all files from search file table (X$KRBMSFT)

Overload 1

dbms_backup_restore.processsearchfiletable(
catalog IN BOOLEAN, -- TRUE = try to catalog search result
implicit IN BINARY_INTEGER);

TBD

Overload 2

dbms_backup_restore.

TBD

PROXYBACKUPARCHIVEDLOG

Specifies one archived log to be backed up during a proxy copy session.

dbms_backup_restore.proxybackuparchivedlog(
arch_recid IN NUMBER,
arch_stamp IN NUMBER,
handle IN VARCHAR2);

TBD

PROXYBACKUPCONTROLFILE

Specifies one controlfile to be backed up with proxy copy.

dbms_backup_restore.proxybackupcontrolfile(
name IN VARCHAR2 DEFAULT NULL,
handle IN VARCHAR2);

TBD

PROXYBACKUPDATAFILE

Specifies one datafile to be backed up during a proxy copy session.

dbms_backup_restore.proxybackupdatafile(
file# IN BINARY_INTEGER,
handle IN VARCHAR2);

TBD

PROXYBACKUPDATAFILECOPY

Specifies one datafile copy to be backed up during a proxy copy session.

dbms_backup_restore.proxybackupdatafilecopy(
copy_recid IN NUMBER,
copy_stamp IN NUMBER,
handle IN VARCHAR2);

TBD

PROXYBEGINBACKUP

Begin a proxy backup session. The database must be mounted for proxy
backups, so that the backups can be recorded in the controlfile.

Overload 1

dbms_backup_restore.proxybeginbackup(
tag         IN VARCHAR2       DEFAULT NULL,
incremental IN BOOLEAN        DEFAULT FALSE,
media_pool IN BINARY_INTEGER DEFAULT 0,
set_stamp   OUT NUMBER,
set_count   OUT NUMBER);

TBD

Overload 2

dbms_backup_restore.proxybeginbackup(
tag          IN VARCHAR2 DEFAULT NULL,
incremental IN BOOLEAN DEFAULT FALSE,
media_pool   IN BINARY_INTEGER DEFAULT 0,
set_stamp    OUT NUMBER,
set_count    OUT NUMBER,
keep_options IN BINARY_INTEGER,
keep_until   IN NUMBER);

TBD

PROXYBEGINRESTORE

Begin a proxy restore session.

Overload 1

dbms_backup_restore.proxybeginrestore(destination IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2

dbms_backup_restore.proxybeginrestore(
destination IN VARCHAR2 DEFAULT NULL,
cleanup IN BOOLEAN);

TBD

PROXYCANCEL

Ends the proxy conversation

dbms_backup_restore.proxycancel;

exec dbms_backup_restore.proxycancel;

PROXYCHANGE

Undocumented

Overload 1

dbms_backup_restore.proxychange(
recid IN NUMBER,
stamp IN NUMBER,
handle IN VARCHAR2,
status IN VARCHAR2, -- 'D','A','U','X'
params IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2

dbms_backup_restore.proxychange(
recid        IN NUMBER,
stamp        IN NUMBER,
handle       IN VARCHAR2,
status       IN VARCHAR2, -- 'D','A','U','X','K'
params       IN VARCHAR2 DEFAULT NULL,
keep_options IN BINARY_INTEGER,
keep_until   IN NUMBER);

TBD

Overload 3

TBD

PROXYDELETE

Change proxy delete from the storage subsystem, or validate that a proxy backup exists in the storage subsystem.

Overload 1

dbms_backup_restore.proxydelete(
recid IN NUMBER,
stamp IN NUMBER,
handle IN VARCHAR2,
params IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2

dbms_backup_restore.proxydelete(
recid IN NUMBER,
stamp IN NUMBER,
handle IN VARCHAR2,
params IN VARCHAR2 DEFAULT NULL,
force IN BINARY_INTEGER);

TBD

PROXYGO

Called after all the files have been named. Does not return until the proxy copy is complete. All of the data movement is performed here.

dbms_backup_restore.proxygo;

exec dbms_backup_restore.proxygo;

PROXYQUERYBACKUP

Checks to see if the file can be backed up using proxy copy.

dbms_backup_restore.proxyquerybackup(name in VARCHAR2)
RETURN BINARY_INTEGER;

TBD

PROXYQUERYRESTORE

Determines whether the indicated datafile can be restored from the specified proxy backup file.

dbms_backup_restore.proxyqueryrestore(
handle IN VARCHAR2,
toname IN VARCHAR2)
RETURN BINARY_INTEGER;

TBD

PROXYRESTOREARCHIVEDLOG

Specifies one archived log to be restored during a proxy session.

Overload 1

dbms_backup_restore.proxyrestorearchivedlog(
handle IN VARCHAR2,
thread IN BINARY_INTEGER,
sequence IN NUMBER);

TBD

Overload 2

dbms_backup_restore.proxyrestorearchivedlog(
handle       IN VARCHAR2,
thread       IN BINARY_INTEGER,
sequence     IN NUMBER,
resetlogs_id IN NUMBER,
blksize      IN BINARY_INTEGER,
blocks       IN NUMBER);

TBD

PROXYRESTORECONTROLFILE

Names a controlfile to be restored with proxy copy.

Overload 1

dbms_backup_restore.proxyrestorecontrolfile(
handle IN VARCHAR2,
toname IN VARCHAR2);

TBD

Overload 2

dbms_backup_restore.proxyrestorecontrolfile(
handle IN VARCHAR2,
toname IN VARCHAR2,
blksize IN BINARY_INTEGER,
blocks IN NUMBER);

TBD

PROXYRESTOREDATAFILE

Specifies one datafile to be restored during a proxy session.

Overload 1

dbms_backup_restore.proxyrestoredatafile(
handle IN VARCHAR2,
file# IN BINARY_INTEGER,
toname IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2

dbms_backup_restore.proxyrestoredatafile(
handle IN VARCHAR2,
file# IN BINARY_INTEGER,
toname IN VARCHAR2 DEFAULT NULL,
tsname IN VARCHAR2,
blksize IN BINARY_INTEGER,
blocks IN NUMBER);

TBD

PROXYVALIDATE

Change proxy backup statusfrom the storage subsystem, or validate that a proxy backup exists in the storage subsystem.

Changes status in the controlfile to 'A' or 'X' appropriately.

dbms_backup_restore.proxyvalidate(
recid IN NUMBER,
stamp IN NUMBER,
handle IN VARCHAR2,
params IN VARCHAR2 DEFAULT NULL)
RETURN BINARY_INTEGER;

TBD

PROXYVALONLY

Same as proxyValidate, except that it does not change the status in the controlfile, it just validates.

dbms_backup_restore.proxyvalonly(
recid IN NUMBER,
stamp IN NUMBER,
handle IN VARCHAR2,
params IN VARCHAR2 DEFAULT NULL)
RETURN BINARY_INTEGER;

TBD

READARCHIVEDLOGHEADER

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.

dbms_backup_restore.remotesqlexecute(
source_dbuname IN VARCHAR2,
source_cs IN VARCHAR2,
stmt IN VARCHAR2)
RETURN VARCHAR2;

TBD

RENORMALIZEALLFILENAMES

Undocumented

dbms_backup_restore.reNormalizeAllFileNames;

exec reNormalizeAllFileNames;

RESDATAFILECOPY

A special version of copyDataFileCopy, but is used when
performing a duplicate, in this case, there is no controlfile at the duplicate.

Overload 1

dbms_backup_restore.resdatafilecopy(
cname         IN VARCHAR2,
fname         IN VARCHAR2,
full_name     OUT VARCHAR2,
max_corrupt   IN BINARY_INTEGER DEFAULT 0,
check_logical IN BOOLEAN,
blksize       IN BINARY_INTEGER,
blocks        IN BINARY_INTEGER,
fno           IN BINARY_INTEGER,
scnstr        IN VARCHAR2,
rfno          IN BINARY_INTEGER);

TBD

Overload 2

TBD

RESETCFILESECTION

This procedure attempts to reset the circular controlfile section.

dbms_backup_restore.resetcfilesection(
record_type IN BINARY_INTEGER);

TBD

RESETCONFIG

Deletes all RMAN configurations

dbms_backup_restore.resetconfig;

exec dbms_backup_restore.resetconfig;

RESETDATABASE

Change the recovery destination incarnation.

dbms_backup_resetdatabase(dbinc_key IN NUMBER);

TBD

RESTOREARCHIVEDLOG

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.

dbms_backup_restore.restorearchivedlog(
thread IN BINARY_INTEGER,
sequence IN NUMBER);

TBD

RESTOREARCHIVEDLOGRANGE

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.

Overload 1

dbms_backup_restore.restorebackuppiece(
handle   IN VARCHAR2,
done     OUT BOOLEAN,
params   IN VARCHAR2 DEFAULT NULL,
fromdisk IN BOOLEAN DEFAULT FALSE);

TBD

Overload 2

dbms_backup_restore.restorebackuppiece(
done      OUT BOOLEAN,
params    IN VARCHAR2 DEFAULT NULL,
outhandle OUT VARCHAR2,
outtag    OUT VARCHAR2,
failover OUT BOOLEAN);

TBD

RESTORECANCEL

Aborts a restore conversation

Overload 1

dbms_backup_restore.restorecancel;

exec dbms_backup_restore.restorecancel;

Overload 2

dbms_backup_restore.restorecancel(check_files IN BOOLEAN);

exec dbms_backup_restore.restorecancel(TRUE);

RESTORECONTROLEFILETO

Copies the controlfile from the backup set to an operating system file. If the database is mounted, the name must NOT match any of the current controlfiles.

Overload 1

dbms_backup_restore.restorecontrolfileto(cfname IN VARCHAR2);

TBD

Overload 2

dbms_backup_restore.restorecontrolfileto(
cfname IN VARCHAR2,
isstby IN BOOLEAN);

TBD

RESTOREDATAFILETO

Creates the output file from a complete backup in the backup set

Overload 1

dbms_backup_restore.restoredatafileto(
dfNUMBER IN BINARY_INTEGER,
toname IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2

dbms_backup_restore.restoredatafileto(
dfNUMBER IN BINARY_INTEGER,
toname IN VARCHAR2 DEFAULT NULL,
max_corrupt IN BINARY_INTEGER);

TBD

Overload 3

dbms_backup_restore.restoredatafileto(
dfNUMBER    IN BINARY_INTEGER,
toname      IN VARCHAR2 DEFAULT NULL,
max_corrupt IN BINARY_INTEGER,
tsname      IN VARCHAR2);

set echo off;
set serveroutput on;

DECLARE
omfname VARCHAR2(512) := NULL;
done    BOOLEAN;
devname VARCHAR2(255);
BEGIN
dbms_output.put_line(' ');
dbms_output.put_line(' Allocating device.... ');
dbms_output.put_line(' Specifying datafiles... ');

devname := dbms_backup_restore.deviceAllocate;

dbms_output.put_line(' Specifing datafiles... ');

dbms_backup_restore.restoreSetDataFile;
dbms_backup_restore.restoreDataFileTo(1,
'c:\oracle\product\oradata\orabase\SYSTEM01.DBF', 0, 'SYSTEM');
dbms_backup_restore.restoreDataFileTo(2,
'c:\oracle\product\oradata\orabase\SYSAUX01.DBF', 0, 'SYSAUX');
dbms_backup_restore.restoreDataFileTo(3,
'c:\oracle\product\oradata\orabase\UNDOTBS01.DBF', 0, 'UNDOTBS1');
dbms_backup_restore.restoreDataFileTo(4,
'c:\oracle\product\oradata\orabase\USERS01.DBF', 0, 'USERS');

dbms_output.put_line(' Restoring ... ');

dbms_backup_restore.restoreBackupPiece(
'c:\oracle\product .1.0\db_1\assistants\dbca emplates\Seed_Database.dfb', done);

IF done THEN
    dbms_output.put_line(' Restore done.');
ELSE
    dbms_output.put_line(' ORA-XXXX: Restore failed ');
END IF;

dbms_backup_restore.deviceDeallocate;
END;
/

RESTORESETARCHIVEDLOG

Begins a conversation that will restore archived redo logs so that they can be applied by recovery

Overload 1

dbms_backup_restore.restoresetarchivedlog(
destination IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2

dbms_backup_restore.restoresetarchivedlog(
destination IN VARCHAR2 DEFAULT NULL,
cleanup IN BOOLEAN);

TBD

RESTORESETDATAFILE

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

TBD

RESTORESPFILETO

Copies the SPFILE from the backup set to an operating system file.

dbms_backup_restore.restorespfileto(
pfname IN VARCHAR2 DEFAULT NULL,
sfname IN VARCHAR2 DEFAULT NULL);

TBD

RESTORESTATUS

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

RESTORE_NO_CONVERSATION CONSTANT BINARY_INTEGER := 0;
RESTORE_NAMING_FILES    CONSTANT BINARY_INTEGER := 1;
RESTORE_PIECE_READ      CONSTANT BINARY_INTEGER := 2;
RESTORE_PIECE_RETRY     CONSTANT BINARY_INTEGER := 3;

set serveroutput on

DECLARE
stt BINARY_INTEGER;
pno BINARY_INTEGER;
fil BINARY_INTEGER;
dfs BOOLEAN;
inc BOOLEAN;
dev BOOLEAN;
BEGIN
dbms_backup_restore.restorestatus(stt, pno, fil, dfs, inc, dev);

dbms_output.put_line(stt);
dbms_output.put_line(pno);
dbms_output.put_line(fil);
END;
/

RESTOREVALIDATE

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.

dbms_backup_restore.restorevalidate;

-- After the conversation is complete, a report is written to an
-- trace file, giving the status of all the files in the backup set.
--
-- Restore Conversation File Status Report
-- File Start Finish OK Name
-- ----- ----- ------ -- --------------------
--     2     Y      Y Y
--     4     Y      Y Y
--     6     Y      Y Y
--     3     Y      Y Y
--     5     Y      Y Y

exec dbms_backup_restore.restorevalidate;

SCANARCHIVEDLOG

Scans a file and verifies the checksum (if present) in each block

dbms_backup_restore.scanarchivedlog(
recid IN NUMBER,
stamp IN NUMBER);

TBD

SCANDATAFILE

Scans a file and verifies the checksum (if present) in each block

Overload 1

dbms_backup_restore.scanDataFile(
dfNUMBER         IN BINARY_INTEGER,
max_corrupt      IN BINARY_INTEGER DEFAULT 0,
update_fuzziness IN BOOLEAN        DEFAULT TRUE)
RETURN NUMBER;

TBD

Overload 2

dbms_backup_restore.scandatafile(
dfNUMBER         IN BINARY_INTEGER,
max_corrupt      IN BINARY_INTEGER DEFAULT 0,
update_fuzziness IN BOOLEAN        DEFAULT TRUE,
check_logical    IN BOOLEAN)
RETURN NUMBER;

TBD

SCANDATAFILECOPY

Scans a file and verifies the checksum (if present) in each block

Overload 1

dbms_backup_restore.scanDataFileCopy(
recid            IN NUMBER,
stamp            IN NUMBER,
max_corrupt      IN BINARY_INTEGER DEFAULT 0,
isbackup         IN BOOLEAN DEFAULT FALSE,
update_fuzziness IN BOOLEAN DEFAULT TRUE)
RETURN NUMBER;

TBD

Overload 2

dbms_backup_restore.scandatafilecopy(
recid            IN NUMBER,
stamp            IN NUMBER,
max_corrupt      IN BINARY_INTEGER DEFAULT 0,
isbackup         IN BOOLEAN        DEFAULT FALSE,
update_fuzziness IN BOOLEAN        DEFAULT TRUE,
check_logical    IN BOOLEAN)
RETURN NUMBER;

TBD

SEARCHFILES

Populates X$KRBMSFT with list files that match the specified pattern.

dbms_backup_restore.searchfiles(
pattern IN OUT VARCHAR2,
ns      IN OUT VARCHAR2,
ccf     IN     BOOLEAN DEFAULT FALSE,
omf     IN     BOOLEAN DEFAULT FALSE,
ftype   IN     VARCHAR2 DEFAULT NULL);

TBD

SETCONFIG

Saves configuration parameters. Sets the RMAN configuration.

dbms_backup_restore.setconfig(
name IN VARCHAR2,
value IN VARCHAR2 DEFAULT NULL)
RETURN BINARY_INTEGER;

TBD

SETDATAFILEAUX

Sets an auxiliary filename

dbms_backup_restore.setdatafileaux(
dfNUMBER IN BINARY_INTEGER,
fname IN VARCHAR2 DEFAULT NULL);

TBD

SETLIMIT

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

TBD

SETPARMS

Undocumented

dbms_backup_restore.setparms(
p0 IN NUMBER   DEFAULT NULL,
p1 IN NUMBER   DEFAULT NULL,
p2 IN NUMBER   DEFAULT NULL,
p3 IN NUMBER   DEFAULT NULL,
p4 IN NUMBER   DEFAULT NULL,
p5 IN VARCHAR2 DEFAULT NULL,
p6 IN VARCHAR2 DEFAULT NULL,
p7 IN VARCHAR2 DEFAULT NULL,
p8 IN VARCHAR2 DEFAULT NULL,
p9 IN VARCHAR2 DEFAULT NULL);

TBD

SETRMANSTATUSROWID

By calling this function all opeartion by this foreground will be associated with a V$RMAN_STATUS row.

dbms_backup_restore.setrmanstatusrowid(
rsid IN NUMBER,
rsts IN NUMBER);

TBD

SETTABLESPACEATTR

Undocumented

dbms_backup_restore.settablespaceattr(
code IN NUMBER,
tsid IN BINARY_INTEGER,
clear IN BINARY_INTEGER,
onoff IN BINARY_INTEGER);

TBD

SETTABLESPACEEXCLUDE

Sets a tablespace "excluded from backup" flag

dbms_backup_restore.settablespaceexclude(
tsid IN BINARY_INTEGER,
flag IN BINARY_INTEGER);

TBD

SET_CHARSET

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.

Overload 1

dbms_backup_restore.switchtocopy(
copy_recid IN NUMBER,
copy_stamp IN NUMBER);

TBD

Overload 2

dbms_backup_restore.switchtocopy(
copy_recid IN NUMBER,
copy_stamp IN NUMBER,
catalog IN BOOLEAN);

TBD

TRANSPORTDBLOCK

Sets a lock on transportable db context The name of the new database to be created on the target platform can be passed to transportable db context, too.

dbms_backup_restore.transportdblock(
newdbname IN VARCHAR2 DEFAULT NULL);

TBD

TRANSPORTDBUNLOCK

Frees the lock on transportable db context

dbms_backup_restore.transportdbunlock;

exec dbms_backup_restore.transportdbunlock;

UPDATEHEADERS

called by RMAN when datafile headers of locally managed datafiles need to be updated after the database compatibility
has been upgraded to 10.2 or above.

dbms_backup_restore.updateheaders RETURN BOOLEAN;

TBD

UPDATERMASTATUSROW

Updates a row in the V$RMAN_STATUS view. The function will update the status of the row in the SGA.

dbms_backup_restore.updatermanstatusrow(
row_id IN NUMBER,
row_stamp IN NUMBER,
status IN BINARY_INTEGER);

TBD

VALIDATEARCHIVEDLOG

Validates the correctness of the information in the recovery catalog and the controlfile regarding an archived log.

Overload 1

dbms_backup_restore.validatearchivedlog(
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)
RETURN BINARY_INTEGER;

TBD

Overload 2

TBD

Overload 3

TBD

Overload 4

TBD

VALIDATEBACKUPPIECE

Validates the correctness of the informationv in the recovery catalog and the controlfile regarding a backup piece.

Overload 1

dbms_backup_restore.validatebackuppiece(
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)
RETURN BINARY_INTEGER;

TBD

Overload 2

dbms_backup_restore.validatebackuppiece(
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,
hdl_isdisk IN BINARY_INTEGER)
RETURN BINARY_INTEGER;

TBD

Overload 3

dbms_backup_restore.validatebackuppiece(
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,
hdl_isdisk IN BINARY_INTEGER,
media      OUT VARCHAR2)
RETURN BINARY_INTEGER;

TBD

VALIDATEBLOCK

Adds the specified block range to the backup context for validation.

dbms_backup_restore.validateblock(
blockRangeTable IN blockRangeTable_t);

TBD

VALIDATEDATAFILECOPY

Validates the correctness of the information in the recovery catalog and the controlfile regarding a datafile copy.

Overload 1

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

TBD

Overload 2

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

TBD

VALIDATETABLESPACE

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

dbms_backup_restore.validatetablespace(
tsid IN BINARY_INTEGER,
cSCN IN NUMBER)
RETURN BINARY_INTEGER;

HERE

VALIDATIONADDPIECE

Adds a backup piece to the list of pieces to validate.

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

HERE

VALIDATIONEND

This procedure ends the restore conversation.

dbms_backup_restore.validationend;

exec dbms_backup_restore.validationend;

VALIDATIONNEXTRESULT

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

set echo off;
set serveroutput on;
SELECT TO_CHAR(systimestamp,'YYYYMMDD HH:MI:SS') FROM dual;
variable devicename varchar2(255);

DECLARE
omfname VARCHAR2(512) := NULL;
done    BOOLEAN;
BEGIN
dbms_output.put_line(' ');
dbms_output.put_line(' Allocating device.... ');
dbms_output.put_line(' Specifying datafiles... ');

:devicename := dbms_backup_restore.deviceAllocate;

dbms_output.put_line(' Specifing datafiles... ');

dbms_backup_restore.restoreSetDataFile;
dbms_backup_restore.restoreDataFileTo(1, 'C:\oracle\product\oradata\orabase\SYSTEM01.DBF', 0, 'SYSTEM');

dbms_backup_restore.restoreDataFileTo(2, 'C:\oracle\product\oradata\orabase\UNDOTBS01.DBF', 0, 'UNDOTBS1');

dbms_backup_restore.restoreDataFileTo(3, 'C:\oracle\product\oradata\orabase\SYSAUX01.DBF', 0, 'SYSAUX');

dbms_backup_restore.restoreDataFileTo(4, 'C:\oracle\product\oradata\orabase\USERS01.DBF', 0, 'USERS');

dbms_output.put_line(' Restoring ... ');

dbms_backup_restore.restoreBackupPiece( 'C:\oracle\product\ora102\assistants\dbca emplates\Seed_Database.dfb', done);

IF done THEN
    dbms_output.put_line(' Restore done.');
ELSE
    dbms_output.put_line(' ORA-XXXX: Restore failed ');
END IF;

dbms_backup_restore.deviceDeallocate;
END;
/

SELECT TO_CHAR(systimestamp,'YYYYMMDD HH:MI:SS') FROM dual;

-----