HIERARCHIES Rowset
The HIERARCHIES rowset contains information about the hierarchies available in a dimension. If the dimension does not contain a hierarchy or has just one hierarchy, the HIERARCHY_NAME column will contain a NULL and both the HIERARCHY_UNIQUE_NAME and HIERARCHY_CAPTION columns will contain the name of the dimension.
The default sort order is CATALOG_NAME, SCHEMA_NAME, CUBE_NAME, DIMENSION_UNIQUE_NAME, and HIERARCHY_NAME.
The rowset structure is described in the following table.
Column name |
Type indicator |
Description |
---|---|---|
CATALOG_NAME |
DBTYPE_WSTR |
Optional. The name of the catalog to which this hierarchy belongs. NULL if the provider does not support catalogs. |
SCHEMA_NAME |
DBTYPE_WSTR |
Optional. The name of the schema to which this hierarchy belongs. NULL if the provider does not support schemas. |
CUBE_NAME |
DBTYPE_WSTR |
Required. Name of the cube to which this hierarchy belongs. |
DIMENSION_UNIQUE_NAME |
DBTYPE_WSTR |
Required. 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_NAME |
DBTYE_WSTR |
Required. Name of the hierarchy. If the dimension does not contain a hierarchy or has just one hierarchy, this column contains a NULL. |
HIERARCHY_UNIQUE_NAME |
DBTYPE_WSTR |
Required. Unique name of the hierarchy. This must be an unambiguous name. If the dimension does not contain a hierarchy or has just one hierarchy, this column will contain the name of the dimension. For providers that generate unique names by qualification, each component of this name is delimited. |
HIERARCHY_GUID |
DBTYPE_GUID |
Optional. Hierarchy GUID. NULL if there is no GUID. |
HIERARCHY_CAPTION |
DBTYPE_WSTR |
Required. A 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 does not contain a hierarchy or has just one hierarchy, this column will contain the name of the dimension. |
DIMENSION_TYPE |
DBTYPE_I2 |
Required. The type of the dimension to which this hierarchy belongs. Can be one of the following values:
|
HIERARCHY_CARDINALITY |
DBTYPE_UI4 |
Required. The number of members in the hierarchy. Because of the presence of multiple hierarchies, this number might not be the same as DIMENSION_CARDINALITY. This value can be an approximation of the real cardinality. Consumers should not assume that this value is accurate. |
DEFAULT_MEMBER |
DBTYPE_WSTR |
Optional. The default member for this hierarchy. This is a unique name. Every hierarchy must have a default member. |
ALL_MEMBER |
DBTYPE_WSTR |
Optional. The member at the highest level of rollup in the hierarchy. This can be different from DEFAULT_MEMBER. |
DESCRIPTION |
DBTYPE_WSTR |
Optional. A human-readable description of the hierarchy. NULL if no description exists. |
ANNOTATIONS |
DBTYPE_WSTR |
Optional. A string containing annotations added by analysts through their client applications. For more information about this feature, see The ANNOTATIONS Column. |
STRUCTURE |
DBTYPE_I2 |
Required. The type of hierarchy. Can be one of the following values:
|