CREATE SCRIPT

Syntax

Text description of the illustration createScript.gif

Purpose

To create a script and store it in the recovery catalog. Stored scripts provide a common repository for frequently executed collections of RMAN commands. Any command that is legal within a RUN command is permitted in the stored script. The script is not executed immediately; run the script with EXECUTE SCRIPT.

Restrictions and Usage Notes

Note the following restrictions:

• Execute CREATE SCRIPT only at the RMAN prompt.
• RMAN must be connected to a target database.
• RMAN must be connected to the recovery catalog either through the CATALOG command-line option or the CONNECT CATALOG command, and the catalog database must be open.
• You cannot run CREATE SCRIPT once and then use this same script on multiple target databases. You must connect to a specific target database and then run CREATE SCRIPT to create a script for this specific target. Each script is associated with one and only one target database.
• You cannot execute a RUN command within a stored script.
• The @ and @@ commands do not work within CREATE SCRIPT.
• Quotes must be used around the script name when the name contains either spaces or reserved words.

Keywords and Parameters

For descriptions of the individual commands that you can use in a stored script, refer to the appropriate entry, for example, "BACKUP".

Syntax Element	Description
'script_name'	Creates a stored script with the specified name. The statements allowable within the brackets of the CREATE SCRIPT 'script_name' { ... } command are the same allowable within the RUN command. The statements within the braces constitute the job_command_list. Note: To run the stored script, specify EXECUTE SCRIPT within the braces of the RUN command.

Example

Creating a Script: Example

The following UNIX shell script creates a recovery catalog script called b_whole_10 that backs up the database and archived redo logs, then executes b_whole_10:

#!/usr/bin/tcsh
rman TARGET / CATALOG rman/rman@catdb <<EOF
# creates recovery catalog script to back up database and archived logs
CREATE SCRIPT b_whole_l0 
{
    BACKUP INCREMENTAL LEVEL 0 TAG b_whole_l0 
    DATABASE PLUS ARCHIVELOG;
}
# runs the recovery catalog script b_whole_10
RUN { EXECUTE SCRIPT b_whole_10; }
EOF