The HIERARCHIES schema rowset returns metadata that indicates which hierarchies are available on the dimensions that can be accessed by the provider. Each row in the HIERARCHIES schema rowset corresponds to one hierarchy that is available in the provider.
The following table describes the columns available in the HIERARCHIES schema rowset.
Column Name | Type Indicator | Mapped Value | Restrictions Supported? |
---|---|---|---|
CATALOG_NAME | DBTYPE_WSTR | Name of the catalog that contains this hierarchy. | Yes |
SCHEMA_NAME | DBTYPE_WSTR | Name of the schema that contains this hierarchy. | Yes |
CUBE_NAME | DBTYPE_WSTR | Name of the cube that contains this hierarchy. | Yes |
DIMENSION_UNIQUE_NAME | DBTYPE_WSTR | Unique name of the dimension that contains this hierarchy. | Yes |
HIERARCHY_NAME | DBTYPE_WSTR | Name of this hierarchy. NULL if the parent dimension has no hierarchies. | Yes |
HIERARCHY_UNIQUE_NAME | DBTYPE_WSTR | Unique name of this hierarchy. Same as the name of the parent dimension if that dimension has zero or one hierarchy. | Yes |
HIERARCHY_GUID | DBTYPE_GUID | GUID of this hierarchy. | No |
HIERARCHY_CAPTION | DBTYPE_WSTR | The caption of this hierarchy. Same as HIERARCHY_NAME if no caption exists for this hierarchy. | No |
DIMENSION_TYPE | DBTYPE_I2 | The type of the parent dimension of this hierarchy. One of:
|
No |
HIERARCHY_CARDINALITY | DBTYPE_UI4 | The number of members contained by this hierarchy. | No |
DEFAULT_MEMBER | DBTYPE_WSTR | Default member of this hierarchy. | No |
[ALL]_MEMBER | DBTYPE_WSTR | Member at the highest level of rollup in this hierarchy. | No |
DESCRIPTION | DBTYPE_WSTR | Description of this hierarchy. | No |
Restrictions enable an OLE DB consumer to restrict the rows that are returned in a schema rowset by IDBSchemaRowset::GetRowset. A restriction is a value for a specific column. When a restriction is passed to IDBSchemaRowset::GetRowset, all rows that are returned in the schema rowset must match the restriction value on the specified column. Restriction values do not support pattern matching or wildcards. For example, the restriction value D_F matches D_F but not DEF.
Note: For definitions of the type indicators, see "Type Indicators" in Microsoft's OLE DB specification documentation.