| Oracle® Warehouse Builder API and Scripting Reference 11g Release 1 (11.1) Part Number B31279-01 |
|
|
View PDF |
| Oracle® Warehouse Builder API and Scripting Reference 11g Release 1 (11.1) Part Number B31279-01 |
|
|
View PDF |
This chapter lists commands associated with OMBALTER in alphabetical order, starting with the command OMBALTER REAL_TIME_MAPPING.
Purpose
Alter the content of a Real Time mapping.
Prerequisites
1. The current context of scripting must be an Oracle Module
2. No concurrent user should be modifying the mapping
Syntax
alterRealTimeMappingCommand = OMBALTER REAL_TIME_MAPPING "mappingName"
"alterMapDetailClause"
mappingName = "QUOTED_STRING"
alterMapDetailClause = "renameClause" [ "alterPropertiesOrIconSetClause" ]
[ "alterOperatorOwnerDescendantsClause"+ ] |
"alterPropertiesOrIconSetClause" [
"alterOperatorOwnerDescendantsClause"+ ] |
"alterOperatorOwnerDescendantsClause"+
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = ( SET ( ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] )
| "setReferenceIconSetClause" ) ) | UNSET
"unsetReferenceIconSetClause"
alterOperatorOwnerDescendantsClause = ADD ( "addOperatorClause" |
"addGroupClause" | "addAttributeClause" | "addChildClause" |
"addConnectionClause" ) | MODIFY ( "modifyOperatorClause" |
"modifyGroupClause" | "modifyAttributeClause" | "modifyChildClause" )
| DELETE ( "operatorBottomUpLocator" | "groupBottomUpLocator" |
"attributeBottomUpLocator" | "childBottomUpLocator" |
"deleteConnectionLocator" )
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addOperatorClause = "operatorType" OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ] [ SET "setPropertiesClause" ] [
"setBindingClause" ]
addGroupClause = "groupDirection" GROUP "groupName" OF
"operatorBottomUpLocator" [ SET "setPropertiesClause" ]
addAttributeClause = ATTRIBUTE "attributeName" OF "groupBottomUpLocator" [
SET "setPropertiesClause" ]
addChildClause = "childType" "childName" "childOwnerBottomUpLocator" [ SET
"setPropertiesClause" ]
addConnectionClause = CONNECTION FROM ( "groupBottomUpLocator" TO
"groupBottomUpLocator" [ "groupToGroupConnectType" ] |
"attributeBottomUpLocator" TO ( "attributeBottomUpLocator" |
"attributesBottomUpLocator" | "groupBottomUpLocator" ) |
"attributesBottomUpLocator" TO ( "attributesBottomUpLocator" |
"groupBottomUpLocator" ) )
modifyOperatorClause = "operatorBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyGroupClause = "groupBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyAttributeClause = "attributeBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyChildClause = "childBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
operatorBottomUpLocator = OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ]
groupBottomUpLocator = GROUP "groupName" OF "operatorBottomUpLocator"
attributeBottomUpLocator = ATTRIBUTE "attributeName" OF
"groupBottomUpLocator"
childBottomUpLocator = "childType" "childName" { OF "childType"
"childName" } [ OF "mappableBottomUpLocator" ]
deleteConnectionLocator = CONNECTION ( FROM "mappableBottomUpLocator" [ TO
"mappableBottomUpLocator" ] | TO "mappableBottomUpLocator" )
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
operatorType = PLUGGABLE_MAPPING | "UNQUOTED_STRING"
operatorName = "QUOTED_STRING"
pluggableMapBottomUpLocator = ( OF PLUGGABLE_MAPPING "pluggableMapName" [
"pluggableMapBottomUpLocator" ] )
setBindingClause = BOUND TO "bindableLocator"
groupDirection = INPUT | OUTPUT | INPUT_OUTPUT
groupName = "QUOTED_STRING"
attributeName = "QUOTED_STRING"
childType = "UNQUOTED_STRING"
childName = "QUOTED_STRING"
childOwnerBottomUpLocator = { OF "childType" "childName" } [ OF
"mappableBottomUpLocator" ]
groupToGroupConnectType = COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS
"QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX
"QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX
"QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" |
SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" |
TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] |
POSITION )
attributesBottomUpLocator = ATTRIBUTES "attributeNameList" OF
"groupBottomUpLocator"
mappableBottomUpLocator = "operatorBottomUpLocator" |
"groupBottomUpLocator" | "attributeBottomUpLocator"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
pluggableMapName = "QUOTED_STRING"
bindableLocator = "bindableType" "bindableName" [ OF "bindableType"
"bindableName" ]
attributeNameList = "(" "attributeName" { "," "attributeName" } ")"
bindableType = PLUGGABLE_MAPPING | OBJECT_TYPE | "UNQUOTED_STRING"
bindableName = "QUOTED_STRING"
Keywords And Parameters
mappingName
Name of the mapping.
alterMapDetailClause
Alter the detail of the mapping.
renameClause
Rename a mapping, mapping operator, mapping group, or mapping attribute.
alterOperatorOwnerDescendantsClause
Alter the desired child objects applicable to a mapping or a pluggable
mapping.
setPropertiesClause
Describe the keys of properties for the map or objects in the map.
addOperatorClause
Adds a mapping operator to a map. When you add an operator, Warehouse
Builder creates default groups and parameters for the operator. Please see
the appendix section of the Scripting Reference.
The following is an example for creating an operator:
OMBALTER MAPPING 'M1' ADD TABLE OPERATOR 'T1'
addGroupClause
Add a mapping group to a mapping operator.
addAttributeClause
Add a mapping attribute to a mapping group.
addChildClause
Add a child to a mapping, mapping operator, mapping group or mapping
attribute.
The following is an example for creating a child object under a mapping
OMBALTER MAPPING 'M1' ADD SOURCE_DATA_FILE 'FILE1'
Note: Key word "OPERATOR" "GROUP" "ATTRIBUTE" are important for their
respective ADD clauses. Without the key words, OMBPlus will interpret the
ADD clause as an addChildClause. Here is an example:
OMB+> OMBALTER MAPPING 'M1' ADD TABLE 'T1'
OMB02932: Error getting child objects of type TABLE in M1
OMBPLUS interprets the ADD clause as one for creating a non-operator child
object under the mapping object. Therefore, it tries to find type
definition for non-operator child object "TABLE" and cannot find it.
addConnectionClause
Add connections between mapping groups or mapping attributes.
modifyOperatorClause
Modify a mapping operator.
modifyGroupClause
Modify a mapping group.
modifyAttributeClause
Modify a mapping attribute.
modifyChildClause
Modify a child that belongs to a mapping, mapping operator, mapping group
or mapping attribute.
operatorBottomUpLocator
Location of a mapping operator.
groupBottomUpLocator
Location of a mapping group.
attributeBottomUpLocator
Location of a mapping attribute.
childBottomUpLocator
Location of the child that belongs to a map, mapping operator, mapping
group or mapping attribute.
deleteConnectionLocator
Delete connections between mapping operators, mapping groups or mapping
attributes.
propertyKeyList
The list of property keys.
propertyValueList
A list of property values.
operatorType
Type of a mapping operator. The following operator types are available:
ADVANCED_QUEUE, AGGREGATOR, ANYDATA_CAST, CONSTANT, CONSTRUCT_OBJECT, CUBE,
DATA_GENERATOR, DEDUPLICATOR, DIMENSION, EXPAND_OBJECT, EXPRESSION,
EXTERNAL_TABLE, FILTER, FLAT_FILE, INPUT_PARAMETER, INPUT_SIGNATURE,
ITERATOROPERATOR, JOINER, KEY_LOOKUP, LCRCAST, LCRSPLITTER, MATCHMERGE,
MATERIALIZED_VIEW, NAME_AND_ADDRESS, OUTPUT_PARAMETER, OUTPUT_SIGNATURE,
PIVOT, PLUGGABLE_MAPPING, POSTMAPPING_PROCESS, PREMAPPING_PROCESS,
SEQUENCE, SET_OPERATION, SORTER, SPLITTER, TABLE, TABLE_FUNCTION,
TRANSFORMATION, UNPIVOT, VIEW.
operatorName
Name of a mapping operator.
pluggableMapBottomUpLocator
Location of a child pluggable mapping within a mapping or another pluggable
mapping.
setBindingClause
Set the binding during the creation of a mapping operator or mapping
attribute.
groupDirection
Direction of a mapping group.
groupName
Name of a mapping group.
attributeName
Name of a mapping attribute.
childType
Type of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childName
Name of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childOwnerBottomUpLocator
Location of a child owner. A child owner can be a map, mapping operator,
mapping group, mapping attribute or a child.
groupToGroupConnectType
Connecting from a mapping group in one mapping operator to a mapping group
in another mapping operator.
attributesBottomUpLocator
Location of a list of mapping attributes.
mappableBottomUpLocator
Location of the object to be bound to a mapping mapping operator or mapping
attribute.
propertyKey
A property key for an object.
Basic properties for MAPPING:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the mapping
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the mapping
Basic properties for OPERATOR:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the operator
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the operator
Basic properties for GROUP:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the group
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the group
Basic properties for ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the attribute
Name: DATATYPE
Type: STRING(20)
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 LOCAL TIME ZONE,
TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Attribute
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Length of the attribute.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Precision of the attribute.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Scale of the attribute.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Properties for MAPPING:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
True if the map is deployable to a physical implementation
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: GENERATION_LANGUAGE
Type: STRING
Valid Values: ABAP, PLSQL, SQLLOADER, UNDEFINED
Default: UNDEFINED
The language used when generating code for the mapping.
Name: REFERRED_CALENDAR
Type: STRING
Valid Values: N/A
Default: ''
Enter the Schedule to associate with this object.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for GROUP:
Name: COMMANDTYPE
Type: STRING
Valid Values: ALL_COMMAND_TYPES, DELETE, INSERT, UPDATE
Default: ALL_COMMAND_TYPES
The operation causing the change described by the LCR
Name: DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: NULL
A date value to be served as the expiration time of a newly created open
record.
Name: DIMENSION_KEY
Type: STRING(32)
Valid Values: N/A
Default: ''
The column in which dimension key value is to be stored when this is a
target of star schema.
Name: EXPRESSION_INOUT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: EXPRESSION_OUT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: EXTRACTING_TYPE
Type: STRING
Valid Values: FROM_ALL, FROM_CURRENT
Default: FROM_CURRENT
The extracting operation to be performed when this is a source. If Extract
Current Only (Type 2 Only) is specified, only current records will be
extracted. If Extract All is specified, all records will be extracted.
Name: GROUP_TYPE
Type: STRING
Valid Values: REF_CURSOR, SCALAR
Default: SCALAR
This property specifies whether the input parameter is a scalar or a ref
cursor type
Name: INTERNAL_TABLE
Type: STRING
Valid Values: N/A
Default: ''
Internal staging table for this operator group
Name: LEVEL_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of this level.
Name: MODULENAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parameter group
Name: RECORD_TYPE_VALUES
Type: STRING
Valid Values: N/A
Default: ''
Record Type Values.
Name: RETURN_TABLE_OF_SCALAR
Type: BOOLEAN
Valid Values: true, false
Default: false
This property specifies whether the return of the table function is a TABLE
of SCALAR or not.
Name: ROW_LOCATOR
Type: STRING
Valid Values: N/A
Default: ''
An expression indicating which attribute within the input group is the row
locator.
Name: ROW_LOCATOR_VALUES
Type: STRING
Valid Values: N/A
Default: NULL, NULL
A comma-separated expressions that gives the possible values of the row
locator within a unpivot group.
Name: SLOWLY_CHANGING_TYPE
Type: STRING
Valid Values: TYPE1, TYPE2, TYPE3
Default: TYPE2
The slowly changing type of this target.
Name: SPLIT_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Condition that defines when to perform the attribute maps for the
attributes in this group.
Name: TABLENAME
Type: STRING
Valid Values: N/A
Default: ''
The source table corresponding to the LCR
Name: TARGET_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The table name bound to this target.
Properties for ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual
address occurs when a record contains both a street address and a P.O. Box;
this is common with business data. A normal address contains only one type
of address.
Name: ATTRIBUTE_ROLE
Type: STRING
Valid Values: END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NONE,
PARENT_NATURAL_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: BINDING_COLUMN_NAME
Type: STRING
Valid Values: N/A
Default: ''
The binding column name for this attribute
Name: DATA_TYPE
Type: STRING
Valid Values: N/A
Default: ''
The data type of the attribute
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The Default Value for the function input parameter
Name: DIMENSION_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The dimension attribute referenced to by this level attribute.
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
The output expression for the attribute
Name: FIELD_DATA_TYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC,
VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
SQL Data Type of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Field Length of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Field Precision of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Field Scale of the field in the file to which this operator is bound.
Name: FIELD_DEFAULTIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is blank or zero,
based on the datatype.
Name: FIELD_END_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The ending position of the field in the file
Name: FIELD_MASK
Type: STRING
Valid Values: N/A
Default: ''
The mask for the field
Name: FIELD_NULLIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is null
Name: FIELD_START_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The starting position of the field in the file
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data fractional seconds precision value of the attribute
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: false
Specifies whether this output is the return value of this function
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the
unpivot group key.
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE,
NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE,
NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2,
NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9,
NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE,
NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME,
NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH,
NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you
can specify which name in the group should be used. In addition, you can
use this option to assign an address type to a miscellaneous address
component.
Name: IS_CAST_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the input is not required to be connected
Name: IS_PREDEFINED_CONSTANT
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
The data length value of the attribute
Name: LEVEL_ATTRIBUTE_COLNAME_NAME
Type: STRING
Valid Values: N/A
Default: ''
Column name in the AW staging table and source view for this attribute.
Name: LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME
Type: STRING
Valid Values: N/A
Default: ''
Level indicating columns name. This level will contain the name of the name
of the level this parent reference belongs to. This is relavant only for
skip level hierarchies.
Name: LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Level Attribute.
Name: LEVEL_RELATIONSHIP_NAME
Type: STRING
Valid Values: N/A
Default: ''
The level relationship name associated to this attribute.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
update load operation.
Name: LOOKUP_ATTRIBUTE_ROLE
Type: STRING
Valid Values: DIMENSION_KEY, END_DATE, NATURAL_KEY, NONE, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group
this output attribute obtains its data.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the update load operation.
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: ''
Related merge attribute
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE,
NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART,
NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY,
NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV,
NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE,
NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE,
NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10,
NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15,
NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2,
NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7,
NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE,
NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD,
NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE,
NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP,
NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2,
NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2,
NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3,
NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA,
NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD,
NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG,
NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC,
NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE,
NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED,
NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME,
NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME,
NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE,
NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED,
NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH,
NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR,
NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5
Default: NA_NONE
Assigns a Name and Address output component to the selected output
attribute.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parmater
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
A comma-separated expression that gives the input attribute to be used for
each output row in the pivot group.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data precision value of the attribute
Name: REFERENCED_LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level attribute associated to this attribute.
Name: REFERENCED_LEVEL_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level group associated to this attribute.
Name: REFERENCING_TYPE
Type: STRING
Valid Values: LOOKUP_KEY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY
Default: NONE
The type of reference to indicate how this attribute participates in
resolving existing level relationships and level implementations. If Lookup
Reference Attribute is specified, this attribute will be used as lookup
attribute upon parent level to resolve level implementations during
loading. If Level Relationship Attribute (Snowflake) is specified, this
attribute will be directly used as level relationship attribute and no
lookup upon parent level would be performed during loading. If Level
Relationship Attribute (Star) is specified, this attribute will be directly
used as level relationship attribute, as well as lookup attribute upon
parent level to resolve level implementations during loading. If none is
specified, this attribute does not participate in any level relationship.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
The data scale value of the attribute
Name: SKIP_LEVEL_DIMENSION
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether this level has a skip level parent.
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the field of the PLS Record or attribute of the Object Type or
column of the ROWTYPE that corresponds to this attribute. This property is
not applicable if the return type is TABLE of SCALAR.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of
this attribute.
Name: UPDATE_OPERATION
Type: STRING(3)
Valid Values: +=, -=, =, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data
and the existing data on the target during the update load operation.
Name: VALUETYPE
Type: STRING
Valid Values: NEW, NEW_OLD, OLD
Default: NEW_OLD
Specifies the value type of this attribute
Properties for AGGREGATOR_OPERATOR:
Name: GROUP_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Group By clause for the aggregation
Name: HAVING_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Having clause for the aggregation
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for CONSTRUCT_OBJECT_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for CUBE_OPERATOR:
Name: ALLOW_PARALLEL_SOLVE
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, allow parallel solve when solving the cube.
Name: AW_STAGED_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the set-based AW load data is staged into a temporary table before
loading into the AW.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: CUBE_STORAGE_ISAW
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether the storage for this cube in AW.
Name: DIMENSION_AWNAME
Type: STRING
Valid Values: N/A
Default: ''
AW Name which contains this Dimension.
Name: INCREMENTAL_AGGREGATION
Type: BOOLEAN
Valid Values: true, false
Default: true
Indicates whether incremental aggregation should be done or full
aggregation.
Name: LOADING_TYPE
Type: STRING
Valid Values: LOAD, REMOVE
Default: LOAD
The loading operation to be performed when this is a target. If LOAD is
specified, OWB will try to insert all input data into target. If REMOVE is
specified, OWB will try to match between the input data and target data to
compute existing data; it will then remove existing data from target.
Name: MAX_JOB_QUEUES_ALLOCATED
Type: NUMBER
Valid Values: 1 - 1000
Default: 0
The maximum number of job queues allocated when solving the cube.
Name: RUN_AGGREGATION
Type: STRING
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether to solve the cube or not . Specify YES
and cube data will be precomputed for the levels specified in the
definition of cube
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRUNCATE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
The truncate flag to indicate whether all existing dimension values should
be truncated before load begins (AW only).
Properties for DEDUPLICATOR_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for DIMENSION_OPERATOR:
Name: AW_LOAD_MODEL
Type: STRING
Valid Values: OTHER, SNOWFLAKE, STAR
Default: SNOWFLAKE
The loading model for the AW dimension - star, snowflake, or other.
Name: AW_STAGED_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the set-based AW load data is staged into a temporary table before
loading into the AW.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DEFAULT_EFFECTIVE_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: SYSDATE
A date value to be served as the effective time of a newly created open
record. The same date value is also served as the expiration time to close
an existing open record.
Name: DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: NULL
A date value to be served as the expiration time of a newly created open
record.
Name: DIMENSION_AWNAME
Type: STRING
Valid Values: N/A
Default: ''
AW Name which contains this Dimension.
Name: DIMENSION_ISAW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Flag to indicate whether storage is AW.
Name: LOADING_TYPE
Type: STRING
Valid Values: LOAD, REMOVE
Default: LOAD
The loading operation to be performed when this is a target. If LOAD is
specified, OWB will try to match between the input data and target data to
compute new data and existing data; it will then create new data, as well
as modify existing data onto target. If REMOVE is specified, OWB will try
to match between the input data and target data to compute existing data;
it will then remove existing data from target.
Name: SLOWLY_CHANGING_TYPE
Type: STRING
Valid Values: TYPE1, TYPE2, TYPE3
Default: TYPE2
The slowly changing type of this target.
Name: SURROGATE_IDENTIFIER_LOADING_POLICY
Type: STRING
Valid Values: N/A
Default: ''
The name of the sequence used to generate surrogate key values when loading
the dimension.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRUNCATE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
The truncate flag to indicate whether all existing dimension values should
be truncated before load begins (AW only).
Name: TYPE2_MATCH_CURRENT_ONLY
Type: STRING
Valid Values: NO, YES
Default: YES
If set to YES, only the current record will be used when performing the
selected operation (remove or extract) for type 2 dimension.
Name: TYPE2_RECORD_GAP_INTERVAL
Type: NUMBER
Valid Values: N/A
Default: 1
A numeric value indicating the number of units (see
TYPE2_RECORD_GAP_INTERVAL_UNITS property below) that will be added to the
expiration date of the previous closed record, to create the effective date
of a new open record.
Name: TYPE2_RECORD_GAP_INTERVAL_UNITS
Type: STRING
Valid Values: DAYS, HOURS, MINUTES, SECONDS, WEEKS
Default: SECONDS
A value indicating the units used for the gap that will be added to the
expiration date of the previous closed record, to create the effective date
of a new open record.
Properties for EXPAND_OBJECT_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for EXTERNAL_TABLE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING(16)
Valid Values: DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR
Default: UNKNOWN
New Data Granularity
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a
staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EVALUATE_CHECK_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: false
Evaluate check constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Properties for FILTER_OPERATOR:
Name: FILTER_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
The boolean filtering condition that identifies what data is to be
processed. Any row with a false condition will be ignored.
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for FLAT_FILE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by reconciliation for this item. Unlike other
operators, it is not needed for generation. By default it is the same name
as the item.
Name: CONCATENATE_RECORDS
Type: NUMBER
Valid Values: N/A
Default: 0
Number of Physical Records per Logical Record.
Name: CONTINUATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ''
Character that indicates the record is continued on the next line.
Name: CONTINUATION_CHARACTER_ON_NEXT_LINE
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
If there is a continuation character, is it at the start of the line.
Name: FIELD_ENCLOSURE_CHARACTERS
Type: STRING
Valid Values: N/A
Default: ''
Characters that wrap fields. Example ' or ".
Name: FIELD_NAMES_IN_THE_FIRST_ROW
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
Indicates whether file contains a header row.
Name: FIELD_TERMINATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ,
Character that separates the fields of a delimited file.
Name: FILE_FORMAT
Type: STRING
Valid Values: DELIMITED, FIXED
Default: DELIMITED
File Format (Fixed or Delimited).
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: INSERT, NONE, UPDATE
Default: INSERT
The loading operation to be performed
Name: OUTPUT_AS_XML
Type: BOOLEAN
Valid Values: true, false
Default: false
Output data to file in XML format.
Name: RECORD_DELIMITER
Type: STRING
Valid Values: N/A
Default: ''
Character that indicates the end of the record.
Name: RECORD_SIZE
Type: NUMBER
Valid Values: N/A
Default: 0
Size of a fixed length record.
Name: RECORD_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the length of the data
that identifies the type of record. It is used with the Record Type
Position.
Name: RECORD_TYPE_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the position of the
field that identifies the type of record.
Name: SAMPLED_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The default name of the physical file to be used by sqlloader. If the file
was sampled, the default was set from sampled file name.
Name: SOURCE_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The Location of the File Module of this Flat File at the time of
reconciliation. Stored as UOID.
Name: TARGET_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access referenced entity.
Name: TARGET_DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the target data file, including extension (file type). This name
should not include the file path. To specify where the target data file
will be created/appended, set the Target Data File Location.
Properties for ITERATOR_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for JOINER_OPERATOR:
Name: JOIN_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
The Join Condition for the join operator
Properties for KEY_LOOKUP_OPERATOR:
Name: BOUND_LEVEL
Type: STRING
Valid Values: N/A
Default: ''
The level name of the bound level, if this is a dimension lookup.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: CREATE_NO_MATCH_ROW
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, a row is created and the user-defined default values are used, in
the case where no lookup match is found. If false, no row is produced.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOOKUP_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Key lookup condition based on the source inputs. This condition is used to
lookup a value in the bound table. If the condition is not met, the
default value expression will be returned. If a default expression is not
defined, null is used.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TYPE2_HISTORY_LOOKUP_DATE
Type: STRING
Valid Values: N/A
Default: ''
A date expression used when doing a lookup on a type 2 dimension level, to
specify the historical date for which to retrieve data. If blank, the most
current record is used.
Properties for LCRCAST_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for MATCHMERGE_OPERATOR:
Name: MATCH_KEYS
Type: STRING
Valid Values: N/A
Default: ''
Ordered list of attributes that control the set of records to be matched at
any at any particular time.
Name: MATCH_NEW_RECORDS
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"MATCHMERGE.GENERAL.MATCH_NEW_RECORDS:DESCRIPTION"
Name: MATCH_NEW_RECORD_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"MATCHMERGE.GENERAL.MATCH_NEW_RECORD_CONDITION:DESCRIPTION"
Name: MERGED_PREFIX
Type: STRING
Valid Values: N/A
Default: ''
Set the prefix used for the merged attributes in the cross-reference group.
Properties for MATERIALIZED_VIEW_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Properties for NAME_AND_ADDRESS_OPERATOR:
Name: ADDRESS_LINE_1
Type: STRING
Valid Values: N/A
Default: ''
Address line 1
Name: ADDRESS_LINE_2
Type: STRING
Valid Values: N/A
Default: ''
Address line 2
Name: ADDRESS_LINE_3
Type: STRING
Valid Values: N/A
Default: ''
Address line 3
Name: ADDRESS_LINE_4
Type: STRING
Valid Values: N/A
Default: ''
Address line 4
Name: DUAL_ADDRESS_ASSIGNMENT
Type: STRING
Valid Values: NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX,
NA_DUALADDR_STREET
Default: NA_DUALADDR_STREET
A dual address refers to two address lines for the same destination. For
example, a record contains both a street address and a P.O. Box; this is
common with business data. Select which of the two address lines should be
assigned in these cases.
Name: GENERATE_CASS_REPORT
Type: STRING
Valid Values: NA_NO, NA_YES
Default: NA_NO
Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS
report is a text file specified by the United States Postal Service. The
report is written to the [nas/bin/admin/reports] folder under the home
folder of the name/address server.
Name: LIST_NAME
Type: STRING
Valid Values: N/A
Default: ''
The list name is optional and provides a reference for tracking multiple
CASS reports.
Name: PARSING_TYPE
Type: STRING
Valid Values: NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY
Default: NA_NAMEANDADDRESS
Select a name-address parsing type to be performed on the input data
Name: PRIMARY_COUNTRY
Type: STRING
Valid Values: NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD,
NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE,
NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST,
NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND,
NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM,
NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR,
NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP,
NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF
Default: NA_USA
Select the primary parsing country which best represents the input data.
Input addresses having the same country as the primary parsing country will
only need to be parsed once. Input addresses having a different country
than the primary parsing country may be reparsed by a different parser. For
performance reasons, it is best to minimize the percentage of 2-pass parses
by selecting the optimal parser.
Name: PROCESSOR_NAME
Type: STRING
Valid Values: N/A
Default: ''
The processor name is the name of the organization submitting the CASS
report.
Properties for PIVOT_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: PIVOT_GROUP_SIZE
Type: NUMBER
Valid Values: 1 - 1000
Default: 2
A number specifying the pivot group size for the pivot operation. Pivot
group size determines the number of output rows that are produced from each
input row.
Properties for PLUGGABLE_MAPPING_OPERATOR:
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for POSTMAPPING_PROCESS_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: POSTMAPPING_PROCESS_RUN_CONDITION
Type: STRING(10)
Valid Values: ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING
Default: ON_SUCCESS
Indicates under what condition of the mapping the post-mapping process will
be run.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for PREMAPPING_PROCESS_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: MAPPING_RUN_CONDITION
Type: STRING(10)
Valid Values: ALWAYS, ON_ERROR, ON_SUCCESS
Default: ON_SUCCESS
Indicates under what condition of the pre-mapping process the mapping will
be run.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for QUEUE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: REAL_TIME_DATA_FORMAT
Type: STRING
Valid Values: LOGICAL_CHANGE_RECORD, MESSAGE
Default: LOGICAL_CHANGE_RECORD
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"ADVANCEDQUEUE.DEFAULT.REALTIMEFORMAT:DESCRIPTION"
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for SEQUENCE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for SET_OPERATION_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: SET_OPERATION
Type: STRING
Valid Values: INTERSECT, MINUS, UNION, UNIONALL
Default: UNION
Specifies the set operation that is to be performed by this operator.
Properties for SORTER_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: ORDER_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Order By Clause
Properties for SPLITTER_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for TABLE_FUNCTION_OPERATOR:
Name: TABLE_FUNCTION_IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: TABLE_FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Table Function
Properties for TABLE_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: CONFLICT_RESOLUTION
Type: BOOLEAN
Valid Values: true, false
Default: true
Detect and resolve any conflicts that may arise during DML using the LCR
APIs
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING(16)
Valid Values: DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR
Default: UNKNOWN
New Data Granularity
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a
staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EVALUATE_CHECK_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: false
Evaluate check constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: JOINRANK
Type: FLOAT
Valid Values: N/A
Default: 0
Join Rank
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Name: USE_LCR_API
Type: BOOLEAN
Valid Values: true, false
Default: true
Use LCR APIs if possible to perform the DML
Properties for TRANSFORMATION_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, then the function is a target
Name: RETURN_TYPE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for UNPIVOT_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for VIEW_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValue
A single property value. It can be a number, float, boolean or
single-quoted string.
pluggableMapName
Name of the pluggable map.
bindableLocator
Location of the object to be bound to a mapping operator or mapping
attribute.
attributeNameList
A list of attribute names.
bindableType
Type of object bound to a mapping operator or mapping attribute.
bindableName
Name of the object bound to a mapping operator or mapping attribute.
See Also
OMBALTER, OMBCREATE REAL_TIME_MAPPING, OMBRETRIEVE REAL_TIME_MAPPING, OMBDROP REAL_TIME_MAPPING
Purpose
Alters a function that can be used in a query.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
alterRegisteredFunctionCommand = ( OMBALTER REGISTERED_FUNCTION
"QUOTED_STRING" ( ( "renameClause" [ SET
"setPropertiesClauseforRegFun" ] [ SET "setReferenceIconSetClause" ] [
UNSET "unsetReferenceIconSetClause" ] { "alterFunctionClauses" } ) |
( SET "setPropertiesClauseforRegFun" [ SET "setReferenceIconSetClause"
] [ UNSET "unsetReferenceIconSetClause" ] { "alterFunctionClauses" }
) | ( SET "setReferenceIconSetClause" [ UNSET
"unsetReferenceIconSetClause" ] { "alterFunctionClauses" } ) | ( UNSET
"unsetReferenceIconSetClause" { "alterFunctionClauses" } ) | (
"alterFunctionClauses" { "alterFunctionClauses" } ) ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClauseforRegFun = PROPERTIES "(" "propertyNameListforRegFun"
")" VALUES "(" "propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterFunctionClauses = ADD "addFunctionArgClausesForAlter" | MODIFY
"modifyFunctionArgClause" | DELETE "deleteFunctionArgClause"
propertyNameListforRegFun = ( "UNQUOTED_STRING" | ( PACKAGE | SIGNATURE )
) { "," ( "UNQUOTED_STRING" | ( PACKAGE | SIGNATURE ) ) }
propertyValueList = "propertyValue" { "," "propertyValue" }
addFunctionArgClausesForAlter = PARAMETER "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
modifyFunctionArgClause = PARAMETER "QUOTED_STRING" [ "renameClause" ] [
"moveParamToClause" ] [ SET "setPropertiesClause" ]
deleteFunctionArgClause = PARAMETER "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
moveParamToClause = MOVE TO POSITION "INTEGER_LITERAL"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
alterRegisteredFunctionCommand
This clause alters a function.
QUOTED_STRING
name of the function.
renameClause
Renames a function with a different name.
setPropertiesClauseforRegFun
This clause sets the properties of the object.
setReferenceIconSetClause
Set specified Icon Set.
unsetReferenceIconSetClause
Unset specified Icon Set.
alterFunctionClauses
This clause alters the function parameters.
propertyNameListforRegFun
This is the list of property names.
propertyValueList
This is the list of property values.
addFunctionArgClausesForAlter
This clause adds a function parameter.
QUOTED_STRING
name of the parameter.
modifyFunctionArgClause
This clause modifies a function parameter.
QUOTED_STRING
name of the parameter.
deleteFunctionArgClause
This clause deletes a function parameter.
QUOTED_STRING
name of the parameter.
propertyValue
This is a property value.
setPropertiesClause
This clause sets the properties of the object.
Basic properties for REGISTERED_FUNCTION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the function
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the function
Name: AVAILABLE
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the Function is available for the user to use in calculations
Name: RETURN_TYPE
Type: STRING()
Valid Values: BINARY_INTEGER, BLOB, BOOLEAN, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH
NCHAR, NCLOB, NUMBER, NVARCHAR2, PLS_INTEGER, RAW, SYS.ANYDATA,
SYS.ROW_LCR, SYS_REFCURSOR, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHAR2, XMLTYPE, SYS.XMLFORMAT,
BLAST_ALIGN_PLSQLRECORDTYPE
SYS.LCR$_ROW_RECORD, BLAST_SQL_TABLE_OF_NUMBERS, SYS.XMLSEQUENCETYPE,
BLAST_MATCH_PLSQLRECORDTYPE
Default: 'NUMBER'
Return type of the function
Basic properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the parameter
Name: DATATYPE
Type: STRING()
Valid Values: BINARY_INTEGER, BLOB, BOOLEAN, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH
NCHAR, NCLOB, NUMBER, NVARCHAR2, PLS_INTEGER, RAW, SYS.ANYDATA,
SYS.ROW_LCR, SYS_REFCURSOR, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHAR2, XMLTYPE, SYS.XMLFORMAT,
BLAST_ALIGN_PLSQLRECORDTYPE
SYS.LCR$_ROW_RECORD, BLAST_SQL_TABLE_OF_NUMBERS, SYS.XMLSEQUENCETYPE,
BLAST_MATCH_PLSQLRECORDTYPE
Default: 'NUMBER'
Datatype of the parameter
Properties for REGISTERED_FUNCTION:
Name: AUTHID
Type: STRING
Valid Values: Current_User, Definer, None
Default: None
Generate the transformation with selected AUTHID option. Function will be
executed with the permissions defined by the AUTHID clause rather than the
function owner's permissions.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
Location for the referenced Function
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: PACKAGE
Type: STRING
Valid Values: N/A
Default: ''
May be used to identify the name of a Package that contains the Function
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
moveParamToClause
This clause moves parameters within registered functions.
propertyNameList
This is the list of property names.
See Also
OMBCREATE REGISTERED_FUNCTION, OMBRETRIEVE REGISTERED_FUNCTION
Purpose
To alter properties of a Warehouse Builder role.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
alterRoleCommand = OMBALTER ( ROLE "QUOTED_STRING" ( "renameClause" [ SET
"setPropertiesClause" ] | SET "setPropertiesClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterRoleCommand
This clause alters a Warehouse Builder role.
renameClause
renames a role with a different name.
setPropertiesClause
Used to set properties of a Warehouse Builder role. Valid properties are
shown below.
Basic properties for ROLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the role
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the role
See Also
OMBCREATE ROLE, OMBDROP ROLE
Purpose
Alter the SAP module by renaming it, and/or reset its properties.
It is not supported in the current release.
Prerequisites
You must open a project to alter a SAP module.
Syntax
alterSAPModuleCommand = OMBALTER ( SAP_MODULE "QUOTED_STRING" (
"renameClause" [
"alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
"alterPropertiesOrReferenceClauseForDataMetadataModule" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrReferenceClauseForDataMetadataModule = ( ( SET ( (
"alterPropertiesClause" [ ( SET
"setReferenceClauseForDataMetadataModule" [ UNSET
"unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
"unsetReferenceClauseForDataMetadataModule" [ SET
"setReferenceClauseForDataMetadataModule" ] ) ] ) | (
"setReferenceClauseForDataMetadataModule" [ UNSET
"unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
"unsetReferenceClauseForDataMetadataModule" [ SET
"setReferenceClauseForDataMetadataModule" ] ) ) [
"addOrRemoveOrModifyModuleReferenceLocationClause" ]
alterPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataMetadataModule = ( "setReferenceLocationClause" [
SET "setReferenceMetadataLocationOrIconSetClause" ] |
"setReferenceMetadataLocationOrIconSetClause" )
unsetReferenceClauseForDataMetadataModule = (
"unsetReferenceLocationClause" [ UNSET
"unsetReferenceMetadataLocationOrIconSetClause" ] |
"unsetReferenceMetadataLocationOrIconSetClause" )
addOrRemoveOrModifyModuleReferenceLocationClause = (
"addReferenceLocationClause" | "removeReferenceLocationClause" |
"modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
"removeReferenceLocationClause" | "modifyReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceMetadataLocationOrIconSetClause = (
"setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
] | "setReferenceIconSetClause" )
unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
unsetReferenceMetadataLocationOrIconSetClause = (
"unsetReferenceMetadataLocationClause" [ UNSET
"unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
addReferenceLocationClause = ADD ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" [ SET AS DEFAULT ]
removeReferenceLocationClause = REMOVE ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
modifyReferenceLocationClause = MODIFY ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" SET AS DEFAULT
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setReferenceMetadataLocationClause = ( REFERENCE | REF ) METADATA_LOCATION
"QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceMetadataLocationClause = ( REFERENCE | REF )
METADATA_LOCATION "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
Keywords And Parameters
alterSAPModuleCommand
Modify an existing SAP module.
renameClause
Rename a SAP module.
alterPropertiesOrReferenceClauseForDataMetadataModule
Alter existing SAP module's properties and/or locations and/or icon sets.
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the SAP module.
unsetReferenceClauseForDataMetadataModule
Unset location and/or icon set for the SAP module.
addOrRemoveOrModifyModuleReferenceLocationClause
Add/remove/modify runtime location for the SAP module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
setReferenceLocationClause
Set a location to the existing SAP module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the SAP module.
unsetReferenceLocationClause
Unset a location to the existing SAP module.
unsetReferenceMetadataLocationOrIconSetClause
Unset metadata location and/or icon set for the SAP module.
addReferenceLocationClause
Add a runtime location to the SAP module.
removeReferenceLocationClause
Remove a runtime location from the SAP module.
modifyReferenceLocationClause
Modify a runtime location of the SAP module.
propertyValue
Value of a property.
setReferenceMetadataLocationClause
Set metadata location for the SAP module.
setReferenceIconSetClause
Set icon set for the SAP module.
unsetReferenceMetadataLocationClause
Unset metadata location for the SAP module.
unsetReferenceIconSetClause
Unset icon set for the SAP module.
See Also
OMBALTER, OMBCREATE SAP_MODULE, OMBDROP SAP_MODULE
Purpose
To alter properties and definition of a sequence.
Prerequisites
In the context of an Oracle Module.
Syntax
alterSequenceCommand = OMBALTER ( SEQUENCE "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] { MODIFY
"modifySequenceColumnClause" } | "alterPropertiesOrIconSetClause" {
MODIFY "modifySequenceColumnClause" } | ( MODIFY
"modifySequenceColumnClause" )+ ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause"
modifySequenceColumnClause = COLUMN "QUOTED_STRING" SET
"setPropertiesClause"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterSequenceCommand
This clause is for sequence alter command.
renameClause
renames a table with a different name.
modifySequenceColumnClause
This clause modifies the sequence's column.
setPropertiesClause
set sequences properties.
Basic properties for SEQUENCE:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the sequence.
Name: CURRVAL
Type: NUMBER
Valid Values: N/A
Default: 1
current increment value.
Name: NEXTVAL
Type: NUMBER
Valid Values: N/A
Default: 1
next increment value. next increment value.
Properties for SEQUENCE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Description not available.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: INCREMENT_BY
Type: NUMBER
Valid Values: -2147483648 - 2147483647
Default: 1
Description not available.
Name: START_WITH
Type: NUMBER
Valid Values: -2147483648 - 2147483647
Default: 1
Description not available.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBCREATE SEQUENCE, OMBDROP SEQUENCE, OMBRETRIEVE SEQUENCE
Purpose
A snapshot can be altered to remove, add or update components.
Prerequisites
The snapshot to be altered should already exist. This command can be
executed for any component regardless of current context.
Syntax
parseAlterCommand = OMBALTER "alterSnapshotCommand"
alterSnapshotCommand = ( SNAPSHOT "QUOTED_STRING" ( SET
"setPropertiesClause" | ( ( ( ADD | MODIFY ) "objectClause" ) | (
DELETE "UNQUOTED_STRING" "QUOTED_STRING" ) )+ ) )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
objectClause = "UNQUOTED_STRING" "QUOTED_STRING" [ CASCADE | NO CASCADE ]
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
parseAlterCommand
Root production for OMBALTER SNAPSHOT.
alterSnapshotCommand
To alter already existing snapshot.
QUOTED_STRING
Name of snapshot to be altered.
ADD
Add components to snapshot.
MODIFY
Replace an already existing component with the latest definition of the
component from workspace.
DELETE
Remove component from snapshot.
setPropertiesClause
Properties of snapshot can be altered through this optional clause.
Properties of Snapshot is DESCRIPTION and TYPE. Altering TYPE property is
an irreversible operation. Altering snapshot from FULL to SIGNATURE will
only keep information required for comparing. SIGNATURE snapshots cannot be
exported.
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: N/A
Default: ''
Description of the snapshot
propertyNameList
Property names for SNAPSHOT that can be altered.
propertyValueList
List of property values for SNAPSHOT.
propertyValue
Allowable value types for a snapshot property.
See Also
OMBCREATE SNAPSHOT, OMBDROP SNAPSHOT, OMBRESTORE SNAPSHOT, OMBCOMPARE SNAPSHOT, OMBLIST SNAPSHOT, OMBRETRIEVE SNAPSHOT
Purpose
Alter the Streams Capture Process by resetting its properties and adding/removing tables to capture.
Prerequisites
Should be in the context of Streams Queue.
Syntax
alterCaptureCommand = OMBALTER STREAMS_CAPTURE_PROCESS "QUOTED_STRING" (
"renameClause" [ SET "setCapturePropertiesClause" ] [ (
"addTableClause" | "deleteTableClause" )+ ] | SET
"setCapturePropertiesClause" [ ( "addTableClause" |
"deleteTableClause" )+ ] | ( "addTableClause" | "deleteTableClause" )+
)
renameClause = RENAME TO "QUOTED_STRING"
setCapturePropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES
"(" "propertyValueList" ")"
addTableClause = ADD TABLE "QUOTED_STRING"
deleteTableClause = DELETE TABLE "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterCaptureCommand
Alters the Streams Capture Process with the given name by either renaming
it or by setting it's properties or both.
addTableClause
Add a table to the set of tables whose changes are to be captured by this
Streams Capture Process
deleteTableClause
Remove a table from the set of tables whose changes are to be captured by
this Streams Capture Process
propertyNameList
The list of properties.
Basic properties for STREAMS_CAPTURE_PROCESS:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Streams Capture Process
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Streams Capture
Properties for STREAMS_CAPTURE_PROCESS:
Name: CAPTURE_START_PARAMETER
Type: STRING
Valid Values: START_DATE, START_SCN
Default: START_SCN
This specifies whether the Streams Capture Process should start capturing
changes based on the Start Date or the Start SCN.
Name: CAPTURE_TAGGED_LCR
Type: BOOLEAN
Valid Values: true, false
Default: false
If TRUE, then a redo entry is always considered for capture and an LCR is
always considered for apply, regardless of whether redo entry or LCR has a
non-NULL tag. If FALSE, then a redo entry is considered for capture and an
LCR is considered for apply only when the redo entry or the LCR contains a
NULL tag.
Name: CAPTURE_TIMEOUT
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
The maximum number of seconds to wait for another instance of the same
capture process to finish.
Name: DBA_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
Location of the DBA user who should create the supplemental logs.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Indicates whether the Object is deployable or not.
Name: DISABLE_ON_LIMIT
Type: BOOLEAN
Valid Values: true, false
Default: true
If set to true, the capture process will be disabled once the message/time
limit is reached.
Name: MAXIMUM_SCN
Type: NUMBER
Valid Values: 0 - 1000000000
Default: 0
This is the Maximum SCN value whose corresponding changes will be captured
by the Streams Capture Process.
Name: MESSAGE_COUNT_LIMIT
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
If Disable On Limit is set to true, then the Streams Capture Process is
disabled once the specified number of messages have been captured.
Name: PARALLELISM_DEGREE
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
The number of parallel server process that will mine the redo logs.
Name: START_DATE
Type: STRING
Valid Values: N/A
Default: 1970-01-01
The user specified date from which the Streams Capture Process should start
capturing changes.
Name: START_SCN
Type: NUMBER
Valid Values: N/A
Default: 0
The user specified SCN from which the Streams Capture Process should start
capturing changes.
Name: TIME_LIMIT
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
If Disable On Limit is set to true, then the Streams Capture Process is
disabled once the specified number of seconds elapse.
Name: WRITE_ALERT_LOG
Type: BOOLEAN
Valid Values: true, false
Default: true
If set to true, then the Streams Capture Process writes a message to the
alert log on exit.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBCREATE STREAMS_CAPTURE_PROCESS, OMBRETRIEVE STREAMS_CAPTURE_PROCESS, OMBDROP STREAMS_CAPTURE_PROCESS
Purpose
Alter the Streams Queue by resetting its properties.
Prerequisites
Should be in the context of an Oracle Module. The Queue Table should exist
in the same Oracle Module.
Syntax
alterANYQCommand = OMBALTER ( STREAMS_QUEUE "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterANYQCommand
Alters the Streams Queue with the given name by either renaming it or by
setting it's properties or both.
renameClause
Renames the Streams Queue to the given name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Advanced Queue.
Valid properties are shown below:
Basic properties for ADVANCED_QUEUE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Advanced Queue
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Advanced Queue
Name: QTABLE
Type: STRING(4000)
Valid Values: N/A
Default: ''
Queue Table for the Advanced Queue. This has to be the name of a Queue
Table(QUEUE_TABLE) existing in the same Oracle Module.
Properties for STREAMS_QUEUE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.DEPLOYABLE:DESCRIPTION"
Name: DEQUEUE_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.DEQUEUEENABLED:DESCRIPTION"
Name: ENQUEUE_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.ENQUEUEENABLED:DESCRIPTION"
Name: GENERATE_ADVANCED_QUEUE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.GENERATEAQ:DESCRIPTION"
Name: GENERATE_TEMPORARY_TABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.GENERATETEMPTABLE:DESCRIPTION"
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: MAX_RETRIES
Type: NUMBER
Valid Values: N/A
Default: 5
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.MAXRETRIES:DESCRIPTION"
Name: RETENTION_TIME
Type: NUMBER
Valid Values: N/A
Default: 0
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.RETENTIONTIME:DESCRIPTION"
Name: RETRY_DELAY
Type: NUMBER
Valid Values: N/A
Default: 0
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.RETRYDELAY:DESCRIPTION"
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBCREATE STREAMS_QUEUE, OMBRETRIEVE STREAMS_QUEUE, OMBDROP STREAMS_QUEUE
Purpose
Alter the Table Function by renaming it, and/or reset its properties, and/or resetting its Ordered/Partitioned fields,
and/or adding Parameters.
Prerequisites
Should be in the context of Oracle Module or Package. The REFCursorType and
PLSQLTableType which are set as Datatype for parameters should pre-exist in
corresponding Package.
Syntax
alterFunctionCommand = OMBALTER ( FUNCTION "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] [
"alterFuncProcParameterSCOClause" ] | "alterPropertiesOrIconSetClause"
[ "alterFuncProcParameterSCOClause" ] |
"alterFuncProcParameterSCOClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
alterFuncProcParameterSCOClause = ( ADD ( "alterFuncProcParameterClause" |
"addRelationalDependentClause" ) | MODIFY
"modifyFuncProcParameterClause" | DELETE (
"deleteFuncProcParameterClause" | "deleteRelationalDependentClause" )
) [ "alterFuncProcParameterSCOClause" ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterFuncProcParameterClause = PARAMETER "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
modifyFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" (
"renameClause" | "moveToClause" | [ SET "setPropertiesClause" ] ) )
deleteFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" )
deleteRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
moveToClause = MOVE TO POSITION "INTEGER_LITERAL"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterFunctionCommand
Alters a Table Function
renameClause
Rename a Table Function
alterFuncProcParameterSCOClause
Modify, delete or add a Parameter for Function/Procedure, or add or delete
dependencies to some other relational objects.
setPropertiesClause
Associate a set of properties with a Table Function.
Properties for TABLE_FUNCTION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Table Function
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Table Function
Name: PARALLEL_EXECUTION
Type: STRING(5)
Valid Values: TRUE, FALSE
Default: ''
Enables Parallel Execution of the Table Function
Name: PIPELINED_EXECUTION
Type: STRING(5)
Valid Values: TRUE, FALSE
Default: ''
Enables Partitioned Execution of the Table Function
Name: ORDER_METHOD
Type: STRING(9)
Valid Values: ORDERBY, CLUSTERBY
Default: ORDERBY
Order Method for the Table Function
Name: PARTITION_METHOD
Type: STRING(5)
Valid Values: NONE, ANY, HASH, RANGE
Default: NONE
Partition Method for the Table Function
Name: RETURN_TYPE
Type: STRING(4000)
Valid Values: N/A
Default: ''
Name of the Return Type of this Table Function. For this release, this has
to be a PLSQL Table Type whose datatype has to be PLSQLRecordType. Also, it
should already be defined in USER_TYPES Package in this Module.
Name: IMPLEMENTATION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Implementation code for this Table Function.
Name: IS_DETERMINISTIC
Type: STRING(5)
Valid Values: TRUE, FALSE
Default: ''
Whether this Table Function is Deterministic.
Properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Parameter
Name: DATATYPE
Type: STRING(4000)
Valid Values: Any valid REF cursor type
Default: ''
Datatype of the Parameter. Parameter will always be IN type for Table
Function. For this release, it has to be a REF Cursor type. Also, this REF
Cursor should already be defined in USER_TYPES Package in this Module.
Properties for TABLE_FUNCTION:
Name: AUTHID
Type: STRING
Valid Values: Current_User, Definer, None
Default: None
Generate the transformation with selected AUTHID option. Function will be
executed with the permissions defined by the AUTHID clause rather than the
function owner's permissions.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
alterFuncProcParameterClause
Alter the parameters of a table function, including adding, dropping
parameters, changing their direction, datatype and default values.
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
modifyFuncProcParameterClause
Modify one or more Parameters to this Function/Procedure.
deleteFuncProcParameterClause
Delete one or more Parameters to this Function/Procedure.
deleteRelationalDependentClause
This clause deletes referential dependencies to other relational objects.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
moveToClause
Move a Parameters of this Function/Procedure.
propertyValue
Value of a property.
See Also
OMBALTER, OMBCREATE TABLE_FUNCTION, OMBDROP TABLE_FUNCTION
Purpose
To alter properties and definition of a table.
Prerequisites
In the context of an Oracle Module.
Syntax
alterTableCommand = OMBALTER ( TABLE "QUOTED_STRING" ( "renameClause" [
"alterPropertiesOrIconSetClause" ] [ "alterTableSCOClauses" ] |
"alterPropertiesOrIconSetClause" [ "alterTableSCOClauses" ] |
"alterTableSCOClauses" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause"
alterTableSCOClauses = ADD ( "addColumnClauseForAlter" |
"addConstraintClause" | "addSCOClause" | "addDataRuleUsageClause" ) [
"alterTableSCOClauses" ] | MODIFY ( "modifyColumnClause" |
"modifyConstraintClause" | "modifySCOClause" |
"modifyDataRuleUsageClause" ) [ "alterTableSCOClauses" ] | DELETE (
"deleteColumnClause" | "deleteConstraintClause" | "deleteSCOClause" |
"deleteDataRuleUsageClause" ) [ "alterTableSCOClauses" ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ICONSET
addColumnClauseForAlter = COLUMN "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
addConstraintClause = "addUkPkClause" | "addFkClause" |
"addCheckConstraintClause"
addSCOClause = "addIndexClause" | "addIndexPartitionClause" |
"addIndexPartitionKeyClause" | "addPartitionClause" |
"addPartitionKeyClause" | "addSubpartitionClause" |
"addaddMaterializedViewSCOandDependentClauseClause" |
"addSubPartitionKeyClause" | "addIndexColumnClause"
addDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" SET REF DATA_RULE
"QUOTED_STRING" ( GROUP "QUOTED_STRING" SET REF ( TABLE | VIEW |
MATERIALIZED_VIEW | EXTERNAL_TABLE ) "QUOTED_STRING" ( ATTRIBUTE
"QUOTED_STRING" SET REF COLUMN "QUOTED_STRING" )+ )+ [ SET
"setPropertiesClause" ]
modifyColumnClause = COLUMN "QUOTED_STRING" ( "renameClause" [
"moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET
"setPropertiesClause" ] | SET "setPropertiesClause" )
modifyConstraintClause = "modifyUkPkClause" | "modifyFkClause" |
"modifyCheckConstraintClause"
modifySCOClause = "modifyIndexClause" | "modifyIndexPartitionClause" |
"modifyIndexPartitionKeyClause" | "modifyPartitionClause" |
"modifyPartitionKeyClause" |
"modifyaddMaterializedViewSCOandDependentClauseClause" |
"modifySubPartitionClause" | "modifySubPartitionKeyClause" |
"modifyIndexColumnClause"
modifyDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
deleteColumnClause = COLUMN "QUOTED_STRING"
deleteConstraintClause = UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY
"QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING" | CHECK_CONSTRAINT
"QUOTED_STRING"
deleteSCOClause = INDEX "QUOTED_STRING" | PARTITION "QUOTED_STRING" |
PARTITION_KEY "QUOTED_STRING" | TEMPLATE_SUBPARTITION "QUOTED_STRING"
| SUBPARTITION_KEY "QUOTED_STRING" | INDEX_COLUMN "QUOTED_STRING" OF
INDEX "QUOTED_STRING" | INDEX_PARTITION "QUOTED_STRING" OF INDEX
"QUOTED_STRING" | INDEX_PARTITION_KEY "QUOTED_STRING" OF INDEX
"QUOTED_STRING" | SUBPARTITION "QUOTED_STRING" OF PARTITION
"QUOTED_STRING"
deleteDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET
"setUkPkPropertiesAndReferencesColumnsClauses" ]
addFkClause = FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ]
addCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" [ SET
"setPropertiesClause" ]
addIndexClause = INDEX "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addIndexPartitionClause = INDEX_PARTITION "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] (
"renameSCOConfigurationClause" [ SET
"setSCOConfigurationPropertiesClauses" ] | [ SET
"setSCOConfigurationPropertiesClauses" ] )
addIndexPartitionKeyClause = INDEX_PARTITION_KEY "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ]
addPartitionClause = PARTITION "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setSCOConfigurationPropertiesClauses" ]
addPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addSubpartitionClause = SUBPARTITION "QUOTED_STRING" OF PARTITION
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET
"setSCOConfigurationPropertiesClauses" ]
addaddMaterializedViewSCOandDependentClauseClause = TEMPLATE_SUBPARTITION
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET
"setSCOConfigurationPropertiesClauses" ]
addSubPartitionKeyClause = SUBPARTITION_KEY "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ]
moveToClause = MOVE TO POSITION "INTEGER_LITERAL"
modifyUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" (
"renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ]
| SET "setUkPkPropertiesAndReferencesColumnsClauses" )
modifyFkClause = FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET
"setFkSubClauses" ] | SET "setFkSubClauses" )
modifyCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
modifyIndexClause = INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause"
[ SET "setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyIndexPartitionClause = INDEX_PARTITION "QUOTED_STRING" OF INDEX
"QUOTED_STRING" ( "renameSCOConfigurationClause" [
"moveToClauseIndexPartition" ] [ SET
"setSCOConfigurationPropertiesClauses" ] |
"moveToClauseIndexPartition" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyIndexPartitionKeyClause = INDEX_PARTITION_KEY "QUOTED_STRING" OF
INDEX "QUOTED_STRING" ( SET "setSCOConfigurationPropertiesClauses" )
modifyPartitionClause = PARTITION "QUOTED_STRING" (
"renameSCOConfigurationClause" [ "moveToClausePartition" ] [ SET
"setSCOConfigurationPropertiesClauses" ] | "moveToClausePartition" [
SET "setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" (
"renameSCOConfigurationClause" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyaddMaterializedViewSCOandDependentClauseClause =
TEMPLATE_SUBPARTITION "QUOTED_STRING" ( "renameSCOConfigurationClause"
[ "moveToClauseTemplateSubPartition" ] [ SET
"setSCOConfigurationPropertiesClauses" ] |
"moveToClauseTemplateSubPartition" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifySubPartitionClause = SUBPARTITION "QUOTED_STRING" OF PARTITION
"QUOTED_STRING" ( "renameSCOConfigurationClause" [
"moveToClauseSubPartition" ] [ SET
"setSCOConfigurationPropertiesClauses" ] | "moveToClauseSubPartition"
[ SET "setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifySubPartitionKeyClause = SUBPARTITION_KEY "QUOTED_STRING" (
"renameSCOConfigurationClause" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX
"QUOTED_STRING" ( "renameSCOConfigurationClause" [
"moveToClauseForIndexColumn" ] [ SET
"setSCOConfigurationPropertiesClauses" ] |
"moveToClauseForIndexColumn" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setUkPkPropertiesAndReferencesColumnsClauses = "setPropertiesClause" [ SET
( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF |
REFERENCE ) "constraintColumnReferencesClause"
setFkSubClauses = "setPropertiesClause" [ SET ( REF | REFERENCE )
"setFkReferencesClauses" ] | ( REF | REFERENCE )
"setFkReferencesClauses"
setSCOConfigurationPropertiesClauses = PROPERTIES "(" "propertyNameList"
")" VALUES "(" "propertyValueList" ")"
renameSCOConfigurationClause = RENAME TO "QUOTED_STRING"
moveToClauseIndexPartition = MOVE TO POSITION "INTEGER_LITERAL"
moveToClausePartition = MOVE TO POSITION "INTEGER_LITERAL"
moveToClauseTemplateSubPartition = MOVE TO POSITION "INTEGER_LITERAL"
moveToClauseSubPartition = MOVE TO POSITION "INTEGER_LITERAL"
moveToClauseForIndexColumn = MOVE TO POSITION "INTEGER_LITERAL"
constraintColumnReferencesClause = COLUMNS "(" "quotedNameList" ")"
setFkReferencesClauses = "constraintColumnReferencesClause" [ SET ( REF |
REFERENCE ) "constraintUkReferencesClause" ] |
"constraintUkReferencesClause" [ SET ( REF | REFERENCE )
"constraintColumnReferencesClause" ]
quotedNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
constraintUkReferencesClause = ( UNIQUE_KEY | PRIMARY_KEY )
"QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ]
Keywords And Parameters
alterTableCommand
This clause alters a table.
QUOTED_STRING
name of the table.
renameClause
renames a table with a different name.
alterTableSCOClauses
This clause will add, modify, delete, columns, configuration, and keys.
setPropertiesClause
Used to set properties (core, logical, physical, user-defined) for tables
(including partitions and subpartitions) and their columns, indexes
(including index partitions), check constraints, unique keys, foreign keys,
and primary keys.
Basic properties for TABLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the table
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the table
Basic properties for COLUMN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the column
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the column
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, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: NUMBER
The datatype of a column
Name: LENGTH
Type: NUMBER
Valid Values:
Default: 1
The length of a number
Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.
Name: SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 1
The scale of a number.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Default value of the column
Name: NOT_NULL
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify "true" to enforce Not Null restriction on a column.
Basic properties for PARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: RANGE, LIST, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
Ask Oracle to partition the table rows according to a Hash Algorithm, lists
of values, or specified ranges.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH partitions the database should create on HASH BY
QUANTITY partitioning. For optimal load balancing you should specify a
number of partitions that is a power of 2. If you have multiple Partition
Keys, you only have to specify once.
Basic properties for PARTITION:
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Specify the noninclusive upper bound for the current RANGE partition. The
value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column list. Always specify
MAXVALUE(s) as the value(s) of the last partition, and make sure you have
specified PARTITION_KEY(s) before you specify any PARTITION.
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST partition. The value
list is a comma-delimited, ordered list of literal values corresponding to
the index partitioning column. Commas can be escaped using "" (e.g.
'1,2,3'). Always specify DEFAULT as the value of the last partition, and
make sure you have specified PARTITION_KEY(s) before you specify any
PARTITION.. Each LIST partition must have at least one value. No value,
including NULL, can appear in more than one partition.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH customized subpartitions the database should create
for a particular main RANGE partition (RANGE-HASH BY QUANTITY
partitioning). For optimal load balancing you should specify a number of
subpartitions that is a power of 2. If you have multiple Subpartition Keys,
you only have to specify once. Set it to 0 to reverse to the use of generic
template HASH_QUANTITY specified in SUBPARTITION_KEY.
Basic properties for SUBPARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: LIST, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
For partition-level partitioning according to a Hash Algorithm or lists of
values. Each partition is further sorted into subpartitions.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH subpartitions the database should create on HASH BY
QUANTITY partitioning. For optimal load balancing you should specify a
number of subpartitions that is a power of 2. If you have multiple
Subpartition Keys, you only have to specify once.
Basic properties for SUBPARTITION:
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST subpartition. The
value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column. Always specify DEFAULT as
the value of the last subpartition, and make sure you have specified
SUBPARTITION_KEY(s) before you specify any SUBPARTITION. Each LIST
subpartition must have at least one value. No value, including NULL, can
appear in more than one subpartition.
Basic properties for TEMPLATE_SUBPARTITION:
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
In composite partitioning, template subpartitions are automatically applied
to those partitions without their subpartitions specified. Here for LIST
subpartitions only, specify a comma-delimited, ordered list of literal
values corresponding to the LIST subpartitioning column. Always specify
DEFAULT as the value of the last template LIST subpartition, and and make
sure you have specified SUBPARTITION_KEY(s) before you specify any
TEMPLATE_SUBPARTITION. Each LIST template subpartition must have at least
one value. No value, including NULL, can appear in more than one template
subpartition.
Basic properties for INDEX:
Name: INDEX_TYPE
Type: STRING
Valid Values: UNIQUE, NON-UNIQUE, BITMAP, FUNCTION-BASED
Default: (No default, must be one of the choices above)
Specify the type of an index. NORMAL can be used in place of NON-UNIQUE.
Name: LOCAL_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify if an index is Global or Local. The default is Global.
Specify Local so that the index is partitioned on the same columns, with
the same number of partitions and the same partition bounds as table.
Oracle Database automatically maintains local index partitioning as the
underlying table is repartitioned.
Name: COLUMN_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
Specify an expression built from columns of table, constants, SQL
functions, and user-defined functions to create a FUNCTION-BASED index.
Basic properties for INDEX_PARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: RANGE, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
Ask Oracle to partition the index rows according to a Hash Algorithm, lists
of values, or specified ranges. Hash index partitioning is supported
starting with Oracle 10g version.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH index partitions the database should create based on
HASH BY QUANTITY partitioning. For optimal load balancing you should
specify a number of index partitions that is a power of 2. If you have
multiple index Partition Keys, you only have to specify once.
Basic properties for INDEX_PARTITION:
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Specify the noninclusive upper bound for the current RANGE partition in a
global index. The value list is a comma-delimited, ordered list of literal
values corresponding to the index partitioning column list. Always specify
MAXVALUE(s) as the value(s) of the last partition. No need to specify
VALUES_LESS_THAN for Local index.
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST partition in a global
index. The value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column. Always specify DEFAULT as
the value of the last partition. Each LIST partition must have at least one
value. No value, including NULL, can appear in more than one partition. No
need to specify VALUES_EQUAL_TO for Local index.
Basic properties for CHECK_CONSTRAINTS:
Name: CHECK_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Specify a condition that each row in the table must satisfy.
Properties for TABLE:
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for table or partition object. The
default is DEFAULT.
Name: CACHE_MODE
Type: STRING
Valid Values: , CACHE, NOCACHE
Default: ''
Indicate how Oracle should store blocks in the buffer cache.
Name: DATA_SEGMENT_COMPRESSION
Type: STRING
Valid Values: , COMPRESS, NOCOMPRESS
Default: ''
Use this clause to instruct Oracle whether to compress data segments to
reduce disk use. The default is NOCOMPRESS.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
table, partition, cluster, or index. The default is 1.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (1-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 1.
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Specify whether the creation of the table and of any indexes required
because of constraints, partition, or LOB storage characteristics will be
logged in the redo log file (LOGGING) or not (NOLOGGING). The default is
LOGGING.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the object.
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (1-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: MONITORING_MODE
Type: STRING
Valid Values: , MONITORING, NOMONITORING
Default: ''
Specify MONITORING if you want modification statistics to be collected on
this table.
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: OVERFLOW
Type: STRING
Valid Values: N/A
Default: ''
Enter a comma separated list of tablespaces for overflow data. For
simple-partitoned object, it is used for HASH BY QUANTITY partition
overflow tablespaces. The number of tablespaces does not have to equal the
number of partitions. If the number of partitions is greater than the
number of tablespaces, then Oracle cycles through the names of the
tablespaces.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: , NOPARALLEL, PARALLEL
Default: ''
Enables or disables parallel processing when the table is created. Also
enables or disables parallel processing or access. The default is PARALLEL.
Name: PARALLEL_DEGREE
Type: STRING
Valid Values: N/A
Default: ''
Enter degree of parallelism, which is the number of parallel threads used
in the parallel operation.
Name: PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
Enter a comma separated list of tablespaces. For simple-partitoned object,
it is used for HASH BY QUANTITY partition tablespaces. For
composite-partitioned tables, it is used for subpartition template to store
a list of tablespaces.
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the percentage (0-99) of space in each
data block of the database object reserved for future updates to the rows
of the object. The default is 10.
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: PCTUSED
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the minimum percentage (0-99) of used
space that Oracle maintains for each data block of the database object. The
default is 40.
Name: ROWDEPENDENCIES_MODE
Type: STRING
Valid Values: , NOROWDEPENDENCIES, ROWDEPENDENCIES
Default: ''
Specify ROWDEPENDENCIES to use row-level dependency tracking.
Name: ROW_MOVEMENT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify whether Oracle can move a table row.
Name: SHADOW_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Name: SHADOW_TABLE_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the shadow table name to specify the name of Shadow Table.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Properties for PRIMARY_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.INDEXTABLESPACE:DESCRIPTION"
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.USINGINDEX:DESCRIPTION"
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for UNIQUE_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.INDEXTABLESPACE:DESCRIPTION"
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.USINGINDEX:DESCRIPTION"
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for FOREIGN_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: ONDELETE
Type: STRING
Valid Values: , CASCADE, SET NULL
Default: ''
Specify CASCADE if you want Oracle to remove dependent foreign key values.
Specify SET NULL if you want Oracle to convert dependent foreign key values
to NULL.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for CHECK_CONSTRAINT:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for PARTITION:
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for table or partition object. The
default is DEFAULT.
Name: DATA_SEGMENT_COMPRESSION
Type: STRING
Valid Values: , COMPRESS, NOCOMPRESS
Default: ''
Use this clause to instruct Oracle whether to compress data segments to
reduce disk use. The default is NOCOMPRESS.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
table, partition, cluster, or index.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (1-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 1 for Table and 2 for Index.
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Specify whether the creation of the table and of any indexes required
because of constraints, partition, or LOB storage characteristics will be
logged in the redo log file (LOGGING) or not (NOLOGGING). The default is
LOGGING.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the object.
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (1-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: OPTIMAL
Type: STRING
Valid Values: N/A
Default: ''
Specifies an optimal size in bytes for a rollback segment. Use K or M to
specify this size in kilobytes or megabytes. Specify NULL for no optimal
size for the rollback segment. The default is NULL.
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the percentage (0-99) of space in each
data block of the database object reserved for future updates to the rows
of the object. The default is 10.
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: PCTUSED
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the minimum percentage (0-99) of used
space that Oracle maintains for each data block of the database object. The
default is 40.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Properties for INDEX:
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for table or partition object. The
default is DEFAULT.
Name: COMPUTESTATISTICS
Type: STRING
Valid Values: , NO, YES
Default: ''
Specify YES to collect statistics at relatively little cost during the
creation of an index.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
table, partition, cluster, or index. The default is 1.
Name: INDEXORDER
Type: STRING
Valid Values: , ASC, DESC
Default: ''
Use ASC or DESC to indicate whether the index should be created in
ascending or descending order. The Oracle default is ASC.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (2-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 2 for Index.
Name: KEYCOMPRESS
Type: STRING
Valid Values: , COMPRESS, NOCOMPRESS
Default: ''
Specify COMPRESS to enable key compression.
Name: KEYCOMPRESSPREFIXLENGTH
Type: STRING
Valid Values: N/A
Default: ''
Specify the prefix length (number of prefix columns to compress). For
unique indexes, the valid range of prefix length values is from 1 to the
number of key columns minus 1. The default prefix length is the number of
key columns minus 1. For nonunique indexes, the valid range of prefix
length values is from 1 to the number of key columns. The default prefix
length is the number of key columns. Oracle compresses only nonpartitioned
indexes that are nonunique or unique indexes of at least two columns. You
cannot specify COMPRESS for a bitmap index.
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Specify whether the creation of the table and of any indexes required
because of constraints, partition, or LOB storage characteristics will be
logged in the redo log file (LOGGING) or not (NOLOGGING). The default is
LOGGING.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the object.
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (2-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: ONLINE
Type: STRING
Valid Values: , NO, YES
Default: ''
Specify YES to indicate that DML operations on the table will be allowed
during creation of the index.
Name: OPTIMAL
Type: STRING
Valid Values: N/A
Default: ''
Specifies an optimal size in bytes for a rollback segment. Use K or M to
specify this size in kilobytes or megabytes. Specify NULL for no optimal
size for the rollback segment. The default is NULL.
Name: OVERFLOW
Type: STRING
Valid Values: N/A
Default: ''
Enter a comma separated list of Index tablespaces for overflow data. For
simple-partitoned object, it is used for HASH BY QUANTITY partition
overflow Index tablespaces. The number of Index tablespaces does not have
to equal the number of partitions. If the number of partitions is greater
than the number of Index tablespaces, then Oracle cycles through the names
of the Index tablespaces.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: , NOPARALLEL, PARALLEL
Default: ''
Enables or disables parallel processing when the table is created. Also
enables or disables parallel processing or access. The default is PARALLEL.
Name: PARALLEL_DEGREE
Type: STRING
Valid Values: N/A
Default: ''
Enter degree of parallelism, which is the number of parallel threads used
in the parallel operation.
Name: PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
Enter a comma separated list of tablespaces for a locally partitioned
index. For simple-partitoned object, it is used for HASH BY QUANTITY
partition tablespaces. If specified, then individual local Hash index
partitions specified will be ignored for Local Hash or Range-Hash Index
partitioning.
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the percentage (0-99) of space in each
data block of the database object reserved for future updates to the rows
of the object. The default is 10.
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: SORT
Type: STRING
Valid Values: , NOSORT, REVERSE, SORT
Default: ''
Specify NOSORT to indicate to Oracle that the rows are already stored in
the database in ascending order. Specify REVERSE to store the bytes of the
index block in reverse order, excluding the rowid.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addColumnClauseForAlter
This clause adds a column at a particular position.
When you alter a table and add columns to it, the position you specify for
a new column must be less than or equal to the number of columns added up
to that point in the OMBALTER command.
For example, a table TEMP_TAB contains three columns. You use the following
OMBALTER TABLE command to add three more columns:
OMBALTER TABLE 'TEMP_TAB' \
ADD COLUMN 'C4' AT POSITION 4 \
SET PROPERTIES(DATATYPE,PRECISION) VALUES('NUMBER',7) \
ADD COLUMN 'C5' AT POSITION 6 \
SET PROPERTIES(DATATYPE) VALUES('VARCHAR2') \
ADD COLUMN 'C6' AT POSITION 5 \
SET PROPERTIES(DATATYPE,PRECISION) VALUES('NUMBER',10);
This command does not execute successfully because at the point when you
specify the position of the column C5 as 6, the table is contains only 5
columns.
QUOTED_STRING
The column name.
addConstraintClause
Adds primary and unique key, and add check constraints.
addSCOClause
This clause will add SCOs.
addDataRuleUsageClause
Add a data rule usage to the relation.
modifyColumnClause
This clause renames, set properties, and move columns.
modifyConstraintClause
This clause modifies keys and check constraints
modifySCOClause
This clause will modify SCOs.
modifyDataRuleUsageClause
Rename or modify the properties of a data rule usage.
deleteColumnClause
This clause deletes a column.
deleteConstraintClause
This clause deletes a key or check constraint.
deleteSCOClause
This clause deletes a SCO.
QUOTED_STRING
Either index, partition, partition_key, or index column name.
deleteDataRuleUsageClause
Delete a data rule usage.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
addUkPkClause
This clause adds the adds unique key and primary keys.
QUOTED_STRING
name of the unique key or primary key.
addFkClause
This clause adds foreign key.
QUOTED_STRING
Name of the foreign key.
addCheckConstraintClause
add a check constraint.
QUOTED_STRING
Name of the CheckConstraint.
addIndexClause
This clause adds an index.
QUOTED_STRING
Name of the index.
addPartitionClause
This clause adds a partition.
QUOTED_STRING
Name of the partition.
addPartitionKeyClause
This clause adds a partition key.
QUOTED_STRING
Name of the partition key. This should be a column identifier.
addIndexColumnClause
This clause will add index column to a specified index.
QUOTED_STRING
This should be a column identifier of owning object (such as a table) of
the index.
moveToClause
This clause will move the column to given position.
modifyUkPkClause
It modifies unique or primary key.
modifyFkClause
This clause modifies the foreign key.
modifyCheckConstraintClause
This clause modifies the check constraint.
modifyIndexClause
This clause modifies the Index.
QUOTED_STRING
Name of the index.
modifyPartitionClause
This clause modifies a partition.
QUOTED_STRING
Name of the partition.
modifyPartitionKeyClause
This clause modifies a partition key.
QUOTED_STRING
Name of the partition key.
modifyIndexColumnClause
Modifies the Index Column. The first quoted_string in this clause denotes
index column name, and the latter denotes index.
propertyValue
This clause adds the property values.
setUkPkPropertiesAndReferencesColumnsClauses
This clause adds properties and references to columns.
setFkSubClauses
This clause set references to a foreign key.
setSCOConfigurationPropertiesClauses
Set the configuration properties for the following:
- Partition, Subpartition, and Template Subpartition: All refer to
configuration properties of Partition.
- Index, and Index Partition: For Index Partition, refer to configuration
properties of Partition.
renameSCOConfigurationClause
This clause renames configuration objects.
constraintColumnReferencesClause
This clause provides names of all columns.
setFkReferencesClauses
This clause sets foreign key references.
quotedNameList
This clause gives column names.
constraintUkReferencesClause
The first QUOTED_STRING denotes the UniqueKey or Primay key name, and the
latter denotes the table's or view's name.
See Also
OMBALTER, OMBCREATE TABLE, OMBDROP TABLE, OMBRETRIEVE TABLE
Purpose
This command alter a time dimension.
Prerequisites
Should be in Oracle Module context.
Syntax
alterTimeDimensionCommand = OMBALTER TIME_DIMENSION "TimeDimensionName" (
( "renameDimensionClause" [ "setPropertiesClause" ] |
"setPropertiesClause" ) | "setFiscalPropertyClause" |
"renameMapClause" | "useSequenceClause" | ( "addDimensionRoleClause" |
DELETE ( "deleteDimensionRoleClause" | "deleteLevelClause" ) | MODIFY
( "modifyDimensionRoleClause" | "modifyLevelClause" ) )+ | ( {
"addCalendarHierarchyClause" | "modifyCalendarHierarchyClause" |
"addFiscalCalendarHierarchyClause" |
"modifyFiscalCalendarHierarchyClause" | "deleteHierarchyClause" } [
"implementationClause" ] [ "populationClause" ] ) )
TimeDimensionName = "QUOTED_STRING"
renameDimensionClause = RENAME DIMENSION TO "QUOTED_STRING"
setPropertiesClause = SET PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setFiscalPropertyClause = "setFiscalPropertiesClause"
renameMapClause = RENAME MAPPING TO "QUOTED_STRING"
useSequenceClause = SET REF SEQUENCE "QUOTED_STRING"
addDimensionRoleClause = ADD DIMENSION_ROLE "roleName" [
"setPropertiesClause" ]
deleteDimensionRoleClause = DIMENSION_ROLE "roleName"
deleteLevelClause = "levelLocator"
modifyDimensionRoleClause = DIMENSION_ROLE "roleName" RENAME TO "roleName"
[ "setPropertiesClause" ]
modifyLevelClause = "levelLocator" ( "renameClause" [
"setPropertiesClause" ] )
addCalendarHierarchyClause = ADD ( ( NORMAL_CALENDAR HIERARCHY
"hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE )
"normalCalendarLevelList" ) | ( WEEK_CALENDAR HIERARCHY
"hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE )
"weekCalendarLevelList" ) )
modifyCalendarHierarchyClause = MODIFY ( ( NORMAL_CALENDAR
"hierarchyLocator" ( [ "renameClause" ] [ "setPropertiesClause" ] SET
( REF | REFERENCE ) "normalCalendarLevelList" ) ) | ( WEEK_CALENDAR
"hierarchyLocator" [ "renameClause" ] [ "setPropertiesClause" ] SET (
REF | REFERENCE ) "weekCalendarLevelList" ) )
addFiscalCalendarHierarchyClause = ADD FISCAL_CALENDAR HIERARCHY
"hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE )
"fiscalCalendarLevelList"
modifyFiscalCalendarHierarchyClause = MODIFY FISCAL_CALENDAR
"hierarchyLocator" [ "renameClause" ] [ "setPropertiesClause" ] SET (
REF | REFERENCE ) "fiscalCalendarLevelList"
deleteHierarchyClause = DELETE "hierarchyLocator"
implementationClause = IMPLEMENTED BY ( STAR | SNOWFLAKE ) [ USING
COMPOSITE_UNIQUE_KEY ]
populationClause = POPULATE DATA FROM "calendarYear" FOR "yearCount" YEARS
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
setFiscalPropertiesClause = SET FISCAL_CALENDAR PROPERTIES
"propertyKeyList" VALUES "propertyValueList"
roleName = "QUOTED_STRING"
levelLocator = LEVEL "levelName"
renameClause = RENAME TO "QUOTED_STRING"
hierarchyName = "QUOTED_STRING"
normalCalendarLevelList = "(" ( "normalCalendarLevelType" LEVEL [
"levelName" ] [ "setPropertiesClause" ] ) { ","
"normalCalendarLevelType" LEVEL [ "levelName" ] [
"setPropertiesClause" ] } ")"
weekCalendarLevelList = "(" ( "weekCalendarLevelType" LEVEL [ "levelName"
] [ "setPropertiesClause" ] ) { "," "weekCalendarLevelType" LEVEL [
"levelName" ] [ "setPropertiesClause" ] } ")"
hierarchyLocator = HIERARCHY "hierarchyName"
fiscalCalendarLevelList = "(" ( "fiscalCalendarLevelType" LEVEL [
"levelName" ] [ "setPropertiesClause" ] ) { ","
"fiscalCalendarLevelType" LEVEL [ "levelName" ] [
"setPropertiesClause" ] } ")"
calendarYear = "INTEGER_LITERAL"
yearCount = "INTEGER_LITERAL"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
levelName = "QUOTED_STRING"
normalCalendarLevelType = ( DAY | CALENDAR_MONTH | CALENDAR_QUARTER |
CALENDAR_YEAR )
weekCalendarLevelType = ( DAY | CALENDAR_WEEK )
fiscalCalendarLevelType = ( DAY | FISCAL_WEEK | FISCAL_MONTH |
FISCAL_QUARTER | FISCAL_YEAR )
Keywords And Parameters
TimeDimensionName
The name of the time dimension.
renameDimensionClause
This clause renames the time dimension.
setPropertiesClause
This clause sets the following properties:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
setFiscalPropertyClause
set the fiscal properties.
renameMapClause
This clause renames the map that is created by the OMBCREATE TIME_DIMENSION
command.
useSequenceClause
This clause sets the Sequence.
addDimensionRoleClause
This clause adds a dimension role.
deleteDimensionRoleClause
This clause deletes a dimension role.
deleteLevelClause
This clause finds the level to be deleted.
modifyDimensionRoleClause
This clause allows to rename the dimension role, or it change the dimension
role's properties.
modifyLevelClause
This clause modifies level by either renaming it, or setting level
properties.
addCalendarHierarchyClause
This clause adds a new hierarchy to the time dimension by: renaming the
hierarchy, setting of hierarchy properties, or setting level references.
modifyCalendarHierarchyClause
This clause modifies a hierarchy of the time dimension by: renaming the
hierarchy, setting of hierarchy properties, or setting level references.
addFiscalCalendarHierarchyClause
This clause adds an fiscal hierarchy to the time dimension.
modifyFiscalCalendarHierarchyClause
This clause modifies a fiscal hierarchy of the time dimension by: renaming
the fiscal hierarchy, setting of fiscal hierarchy properties, or setting
fiscal level references.
implementationClause
Time Dimension is implemented as STAR or as SNOWFLAKE.
populationClause
This clause specifies the starting year and the number of years for which
data will be populated.
propertyKeyList
A list of time dimension properties.
propertyValueList
A list of time dimension property values.
setFiscalPropertiesClause
This clause sets the following properties:
Fiscal types allowed in OWB time dimension. Name: FISCAL_TYPE
Type: STRING
Valid Values: '544', '445'
Default: '544'
Fiscal calendar year start date, it could be any date of a year.
Name: FISCAL_CALENDAR_START_YEAR
Type: STRING
Valid Values: Dates in these format 'DD-MON-YYYY' or 'DD-MM-YYYY'
Default: '01-JAN-2000'
The day of the week when the fiscal year begins.
Name: FISCAL_CALENDAR_START_DAY_OF_WEEK
Type: STRING
Valid Values: 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY',
'SATURDAY', 'SUNDAY'
Default: 'false'
roleName
A role name.
levelLocator
This clause gets the level.
hierarchyName
The name of a hierarchy.
hierarchyLocator
This clause gets the hierarchy.
fiscalCalendarLevelList
This clause creates a fiscal hierarchy and sets reference fiscal levels.
propertyKey
Basic properties for TIME DIMENSION, TIME DIMENSION MAP,
DIMENSION_ATTRIBUTE, LEVEL, LEVEL_ATTRIBUTE and HIERARCHY:
Basic properties for TIME DIMENSION :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Time Dimension
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Time Dimension
Name: STORAGE
Type: STRING
Valid Values: 'RELATIONAL', 'AW'
Default: 'RELATIONAL'
The storage of a dimension can be AW or relational
Name: AW_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
Set the analytical workspace name where the dimension is implemented
Name: AW_DIMENSION_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
Set the Analytical Workspace dimension physical object name
Basic properties for TIME MAP :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Time Dimension Map
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Time Dimension Map
Basic properties for DIMENSION_ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Dimension_Attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Properties for DIMENSION:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: DEPLOYMENT_OPTIONS
Type: STRING
Valid Values: DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY, DEPLOY_TO_CATALOG_ONLY
Default: DEPLOY_DATA_OBJECTS_ONLY
Warehouse Builder generates a set of scripts for Dimension, they are DDL
Scripts for Relational Dimensional or Scripts for ROLAP or or Scripts for
AW.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: VIEW_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
Name of the view that is generated to hide the control rows on the
dimension implementation table of a star schema. If this field is left
blank, the view name will default to '<Name of Dimension>_v'
Name: VISIBLE
Type: BOOLEAN
Valid Values: true, false
Default: true
The Dimension is visible to OLAP end user if value is set = true.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
See Also
OMBCREATE TIME_DIMENSION, OMBDROP TIME_DIMENSION, OMBRETRIEVE TIME_DIMENSION
Purpose
To alter the definision of a transportable module.
Prerequisites
In the context of a project.
Syntax
alterTMCommand = OMBALTER TRANSPORTABLE_MODULE "QUOTED_STRING" (
"alterTMClause" { "alterTMClause" } )
alterTMClause = "renameClause" | "setPropertiesAndLocationsAndIconSet" |
"unsetReferenceIconSetClause" | "modifyClause"
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesAndLocationsAndIconSet = SET ( "setPropertiesClause" |
"setSourceLocationClause" | "setTargetLocationClause" |
"setReferenceIconSetClause" )
unsetReferenceIconSetClause = UNSET ( REF | REFERENCE ) ICONSET
modifyClause = MODIFY ( "modifyTablespaceClause" | "modifyDatafileClause"
| "modifySchemaClause" )
setPropertiesClause = ( PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")" )
setSourceLocationClause = SOURCE_LOCATION "QUOTED_STRING"
setTargetLocationClause = TARGET_LOCATION "QUOTED_STRING"
setReferenceIconSetClause = ( REF | REFERENCE ) ICONSET "QUOTED_STRING"
modifyTablespaceClause = TRANSPORTABLE_MODULE_TABLESPACE "QUOTED_STRING"
modifyDatafileClause = DATAFILE "QUOTED_STRING"
modifySchemaClause = TRANSPORTABLE_MODULE_SCHEMA "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterTMCommand
This command is for altering a transportable module.
QUOTED_STRING
The name of the transportable module to be altered.
alterTMClause
Multiple altering actions can be specified with one OMBALTER
TRANSPORTABLE_MODULE command.
renameClause
Change the name of the transportable module
QUOTED_STRING
The new name for the transportable module.
setPropertiesAndLocationsAndIconSet
Set properties for the transportable module, and/or specify source and
target locations, and/or specify icon set for the newly create
transportable module.
unsetReferenceIconSetClause
Remove the reference to the icon set.
modifyClause
Change contents within a transportable module.
setPropertiesClause
Set properties for the transportable module.
Basic properties for TRANSPORTABLE_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of the transportable module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description for the transportable module
Properties for TRANSPORTABLE_MODULE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: TARGET_OS_TYPE
Type: STRING
Valid Values: Linux, Unix, Windows
Default: Unix
The operating system type of the target machine. This is needed for
generating shell scripts in correct style required by the OS.
Name: TRANSPORT_TABLESPACE
Type: BOOLEAN
Valid Values: true, false
Default: true
Specifies whether transportable tablespace (TTS) feature is to be used for
deploying tables in the transportable module. If set to true, tablespaces
are copied from source to target using the server TTS mechanism. If set to
false, tables are individually extracted and deployed using Oracle Data
Pump available in Oracle10g or later; but tablespaces are not transported.
Since Oracle Data Pump is new in Oracle 10g, setting this parameter to
false is only allowed if both source and target databases are with Oracle
10g or a higher versions.
Name: WHAT_TO_DEPLOY
Type: STRING
Valid Values: ALL_OBJECTS, TABLES_ONLY
Default: ALL_OBJECTS
Specifies whether only tables in the transportable module are deployed or
everything in it is deployed.
Name: WORK_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ''
The full path of work directory on target machine, where temporary files,
logs and tablespace datafiles may be stored. If left unspecified, OWB's
runtime home directory is used as the work directory. It is highly
recommended that users specify dedicated directory for transportable module
deployment.
Properties for TRANSPORTABLE_MODULE_TABLESPACE:
Name: DROP_EXISTING_TABLESPACE
Type: BOOLEAN
Valid Values: true, false
Default: false
If this parameter is set to true, existing tablespace in target is dropped
and recreated.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: TARGET_TABLESPACE_NAME
Type: STRING
Valid Values: N/A
Default: DEFAULT
Tablespace name in the target database. Target tablespace name must be same
with source tablespace name prior to Oracle 10.2.
Properties for TRANSPORTABLE_MODULE_DATAFILE:
Name: DIRECTORY
Type: STRING
Valid Values: N/A
Default: ''
The directory on target machine where the datafile will be created. If left
unspecified, the target work directory is used for storing the datafile
that is transported from source machine.
Name: FILENAME
Type: STRING
Valid Values: N/A
Default: DEFAULT
The name of the new file on target. Please check to see if there is already
a file with same name in the same directory. Transportable tablespace
deployement may overwrite any existing files.
Name: REUSE
Type: BOOLEAN
Valid Values: true, false
Default: false
If this parameter is set to true, existing datafile is overwritten. If set
to false, overwriting existing file is not allowed. In this case, if an
existing file exists, deployment will abort.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setSourceLocationClause
Specify the source location name.
QUOTED_STRING
The name of an already created transportable module source location.
setTargetLocationClause
Specify the target location name.
QUOTED_STRING
The name of an already created transportable module target location.
setReferenceIconSetClause
Set the icon set for the new transportable module.
QUOTED_STRING
The name of the icon set.
modifyTablespaceClause
Modify a tablespace within a transportable module.
QUOTED_STRING
The tablespace name. Note that the tablespace name is its name in the
source database.
modifyDatafileClause
Modify a datafile within a transportable module.
QUOTED_STRING
The name of the datafile. Note that the datafile name is its full path name
in the source database. The name must be exactly same with what is in
DBA_DATA_FILES view in the source database.
modifySchemaClause
Modify a schema within a transportable module.
QUOTED_STRING
The name of the schema. Note that the schema name is its name in the source
database.
propertyNameList
The list of unquoted property names.
propertyValueList
The list of property values.
propertyValue
A property value can be a single-quoted string, an integer, or a floating
point number.
See Also
OMBALTER, OMBCREATE TRANSPORTABLE_MODULE, OMBRETRIEVE TRANSPORTABLE_MODULE, OMBDROP TRANSPORTABLE_MODULE
Purpose
To alter properties of a Warehouse Builder user.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
alterUserCommand = OMBALTER ( USER "QUOTED_STRING" ( SET
"setPropertiesClause" ) )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterUserCommand
This clause alters a Warehouse Builder user.
setPropertiesClause
Used to set properties of a Warehouse Builder user. Valid properties are
shown below.
Basic properties for USER:
Name: PROMPT_FOR_COMMIT
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: PROMPT_FOR_JOB_NAME
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: PROMPT_FOR_EXECUTION_PARAMS
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_MONITOR
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_DEPLOYMENT_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_DEPLOYMENT_DEPENDENCIES
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_MONITOR_RESULTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: SHOW_MONITOR_LOGFILE
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: PERSONALITY
Type: STRING
Valid Values: N/A
Default: Default
Name: SHOW_GUIDED_ASSISTANCE
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: HIDE_WIZARD_WELCOME_PAGES
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_DELETE_CONFIRMATION
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: RECYCLE_DELETED_OBJECTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: EMPTY_RECYCLE_BIN
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: CLEAR_CLIPBOARD
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: SHOW_GENERATION_PROJECT
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: SHOW_GENERATION_MODULE
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: SHOW_GENERATION_LOCATION
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_GENERATION_ACTION
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_GENERATION_TYPE
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: LOG_FILE_PATH
Type: STRING(1000)
Valid Values: N/A
Default: ''
Name: LOG_FILE_NAME
Type: STRING(1000)
Valid Values: N/A
Default: log
Name: LOG_FILE_MAX_SIZE
Type: STRING
Valid Values: 1-10000000
Default: 100
Name: LOG_ERROR_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: LOG_WARNING_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: LOG_INFORMATION_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: NAMING_MODE
Type: STRING
Valid Values: PHYSICAL_NAMING_MODE, BUSINESS_NAMING_MODE
Default: PHYSICAL_NAMING_MODE
Name: PROPAGATE_NAME_CHANGES
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: DESIGNREPOS_PWD_PERSIST
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: RUNTIMEREPOS_PWD_SHARE
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: DEFAULT_SEC_POLICY
Type: STRING
Valid Values: MINIMUM_SECURITY, MAXIMUM_SECURITY
Default: MINIMUM_SECURITY
See Also
OMBREGISTER USER, OMBUNREGISTER USER, OMBRETRIEVE USER
Purpose
Alter the Varying Array by resetting its properties.
Prerequisites
Should be in the context of an Oracle Module.
Syntax
alterVaryingArrayCommand = OMBALTER ( VARYING_ARRAY "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] |
"alterPropertiesOrIconSetClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
renameClause
renames a table with a different name.
setPropertiesClause
Basic properties for VARYING_ARRAY:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Varying Array
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Varying Array
Name: DATATYPE
Type: STRING(20)
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, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Base Element of the Varying Array
Properties for VARYING_ARRAY:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBCREATE VARYING_ARRAY, OMBDROP VARYING_ARRAY
Purpose
To alter properties and definition of a view.
Prerequisites
In the context of an Oracle Module.
Syntax
alterViewCommand = OMBALTER ( VIEW "QUOTED_STRING" ( "renameClause" [
"alterPropertiesOrIconSetClause" ] [ "alterViewSCOandDependentClauses"
] | "alterPropertiesOrIconSetClause" [
"alterViewSCOandDependentClauses" ] |
"alterViewSCOandDependentClauses" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause"
alterViewSCOandDependentClauses = ADD ( "addColumnClauseForAlter" [
"alterViewSCOandDependentClauses" ] | "addViewConstraintClause" {
"alterViewConstraintClauses" } | "addDataRuleUsageClause" {
"alterDataRuleUsageClauses" } | "addRelationalDependentClause" [
"alterViewSCOandDependentClauses" ] ) | MODIFY ( "modifyColumnClause"
[ "alterViewSCOandDependentClauses" ] | "modifyViewConstraintClause" {
"alterViewConstraintClauses" } | "modifyDataRuleUsageClause" {
"alterDataRuleUsageClauses" } ) | DELETE ( "deleteColumnClause" [
"alterViewSCOandDependentClauses" ] | "deleteViewConstraintClause" {
"alterViewConstraintClauses" } | "deleteDataRuleUsageClause" {
"alterDataRuleUsageClauses" } | "deleteRelationalDependentClause" [
"alterViewSCOandDependentClauses" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ICONSET
addColumnClauseForAlter = COLUMN "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
addViewConstraintClause = "addUkPkClause" | "addFkClause"
alterViewConstraintClauses = ADD "addViewConstraintClause" | MODIFY
"modifyViewConstraintClause" | DELETE "deleteViewConstraintClause"
addDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" SET REF DATA_RULE
"QUOTED_STRING" ( GROUP "QUOTED_STRING" SET REF ( TABLE | VIEW |
MATERIALIZED_VIEW | EXTERNAL_TABLE ) "QUOTED_STRING" ( ATTRIBUTE
"QUOTED_STRING" SET REF COLUMN "QUOTED_STRING" )+ )+ [ SET
"setPropertiesClause" ]
alterDataRuleUsageClauses = ADD "addDataRuleUsageClause" | MODIFY
"modifyDataRuleUsageClause" | DELETE "deleteDataRuleUsageClause"
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING"
modifyColumnClause = COLUMN "QUOTED_STRING" ( "renameClause" [
"moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET
"setPropertiesClause" ] | SET "setPropertiesClause" )
modifyViewConstraintClause = "modifyUkPkClause" | "modifyFkClause"
modifyDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
deleteColumnClause = COLUMN "QUOTED_STRING"
deleteViewConstraintClause = UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY
"QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING"
deleteDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING"
deleteRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET
"setUkPkPropertiesAndReferencesColumnsClauses" ]
addFkClause = FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ]
moveToClause = MOVE TO POSITION "INTEGER_LITERAL"
modifyUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" (
"renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ]
| SET "setUkPkPropertiesAndReferencesColumnsClauses" )
modifyFkClause = FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET
"setFkSubClauses" ] | SET "setFkSubClauses" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setUkPkPropertiesAndReferencesColumnsClauses = "setPropertiesClause" [ SET
( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF |
REFERENCE ) "constraintColumnReferencesClause"
setFkSubClauses = "setPropertiesClause" [ SET ( REF | REFERENCE )
"setFkReferencesClauses" ] | ( REF | REFERENCE )
"setFkReferencesClauses"
constraintColumnReferencesClause = COLUMNS "(" "quotedNameList" ")"
setFkReferencesClauses = "constraintColumnReferencesClause" [ SET ( REF |
REFERENCE ) "constraintUkReferencesClause" ] |
"constraintUkReferencesClause" [ SET ( REF | REFERENCE )
"constraintColumnReferencesClause" ]
quotedNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
constraintUkReferencesClause = ( UNIQUE_KEY | PRIMARY_KEY )
"QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ]
Keywords And Parameters
alterViewCommand
This clause alters a view.
QUOTED_STRING
name of the view.
renameClause
renames a table with a different name.
alterViewSCOandDependentClauses
This clause alters the view clause.
setPropertiesClause
Used to set properties (core, logical, physical, user-defined) for views
and their columns, unique keys, foreign keys, and primary keys.
Note:
Constraints can be specified but will not be generated for either View or
Materialized View in this release.
Basic properties for VIEW, MATERIALIZED_VIEW:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the View, MaterializedView
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the View, MaterializedView
Name: VIEW_QUERY
Type: STRING(4000)
Valid Values: N/A
Default: ''
Sets the query definition in View and MaterializedView.
Properties for VIEW:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: SHADOW_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Name: SHADOW_TABLE_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the shadow table name to specify the name of Shadow Table.
Properties for UNIQUE_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.INDEXTABLESPACE:DESCRIPTION"
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.USINGINDEX:DESCRIPTION"
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for FOREIGN_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: ONDELETE
Type: STRING
Valid Values: , CASCADE, SET NULL
Default: ''
Specify CASCADE if you want Oracle to remove dependent foreign key values.
Specify SET NULL if you want Oracle to convert dependent foreign key values
to NULL.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addColumnClauseForAlter
This clause adds a column at a particular position.
When you alter a table and add columns to it, the position you specify for
a new column must be less than or equal to the number of columns added up
to that point in the OMBALTER command.
For example, a table TEMP_TAB contains three columns. You use the following
OMBALTER TABLE command to add three more columns:
OMBALTER TABLE 'TEMP_TAB' \
ADD COLUMN 'C4' AT POSITION 4 \
SET PROPERTIES(DATATYPE,PRECISION) VALUES('NUMBER',7) \
ADD COLUMN 'C5' AT POSITION 6 \
SET PROPERTIES(DATATYPE) VALUES('VARCHAR2') \
ADD COLUMN 'C6' AT POSITION 5 \
SET PROPERTIES(DATATYPE,PRECISION) VALUES('NUMBER',10);
This command does not execute successfully because at the point when you
specify the position of the column C5 as 6, the table is contains only 5
columns.
QUOTED_STRING
The column name.
addViewConstraintClause
This clause adds the view's configuration clause.
alterViewConstraintClauses
This clause alters the view's constraint clause.
addDataRuleUsageClause
Add a data rule usage to the relation.
alterDataRuleUsageClauses
Add, modify, or delete data rule usages.
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
modifyColumnClause
This clause renames, set properties, and move columns.
modifyViewConstraintClause
This clause modifies the view's constraint clause.
modifyDataRuleUsageClause
Rename or modify the properties of a data rule usage.
deleteColumnClause
This clause deletes a column.
deleteViewConstraintClause
This clause deletes the view's constraint.
deleteDataRuleUsageClause
Delete a data rule usage.
deleteRelationalDependentClause
This clause deletes referential dependencies to other relational objects.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
addUkPkClause
This clause adds the adds unique key and primary keys.
QUOTED_STRING
name of the unique key or primary key.
addFkClause
This clause adds foreign key.
QUOTED_STRING
Name of the foreign key.
moveToClause
This clause will move the column to given position.
modifyUkPkClause
It modifies unique or primary key.
modifyFkClause
This clause modifies the foreign key.
propertyValue
This clause adds the property values.
setUkPkPropertiesAndReferencesColumnsClauses
This clause adds properties and references to columns.
setFkSubClauses
This clause set references to a foreign key.
constraintColumnReferencesClause
This clause provides names of all columns.
setFkReferencesClauses
This clause sets foreign key references.
quotedNameList
This clause gives column names.
constraintUkReferencesClause
The first QUOTED_STRING denotes the UniqueKey or Primay key name, and the
latter denotes the table's or view's name.
See Also
OMBALTER, OMBCREATE VIEW, OMBDROP VIEW, OMBRETRIEVE VIEW
