TechNet
Export (0) Print
Expand All

MDSCHEMA_HIERARCHIES Rowset

 

Applies To: SQL Server 2016 Preview

Describes each hierarchy within a particular dimension.

The MDSCHEMA_HIERARCHIES rowset contains the following columns.

Column nameType indicatorDescription
CATALOG_NAMEDBTYPE_WSTRThe name of the catalog to which this hierarchy belongs. NULL if the provider does not support catalogs.
SCHEMA_NAMEDBTYPE_WSTRNot supported
CUBE_NAMEDBTYPE_WSTR(Required) The name of the cube to which this hierarchy belongs.
DIMENSION_UNIQUE_NAMEDBTYPE_WSTRThe unique name of the dimension to which this hierarchy belongs. For providers that generate unique names by qualification, each component of this name is delimited.
HIERARCHY_NAMEDBTYPE_WSTRThe name of the hierarchy. Blank if there is only a single hierarchy in the dimension. This will always have a value in Microsoft SQL Server Analysis Services.
HIERARCHY_UNIQUE_NAMEDBTYPE_WSTRThe unique name of the hierarchy.
HIERARCHY_GUIDDBTYPE_GUIDNot supported
HIERARCHY_CAPTIONDBTYPE_WSTRA label or a caption associated with the hierarchy. Used primarily for display purposes. If a caption does not exist, HIERARCHY_NAME is returned. If the dimension either does not contain a hierarchy or has just one hierarchy, this column will contain the name of the dimension.
DIMENSION_TYPEDBTYPE_I2The type of the dimension. Valid values include the following values:

 MD_DIMTYPE_UNKNOWN (0)

 MD_DIMTYPE_TIME (1)

 MD_DIMTYPE_MEASURE (2)

 MD_DIMTYPE_OTHER (3)

 MD_DIMTYPE_QUANTITATIVE (5)

 MD_DIMTYPE_ACCOUNTS (6)

 MD_DIMTYPE_CUSTOMERS (7)

 MD_DIMTYPE_PRODUCTS (8)

 MD_DIMTYPE_SCENARIO (9)

 MD_DIMTYPE_UTILIY (10)

 MD_DIMTYPE_CURRENCY (11)

 MD_DIMTYPE_RATES (12)

 MD_DIMTYPE_CHANNEL (13)

 MD_DIMTYPE_PROMOTION (14)

 MD_DIMTYPE_ORGANIZATION (15)

 MD_DIMTYPE_BILL_OF_MATERIALS (16)

 MD_DIMTYPE_GEOGRAPHY (17)
HIERARCHY_CARDINALITYDBTYPE_UI4The number of members in the hierarchy.
DEFAULT_MEMBERDBTYPE_WSTRThe default member for this hierarchy. This is a unique name. Every hierarchy must have a default member.
ALL_MEMBERDBTYPE_WSTRThe member at the highest level of the rollup.
DESCRIPTIONDBTYPE_WSTRA human-readable description of the hierarchy. NULL if no description exists.
STRUCTUREDBTYPE_I2The structure of the hierarchy. Valid values include the following values:

 MD_STRUCTURE_FULLYBALANCED (0)

 MD_STRUCTURE_RAGGEDBALANCED (1)

 MD_STRUCTURE_UNBALANCED (2)

 MD_STRUCTURE_NETWORK (3)
IS_VIRTUALDBTYPE_BOOLAlways returns False.
IS_READWRITEDBTYPE_BOOLA Boolean that indicates whether the Write Back to dimension column is enabled.

Returns TRUE if the Write Back to dimension column that represents this hierarchy is enabled.
DIMENSION_UNIQUE_SETTINGSDBTYPE_I4Always returns MDDIMENSIONS_MEMBER_KEY_UNIQUE (1).
DIMENSION_MASTER_UNIQUE_NAMEDBTYPE_WSTRAlways returns NULL.
DIMENSION_IS_VISIBLEDBTYPE_BOOLAlways returns true. If the dimension is not visible, it will not appear in the schema rowset.
HIERARCHY_ORDINALDBTYPE_UI4The ordinal number of the hierarchy across all hierarchies of the cube.
DIMENSION_IS_SHAREDDBTYPE_BOOLAlways returns TRUE.
HIERARCHY_IS_VISIBLEDBTYPE_BOOLA Boolean that indicates whether the hieararchy is visible.

Returns TRUE if the hierarchy is visible; otherwise, FALSE.
HIERARCHY_ORIGINDBTYPE_UI2A bit mask that determines the source of the hierarchy:

 MD_USER_DEFINED identifies user defined hierarchies, and has a value of 0x0000001.

 MD_SYSTEM_ENABLED identifies attribute hierarchies, and has a value of 0x0000002.

 MD_SYSTEM_INTERNAL identifies attributes with no attribute hierarchies, and has a value of 0x0000004.

 

Note that a parent/child attribute hierarchy is both MD_USER_DEFINED and MD_SYSTEM_ENABLED.
HIERARCHY_DISPLAY_FOLDERDBTYPE_WSTRThe path to be used when displaying the hierarchy in the user interface. Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\).
INSTANCE_SELECTIONDBTYPE_UI2A hint to the client application on how to show the hierarchy. Valid values include the following values:

 MD_INSTANCE_SELECTION_NONE

 MD_INSTANCE_SELECTION_DROPDOWN

 MD_INSTANCE_SELECTION_LIST

 MD_INSTANCE_SELECTION_FILTEREDLIST

 MD_INSTANCE_SELECTION_MANDATORYFILTER
GROUPING_BEHAVIORDBTYPE_I2An enumeration that specifies the expected grouping behavior of clients for this hierarchy. Possible values are the following:

 EncourageGrouping (1)

 DiscourageGrouping (2)
STRUCTURE_TYPEDBTYPE_WSTRIndicates the type of hierarchy. Valid values include the following values:

 Natural

 Unnatural

 Unknown

The rowset is sorted on CATALOG_NAME, SCHEMA_NAME, CUBE_NAME, DIMENSION_UNIQUE_NAME, HIERARCHY_NAME.

The MDSCHEMA_HIERARCHIES rowset can be restricted on the columns listed in the following table.

Column nameType indicatorRestriction State
CATALOG_NAMEDBTYPE_WSTROptional.
SCHEMA_NAMEDBTYPE_WSTROptional.
CUBE_NAMEDBTYPE_WSTROptional.
DIMENSION_UNIQUE_NAMEDBTYPE_WSTROptional.
HIERARCHY_NAMEDBTYPE_WSTROptional.
HIERARCHY_UNIQUE_NAMEDBTYPE_WSTROptional.
HIERARCHY_ORIGINDBTYPE_UI2(Optional) A default restriction is in effect on MD_USER_DEFINED and MD_SYSTEM_ENABLED.
CUBE_SOURCEDBTYPE_UI2(Optional) Default restriction is a value of 1. A bitmap with one of the following valid values:

1 CUBE

2 DIMENSION
HIERARCHY_VISIBILITYDBTYPE_UI2(Optional) Default restriction is a value of 1. A bitmap with one of the following valid values:

1 Visible

2 Not visible

OLE DB for OLAP Schema Rowsets

Community Additions

ADD
Show:
© 2016 Microsoft