3.1.4.2.2.1.3.7.1 Columns

  • Article

The MDSCHEMA_HIERARCHIES rowset contains the following columns.

Name

Type

Restriction

Description

CATALOG_NAME

xsd:string

Yes

The name of the database.

SCHEMA_NAME

xsd:string

Yes

The name of the schema.<222>

CUBE_NAME

xsd:string

Yes

The name of the cube.

DIMENSION_UNIQUE_NAME

xsd:string

Yes

The unique name of the dimension.<223>

HIERARCHY_NAME

xsd:string

Yes

The name of the hierarchy. This column MAY<224> be blank if there is only a single hierarchy in the dimension.

HIERARCHY_UNIQUE_NAME

xsd:string

Yes

The unique name of the hierarchy.

HIERARCHY_GUID

uuid

The GUID of the hierarchy.

HIERARCHY_CAPTION

xsd:string

The caption of the hierarchy.

DIMENSION_TYPE

xsd:short

The type of the dimension.

  • 0 - UNKNOWN

  • 1 - TIME

  • 2 - MEASURE

  • 3 - OTHER

  • 5 - QUANTITATIVE

  • 6 - ACCOUNTS

  • 7 - CUSTOMERS

  • 8 - PRODUCTS

  • 9 - SCENARIO

  • 10 - UTILITY

  • 11 - CURRENCY

  • 12 - RATES

  • 13 - CHANNEL

  • 14 - PROMOTION

  • 15 - ORGANIZATION

  • 16 - BILL_OF_MATERIALS

  • 17 - GEOGRAPHY

HIERARCHY_CARDINALITY

xsd:unsignedInt

The number of members in the hierarchy.

DEFAULT_MEMBER

xsd:string

The default member for this hierarchy.

ALL_MEMBER

xsd:string

The member name at the highest level of the hierarchy.

DESCRIPTION

xsd:string

A description of the hierarchy.

STRUCTURE

xsd:short

The structure of the hierarchy.

Valid values are defined in the following table.

  • 0 - Hierarchy is a fully balanced structure.

  • 1 - Hierarchy is a ragged balanced structure.

  • 2 - Hierarchy is an unbalanced structure.

  • 3 - Hierarchy is a network structure.

For more information, see the definitions for balanced hierarchy and unbalanced hierarchy in section 1.1.

IS_VIRTUAL

xsd:boolean

When true, indicates that the hierarchy is a virtual hierarchy; otherwise false.<225>

IS_READWRITE

xsd:boolean

When true, indicates that write back to the hierarchy is enabled; otherwise false.

DIMENSION_UNIQUE_SETTINGS

xsd:int

A list of values that specifies which columns contain unique values:<226>

  • 0x00000001 - Member key columns establish uniqueness.

  • 0x00000002 - Member name columns establish uniqueness.

DIMENSION_MASTER_UNIQUE_NAME

xsd:string

The unique name of the master dimension.<227>

DIMENSION_IS_VISIBLE

xsd:boolean

When true, indicates that the dimension is visible; otherwise false.<228>

HIERARCHY_ORDINAL

xsd:unsignedInt

The ordinal number of the hierarchy across all hierarchies of the dimension.

DIMENSION_IS_SHARED

xsd:boolean

When true, indicates that the dimension is shared; otherwise false.<229>

HIERARCHY_IS_VISIBLE

xsd:boolean

When true, indicates that the hierarchy is visible; otherwise false.

HIERARCHY_ORIGIN

xsd:unsignedShort

Yes

A bitmask that determines the source of the hierarchy.

  • 0x0001 - Identifies user-defined hierarchies.

  • 0x0002 - Identifies attribute hierarchies.

  • 0x0004 - Identifies key attribute hierarchies.

  • 0x0008 - Identifies attributes with no attribute hierarchies.

  • 0x0003 - The default restriction value.

HIERARCHY_DISPLAY_FOLDER

xsd:string

Display folder for the hierarchy.

INSTANCE_SELECTION

xsd:unsignedShort

