CATALOG

Syntax

catalog::=

Text description of catalog

Purpose

Use the CATALOG command to do the following:

Add metadata about a user-managed datafile copy, control file copy, archived log or backup piece to the RMAN repository.
Record a datafile copy as a level 0 incremental backup in the RMAN repository, which enables you to use it as part of an incremental backup strategy.
Record the existence of the last user-managed datafile copies made after the final shutdown in Oracle7, before migrating the database to Oracle8.

See Also:
Oracle Database Backup and Recovery Basics to learn how to manage target database records stored in the catalog

Restrictions and Usage Notes

You must be connected to the target database, which must be mounted or open.
If RMAN is connected to a recovery catalog, then the catalog database must be open.
For a user-managed copy to be cataloged, it must be:
- Accessible on disk.
- A datafile copy, control file copy, archived log, or backup piece.
RMAN treats all user-managed backups as image copies. Note that during cataloging, RMAN does not check whether the file was correctly copied by the operating system utility: it just checks the header.
You cannot catalog any datafile copies that were created in Oracle7 unless they were made after the final consistent shutdown in Oracle7 and before running the migration utility, or were made of a tablespace that was offline normal or read-only at the time of the migration. In other words, no Oracle7 archived logs must need to be applied to the backups to roll them forward.
You cannot use CATALOG to catalog a file that belongs to a different database.
You cannot use CATALOG to catalog a backup piece that exists on an sbt device.

Keywords and Parameters

Syntax Element	Description
`ARCHIVELOG` `'``filename``'`	Specifies the filename of an archived log to be added to or updated in the RMAN repository.
`BACKUPPIECE`	Specifies the name of a backup piece to be added to the RMAN repository. The backup piece must be on disk. RMAN verifies the backup piece header before cataloging it. RMAN can catalog a backup piece from a prior incarnation. Typically, you would catalog a backup piece in the following situations: You have copied a backup piece with an operating system utility. In this case, the original backup piece is cataloged but the piece copy is not. You want to move a backup piece from one disk to another under a different absolute filename. You run in `NOCATALOG` mode and must re-create the control file, thereby losing all RMAN metadata. If you specify a list of backup pieces, RMAN catalogs all pieces in the given list even if one of them fails. Cataloging a backup piece creates a new row in `V$BACKUP_PIECE`. A backup set is only usable when all backup pieces are cataloged. Otherwise it would be in partially available state. Note: When cataloging backup pieces from releases prior to Oracle9i, performance improves when you catalog higher copy numbers first. For example, if you need to catalog copies 1, 2, and 3 of a backup piece, then specify copy 3 as the first item in the `CATALOG` list.
`CONTROLFILECOPY` `'``filename``'`	Specifies the filename of a control file copy to be added to or updated in the RMAN repository. The control file copy can be: A copy of a normal control file (that is, not a standby control file) created with the RMAN command `BACKUP` `AS` `COPY` `CURRENT CONTROLFILE` command or the SQL statement `ALTER` `DATABASE` `BACKUP` `CONTROLFILE` A standby control file copy created with the RMAN command `BACKUP` `AS` `COPY STANDBY CONTROLFILE` or the SQL statement `ALTER` `DATABASE` `CREATE` `STANDBY` `CONTROLFILE`
`DATAFILECOPY` `'``filename``'`	Specifies the filename of a datafile copy to be added to or updated in the RMAN repository.
`LEVEL` `=` 0	For datafile copies only, indicates that the copy should be recorded as a level 0 incremental backup. You can perform incremental backups by using this datafile copy as the base level 0 backup.
`(RECOVERY AREA \|`DB_RECOVERY_FILE_DEST) [ NOPROMPT ]	Catalogs all valid backup sets, datafile copies, and archived redo logs in the flash recovery area. RMAN must be connected to the target database and the target database must be mounted or open. Specify `NOPROMPT` if you do not want to be prompted after every match. The keywords `RECOVERY AREA` and `DB_RECOVERY_FILE_DEST` are exact synonyms.
`START WITH` `'``string_pattern``'` `[ NOPROMPT ]`	Catalogs all valid backups in the specified location, which can be an Automatic Storage Management disk group, Oracle Managed Files directory, or part of a filename. RMAN will report any files in the disk location that cannot be cataloged. RMAN must be connected to the target database and the target database must be mounted. Specify `NOPROMPT` if you do not want to be prompted after every match. If the string pattern specifies a filename, then it matches the left part of the filename pattern. For example, `/tmp/arc` matches everything in directory `/tmp/arc_dest` and `/tmp/archive/january` as well as a file `/tmp/arc.cpy`. Note: You cannot use wildcard characters.

Examples

Cataloging an Archived Redo Log: Example

This example assumes that you made operating system copies of archived logs or transferred them from another location, and then added them to the RMAN repository:

CATALOG ARCHIVELOG '?/oradata/archive1_30.dbf', '?/oradata/archive1_31.dbf', 
                   '?/oradata/archive1_32.dbf';

Cataloging a File Copy as an Incremental Backup: Example

The following example catalogs datafile copy users01.bak as an incremental level 0 backup:

CATALOG DATAFILECOPY '?/oradata/users01.bak' LEVEL 0;

Note that you can create datafile copies both with the RMAN BACKUP AS COPY command and by using operating system utilities in conjunction with ALTER TABLESPACE BEGIN/END BACKUP.

Cataloging Multiple Copies in a Directory: Example

The following example catalogs a directory full of archived logs that were copied into the /tmp/arch_logs directory with an operating system utility:

CATALOG START WITH '/tmp/arch_logs';

Cataloging File in the Flash Recovery Area: Example

The following example catalogs all files in the currently enabled flash recovery area without prompting the user for each one:

CATALOG RECOVERY AREA NOPROMPT;

Cataloging Backup Pieces: Example

The following example catalogs a backup piece that was copied with an operating system utility:

CATALOG BACKUPPIECE '?/oradata/01dmsbj4_1_1.bcp';