PROPERTIES Rowset
The PROPERTIES rowset contains information about the available properties for each level of the dimension, assuming that each level defines a class of members. The properties of all members in this class are the same. For a data store that does not support named levels, a dummy level includes all members in the dimension. The name of this level is the same as the name of the dimension.
The PROPERTIES rowset also contains all available properties for cells in a dataset. Providers are required to have at least three properties (the VALUE, FORMATTED_VALUE, and CELL_ORDINAL properties of a cell); therefore, the PROPERTIES rowset always has at least three rows. Consumers can distinguish between member properties and cell properties by looking at the PROPERTY_TYPE column.
A property can be both a member property and a cell property. By restricting the PROPERTY_TYPE field of this rowset, consumers can retrieve only the member property, only the cell property, or both.
The default sort order is PROPERTY_TYPE, CATALOG_NAME, SCHEMA_NAME, CUBE_NAME, DIMENSION_UNIQUE_NAME, HIERARCHY_UNIQUE_NAME, and LEVEL_UNIQUE_NAME.
Column name |
Type indicator |
Description |
|---|---|---|
PROPERTY_TYPE |
DBTYPE_I2 |
Required. The following bitmasks are used to describe the property type:
|
CATALOG_NAME |
DBTYPE_WSTR |
Optional. The name of the catalog to which this property belongs. NULL if the provider does not support catalogs. |
SCHEMA_NAME |
DBTYPE_WSTR |
Optional. The name of the schema to which this property belongs. NULL if the provider does not support schemas. |
CUBE_NAME |
DBTYPE_WSTR |
Required. Name of the cube to which this property belongs. |
DIMENSION_UNIQUE_NAME |
DBTYPE_WSTR |
Required. Unique name of the dimension. For providers that generate unique names by qualification, each component of this name is delimited. |
HIERARCHY_UNIQUE_NAME |
DBTYPE_WSTR |
Required. Unique name of the hierarchy. For providers that generate unique names by qualification, each component of this name is delimited. |
LEVEL_UNIQUE_NAME |
DBTYPE_WSTR |
Required. Unique name of the level to which this property belongs. If the provider does not support named levels, it should return the DIMENSION_UNIQUE_NAME value for this field. For providers that generate unique names by qualification, each component of this name is delimited. |
MEMBER_UNIQUE_NAME |
DBTYPE_WSTR |
Required. Used for data stores that do not support named levels or have properties on a member-by-member basis. Contains the unique name of the member to which the property belongs. If the property applies to all members in a level, this column is NULL. For providers that generate unique names by qualification, each component of this name is delimited. |
PROPERTY_NAME |
DBTYPE_WSTR |
Required. Name of the property. |
PROPERTY_CAPTION |
DBTYPE_WSTR |
Required. A label or caption associated with the property. Used primarily for display purposes. If a caption does not exist, PROPERTY_NAME is returned. |
DATA_TYPE |
DBTYPE_UI2 |
Required. Data type of the property. Can be any of the types listed in Appendix A: Data Types. |
CHARACTER_MAXIMUM_LENGTH |
DBTYPE_UI4 |
Required. The maximum possible length of a value in this property. For character, binary, and bit properties, it is one of the following:
|
CHARACTER_OCTET_LENGTH |
DBTYPE_UI4 |
Required. Maximum length in octets (bytes) of the property, if the type of the property is either character or binary. A value of 0 means that the property has no defined maximum length. NULL for all other property types. |
NUMERIC_PRECISION |
DBTYPE_UI2 |
Required. If the property object's data is numeric, this is the maximum precision of the property. NULL for all other property types. |
NUMERIC_SCALE |
DBTYPE_I2 |
Required. If the property object's type indicator is DBTYPE_NUMERIC or DBTYPE_DECIMAL, this is the number of digits to the right of the decimal point. Otherwise, this value is NULL. |
DESCRIPTION |
DBTYPE_WSTR |
Optional. A human-readable description of the property. NULL if no description exists. |