MDAC 2.5 SDK - OLE DB Programmer's Reference
Chapter 22: OLE DB for OLAP Objects and Schema Rowsets


 

LEVELS Rowset

The LEVELS rowset contains information about the levels available in a dimension.

The default sort order is CATALOG_NAME, SCHEMA_NAME, CUBE_NAME, DIMENSION_UNIQUE_NAME, HIERARCHY_UNIQUE_NAME, and LEVEL_NUMBER.

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 level belongs. NULL if the provider does not support catalogs.
SCHEMA_NAME DBTYPE_WSTR Optional. The name of the schema to which this level belongs. NULL if the provider does not support schemas.
CUBE_NAME DBTYPE_WSTR Required. Name of the cube to which this level belongs.
DIMENSION_UNIQUE_NAME DBTYPE_WSTR Required. Unique name of the dimension to which this level belongs. For providers that generate unique names by qualification, each component of this name is delimited.
HIERARCHY_UNIQUE_NAME DBTYE_WSTR Required. Unique name of the hierarchy. If the level belongs to more than one hierarchy, there is one row for each hierarchy to which it belongs. For providers that generate unique names by qualification, each component of this name is delimited.
LEVEL_NAME DBTYPE_WSTR Required. Name of the level.
LEVEL_UNIQUE_NAME DBTYPE_WSTR Required. Unique name of the level. For providers that generate unique names by qualification, each component of this name is delimited.
LEVEL_GUID DBTYPE_GUID Optional. Level GUID. NULL if the level does not have a GUID.
LEVEL_NUMBER DBTYPE_UI4 Required. The distance of the level from the root of the hierarchy. The root level is zero.
LEVEL_CAPTION DBTYPE_WSTR Required. A label or caption associated with the hierarchy. Used primarily for display purposes. If a caption does not exist, LEVEL_NAME is returned.
LEVEL_CARDINALITY DBTYPE_UI4 Required. The number of members in a level. This value can be an approximation of the real cardinality. Consumers should not assume that this value is accurate.
LEVEL_TYPE DBTYPE_I4 Required. The following bitmasks are used to specify the level characteristics:
  • MDLEVEL_TYPE_REGULAR

  • MDLEVEL_TYPE_ALL

  • MDLEVEL_TYPE_CALCULATED

  • MDLEVEL_TYPE_TIME

  • MDLEVEL_TYPE_TIME_YEARS

  • MDLEVEL_TYPE_TIME_HALF_YEAR

  • MDLEVEL_TYPE_TIME_QUARTERS

  • MDLEVEL_TYPE_TIME_MONTHS

  • MDLEVEL_TYPE_TIME_WEEKS

  • MDLEVEL_TYPE_TIME_DAYS

  • MDLEVEL_TYPE_TIME_HOURS

  • MDLEVEL_TYPE_TIME_MINUTES

  • MDLEVEL_TYPE_TIME_SECONDS

  • MDLEVEL_TYPE_TIME_UNDEFINED

  • MDLEVEL_TYPE_UNKNOWN
DESCRIPTION DBTYPE_WSTR Optional. A human-readable description of the level. NULL if no description exists.

Note   The LEVEL_TYPE column exists mainly as a means to transmit formatting instructions to an application. For example, a level with a type of LEVEL_TYPE_TIME_DAYS might indicate to an application that the members of the level should be expressed in text format (in other words, "Sunday", "Monday", "Tuesday", and so on). LEVEL_TYPE_REGULAR can be used to signify a level that does not require any special formatting.