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
Mobi · ePub

OMBRETRIEVE CUBE

Purpose

This command retrieves a Cube.

Prerequisites

Should be in Oracle Module context.

Syntax

retrieveCubeCommand =  OMBRETRIEVE CUBE "cubeName" ( GET ( PROPERTIES 
          "propertyKeyList" | "getReferenceIconSetClause" | MEASURES | 
          COMPOSITE_DIMENSION | DIMENSION_USES | IMPLEMENTED_OBJECT | PARTITION 
          ( LEVEL | HIERARCHY ) ) | GET AGGREGATE_FUNCTION | "measureLocator" 
          GET ( PROPERTIES "propertyKeyList" | IMPLEMENTED_OBJECT | 
          AGGREGATE_FUNCTIONS FOR DIMENSIONS "dimensionList" | PRECOMPUTE_LEVELS
           FOR DIMENSIONS "dimensionList" | CALCULATED_EXPRESSION ) | 
          "dimensionUseLocator" GET ( PROPERTIES "propertyKeyList" | ( REF | 
          REFERENCE ) ( DIMENSION | LEVEL | ROLE ) | IMPLEMENTED_OBJECT | 
          DIMENSION_USE_POSITION ) | "compositeDimensionLocator" GET ( REF | 
          REFERENCE ) DIMENSIONS )
     cubeName =  "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     measureLocator =  MEASURE "measureName"
     dimensionList =  "(" "dimension" { "," "dimension" } ")"
     dimensionUseLocator =  DIMENSION_USE "dimensionUseName"
     compositeDimensionLocator =  COMPOSITE_DIMENSION "compositeDimensionName"
     propertyKey =  "UNQUOTED_STRING"
     measureName =  "QUOTED_STRING"
     dimension =  "QUOTED_STRING"
     dimensionUseName =  "QUOTED_STRING"
     compositeDimensionName =  "QUOTED_STRING"

Parameters

retrieveCubeCommand

This clause retrives information about a CUBE and other details such as: PROPERTIES, MEASURES, COMPOSITE_DIMENSION, DIMENSION_USES, IMPLEMENTED_OBJECT, PARTITION, LEVEL, HIERARCHY, AGGREGATE_FUNCTION, AGGREGATE_FUNCTIONS, FOR, DIMENSIONS, PRECOMPUTE_LEVELS, CALCULATED_EXPRESSION, DIMENSION, ROLE, DIMENSION_USE_POSITION.

cubeName

The name of the cube in QUOTED_STRING.

propertyKeyList

The clause sets the list of property keys.

getReferenceIconSetClause

The clauses gets the reference ICONSET.

measureLocator

This clause finds the MEASURE.

dimensionList

This clause retrieves the dimension list.

dimensionUseLocator

The is retrieves DIMENSION_USE.

compositeDimensionLocator

This key locates the COMPOSITE_DIMENSION.

propertyKey

The name of property key in UNQUOTED_STRING.

propertyKey

Basic properties for CUBE, MEASURE and  DIMENSION_USE: 

Basic properties for CUBE :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Cube 

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

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false' 
Default: 'true' 
The dimension is visible to OLAP end user 

Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: 'true', 'false' 
Default: 'false' 
set the Unique Key constraint on the Business Key 

Name: STORAGE
Type: STRING
Valid Values: 'RELATIONAL', 'MOLAP' 
Default: 'RELATIONAL' 
The storage of a cube can be relational or molap

Name: AW_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Get the analytical workspace name where the cube is implemented 

Name: AW_CUBE_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Get the Analytical Workspace cube physical object name 

Name: USE_GLOBAL_INDEX
Type: STRING
Valid Values: 'true', 'false' 
Default: 'false' 
Gets the flag to say whether to generate a composite for measure partition combination

Name: BITMAP_INDEX
Type: STRING
Valid Values: 'true', 'false' 
Default: 'false' 
gets the flag to say whether to generate a bitmap for a cube

Name: SPARSITY_ULTRA_COMPRESS
Type: STRING
Valid Values: 'true', 'false' 
Default: 'false' 
Gets the flag to say whether its a compressed cube. Only valid for Molap cube.

