Skip Headers
Oracle® Warehouse Builder OMB*Plus Command Reference
11g Release 2 (11.2)

Part Number E14406-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
 

OMBCREATE SNAPSHOT

Purpose

To create a snapshot of a component.

Prerequisites

Component on which snapshot is to be created should already exist. This command can be executed for any component regardless of current context.

Syntax

parseCreateCommand =  OMBCREATE "createSnapshotCommand"
     createSnapshotCommand =  ( SNAPSHOT "QUOTED_STRING" [ WITH DEPENDEE_DEPTH (
           MAX | "INTEGER_LITERAL" ) ] [ SET "setPropertiesClause" ] 
          "addSnapshotFCOClauses" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     addSnapshotFCOClauses =  ( ADD "objectClause" )+
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     objectClause =  "UNQUOTED_STRING" "QUOTED_STRING" [ CASCADE | NO CASCADE ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

parseCreateCommand

Root production for OMBCREATE SNAPSHOT.

createSnapshotCommand

Clause for creating snapshots.

QUOTED_STRING

Name of the snapshot to be created.

DEPENDEE_DEPTH

Use this optional clause to include in the snapshot all dependees for each component in the command.

setPropertiesClause

Optional clause to set the properties of a snapshot. This includes the description and the type of the snapshot.

getPropertiesClause

Basic properties for SNAPSHOT: 

Name: TYPE
Type: STRING(200)
Valid Values: FULL,SIGNATURE
Default: FULL
This is the type of snapshot 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the snapshot

PROPERTIES

Valid set of properties are DESCRIPTION and TYPE

VALUES

Values for the corresponding properties. Default values of properties for DESCRIPTION is null and valid values for TYPE are FULL or SIGNATURE

addSnapshotFCOClauses

Components to be added to the snapshot

propertyNameList

Property names for SNAPSHOT.

propertyValueList

List of property values for SNAPSHOT.

objectClause

Component to be added to the snapshot

UNQUOTED_STRING

Type of the component to be added to the snapshot

QUOTED_STRING

Absolute or relative path name of the component to be added to the snapshot

CASCADE

Cascade option for folder components. By default, any folder is snapshotted along with its contents. The NO CASCADE option allows the user to snapshot only the folder object itself along with its associated properties.

propertyValue

Allowable value types for a snapshot property.