The PROPERTIES schema rowset returns metadata about the properties that are available on each level and member that can be accessed by the provider. Each row in the PROPERTIES schema rowset corresponds to one property that is available in the provider.
The following table describes the columns that are available in the PROPERTIES schema rowset.
Column Name | Type Indicator | Mapped Value | Restrictions Supported? |
---|---|---|---|
PROPERTY_TYPE | DBTYPE_I2 | Type of this property, either MDPROP_MEMBER or MDPROP_CELL. | Yes |
CATALOG_NAME | DBTYPE_WSTR | Name of the catalog that contains this property. | Yes |
SCHEMA_NAME | DBTYPE_WSTR | Name of the schema that contains this property. | Yes |
CUBE_NAME | DBTYPE_WSTR | Name of the cube that contains this property. | Yes |
DIMENSION_UNIQUE_NAME | DBTYPE_WSTR | Unique name of the dimension that contains this property. | Yes |
HIERARCHY_UNIQUE_NAME | DBTYPE_WSTR | Unique name of the hierarchy that contains this property. | Yes |
LEVEL_UNIQUE_NAME | DBTYPE_WSTR | Unique name of the level that contains this property. | Yes |
MEMBER_UNIQUE_NAME | DBTYPE_WSTR | Unique name of the member that contains this property. | Yes |
PROPERTY_NAME | DBTYPE_WSTR | Name of this property. | Yes |
PROPERTY_CAPTION | DBTYPE_WSTR | Caption of this property. | No |
DATA_TYPE | DBTYPE_UI2 | Data type of this property. | No |
CHARACTER_MAXIMUM_LENGTH | DBTYPE_UI4 | Maximum length of this property for character, binary, and bit properties if one is defined. The value is 0 for character, binary, and bit properties that do not have a defined maximum length. The value is NULL for all other properties. | No |
CHARACTER_OCTET_LENGTH | DBTYPE_UI4 | Maximum length in octets of this property for character, binary, and bit properties if one is defined. The value is 0 for character, binary, and bit properties that do not have a defined maximum length. The value is NULL for all other properties. | No |
NUMERIC_PRECISION | DBTYPE_UI2 | Maximum numeric precision for numeric properties. NULL for all other properties. | No |
NUMERIC_SCALE | DBTYPE_I2 | Number of digits to the right of the decimal point for numeric properties. NULL for all other properties. | No |
DESCRIPTION | DBTYPE_WSTR | Description of this property. | 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.
An OLE DB consumer can programmatically discover the columns on which the providers support restrictions by calling IDBSchemaRowset::GetSchemas.
Note: For definitions of the type indicators, see "Type Indicators" in Microsoft's OLE DB specification documentation.