Name: LOAD_POLICY_FOR_NULL_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_DIMENSION_RECORD' 
Default: 'NO_MAINTENANCE' 
Data policy for loading cube where OWB mapping code relies on 
database constraints to detect the orphans (null parent references). 
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent. 
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level. 
'REJECT', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and reject them. 
'DEFAULT_DIMENSION_RECORD', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: LOAD_POLICY_FOR_INVALID_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_DIMENSION_RECORD' 
Default: 'NO_MAINTENANCE' 
Data policy for loading cube where OWB mapping code relies on 
database constraints to detect the orphans (could contain a value that is not actually found in the parent). 
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent. 
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level. 
'REJECT', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and reject them. 
'DEFAULT_DIMENSION_RECORD', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

propertyKey

Basic properties for Measure :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Measure 

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

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false' 
Default: 'true' 
The measure is visible to OLAP end user 

Name: CALCULATED_MEASURE
Type: STRING
Valid Values: 'true', 'false' 
Default: 'false' 
Gets the measure to be aggregatable

Name: AUTO_SOLVE
Type: STRING
Valid Values: 'true', 'false' 
Default: 'false' 
gets the flag to say whether the measure is Auto Solve

Name: AW_MEASURE_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Get the Analytical Workspace measure physical object name 

Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH TIME ZONE, TIMESTAMP WITH LOCAL TIME ZONE, VARCHAR, VARCHAR2, XMLFORMAT 
Default: NUMBER 
Gets the datatype of a Cube Measure 

Name: SCALE
Type: NUMBER
Valid Values: -85 - 125
Default: 1
The scale of a number.

Name: LENGTH
Type: NUMBER
Valid Values: 
Default: 1
The length of a number 

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 39
Default: 1
The precision of a number. 


Basic properties for Cube Dimension Use :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Cube Dimension Use 

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

Name: DIMENSION_USE_POSITION
Type: INTEGER
Valid Values: Any valid character string in supported character set.
Default: Empty string

measureName

The name of the measure in QUOTED_STRING.

dimension

The name of the dimensin in QUOTED_STRING.

dimensionUseName

The name of dimension use in QUOTED_STRING.

compositeDimensionName

The name of composite dimension in QUOTED_STRING.

CUBE Object

Table 18-6 CUBE Object

Property Type Choices Min Max Default Description

COSTBASEDPERCENTAGE

NUMBER

none

none

none

0

Cost Based Aggregation

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

DEPLOYMENT_OPTIONS

STRING

DEPLOY_AGGREGATION, DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY, DEPLOY_TO_CATALOG_ONLY

none

none

DEPLOY_DATA_OBJECTS_ONLY

Warehouse Builder generates a set of scripts for cube, they are DDL Scripts for Relational Cube or Scripts for OLAP API-II or Scripts for AW.

ENABLE_MV_REFRESH

BOOLEAN

true, false

none

none

false

Enable MV Refresh

ERROR_TABLE_COLUMN_NAMES

STRING

none

none

none

empty string

 

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MATERIALIZED_VIEW_INDEX_TABLESPACE

STRING

none

none

none

USERS

Tablespace for materialized view indexes.

MATERIALIZED_VIEW_TABLESPACE

STRING

none

none

none

USERS

Tablespace for materialized view.

MVCONSTRAINTS

STRING

, ENFORCED, TRUSTED

none

none

TRUSTED

MV Constraints

NEXTDATE

STRING

none

none

none

empty string

Refresh Next Date

QUERY_REWRITE

STRING

, DISABLE, ENABLE

none

none

DISABLE

Enable Query Rewrite

REFRESH

STRING

, COMPLETE, FAST, FORCE

none

none

FORCE

Refresh Mode

REFRESH_ON

STRING

, COMMIT, DEMAND, ONDATE

none

none

DEMAND

Refresh On

STARTWITH

STRING

none

none

none

empty string

Refresh Start Date

VISIBLE

BOOLEAN

true, false

none

none

true

The Cube is visible to OLAP end user if value is set = true.