A list of values that provides a hint to the client application about how to display the hierarchy values. Valid values include the following:

  • 0 - NONE (No hint is suggested.)

  • 1 - DROPDOWN type of display is suggested.

  • 2 - LIST type of display is suggested.

  • 3 - FILTERED LIST type of display is suggested.

  • 4 - MANDATORY FILTER type of display is suggested

GROUPING_BEHAVIOR

xsd:unsignedShort

Recommends to client applications how to build queries within the hierarchy. Valid values include the following:

  • 1 - Client applications are encouraged to group by each member of the hierarchy.

  • 2 - Client applications are discouraged from grouping by each member of the hierarchy.

STRUCTURE_TYPE

xsd:string

Indicates the type of hierarchy. Valid values include the following:

  • Natural

  • Unnatural

  • Unknown

The response has the following definition.

       <xsd:element name="root">
         <xsd:complexType>
           <xsd:sequence minOccurs="0" maxOccurs="unbounded">
             <xsd:element name="row" type="row" />
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
       <xsd:simpleType name="uuid">
         <xsd:restriction base="xsd:string">
           <xsd:pattern value="[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-
                               [0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}" />
         </xsd:restriction>
       </xsd:simpleType>
       <xsd:complexType name="row">
         <xsd:sequence>
           <xsd:element sql:field="CATALOG_NAME" name="CATALOG_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="SCHEMA_NAME" name="SCHEMA_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="CUBE_NAME" name="CUBE_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DIMENSION_UNIQUE_NAME" name="DIMENSION_UNIQUE_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_NAME" name="HIERARCHY_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_UNIQUE_NAME" name="HIERARCHY_UNIQUE_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_GUID" name="HIERARCHY_GUID" 
                            type="uuid" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_CAPTION" name="HIERARCHY_CAPTION" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DIMENSION_TYPE" name="DIMENSION_TYPE" 
                            type="xsd:short" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_CARDINALITY" name="HIERARCHY_CARDINALITY" 
                            type="xsd:unsignedInt" minOccurs="0" />
           <xsd:element sql:field="DEFAULT_MEMBER" name="DEFAULT_MEMBER" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="ALL_MEMBER" name="ALL_MEMBER" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DESCRIPTION" name="DESCRIPTION" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="STRUCTURE" name="STRUCTURE" 
                            type="xsd:short" minOccurs="0" />
           <xsd:element sql:field="IS_VIRTUAL" name="IS_VIRTUAL" 
                            type="xsd:boolean" minOccurs="0" />
           <xsd:element sql:field="IS_READWRITE" name="IS_READWRITE" 
                            type="xsd:boolean" minOccurs="0" />
           <xsd:element sql:field="DIMENSION_UNIQUE_SETTINGS" name="DIMENSION_UNIQUE_SETTINGS" 
                             type="xsd:int" minOccurs="0" />
           <xsd:element sql:field="DIMENSION_MASTER_UNIQUE_NAME" 
                            name="DIMENSION_MASTER_UNIQUE_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DIMENSION_IS_VISIBLE" name="DIMENSION_IS_VISIBLE" 
                            type="xsd:boolean" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_ORDINAL" name="HIERARCHY_ORDINAL" 
                            type="xsd:unsignedInt" minOccurs="0" />
           <xsd:element sql:field="DIMENSION_IS_SHARED" name="DIMENSION_IS_SHARED" 
                            type="xsd:boolean" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_IS_VISIBLE" name="HIERARCHY_IS_VISIBLE" 
                            type="xsd:boolean" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_ORIGIN" name="HIERARCHY_ORIGIN" 
                            type="xsd:unsignedShort" minOccurs="0" />
           <xsd:element sql:field="HIERARCHY_DISPLAY_FOLDER" name="HIERARCHY_DISPLAY_FOLDER" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="INSTANCE_SELECTION" name="INSTANCE_SELECTION" 
                            type="xsd:unsignedShort" minOccurs="0" />
           <xsd:element sql:field="GROUPING_BEHAVIOR" name="GROUPING_BEHAVIOR" 
                            type="xsd:unsignedShort" minOccurs="0" />
           <xsd:element sql:field="STRUCTURE_TYPE" name="STRUCTURE_TYPE" 
                            type="xsd:string" minOccurs="0" />
         </xsd:sequence>
       </xsd:complexType>